Package name

LTK-PLOTCHART
Nicknames

CHART

1. Package documentation

A wrapper around tklib’s plotchart library to work with LTk / nodgui.

documentation

https://peterlane.codeberg.page/ltk-plotchart/
repository

https://codeberg.org/peterlane/ltk-plotchart/

2. Classes

BAR-CHART
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk bar-chart instance.

Constructor

CREATE-BAR-CHART

BOX-PLOT
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk box-chart instance.

Constructor

CREATE-BOX-PLOT

GANTT-CHART
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk gantt-chart instance.

Constructor

CREATE-GANTT-CHART

HISTOGRAM
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk histogram instance.

Constructor

CREATE-HISTOGRAM

HORIZONTAL-BAR-CHART
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk horizontal-bar-chart instance.

Constructor

CREATE-HORIZONTAL-BAR-CHART

ISOMETRIC-PLOT
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk isometric-plot instance.

Constructor

CREATE-ISOMETRIC-PLOT

LOGX-LOGY-PLOT
Super classes

XY-PLOT-GROUP PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk logx-logy-plot instance.

Constructor

CREATE-LOGX-LOGY-PLOT

LOGX-Y-PLOT
Super classes

XY-PLOT-GROUP PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk logx-y-plot instance.

Constructor

CREATE-LOGX-Y-PLOT

PIE-CHART
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk pie-chart instance.

Constructor

CREATE-PIE-CHART

POLAR-PLOT
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk polar-plot instance.

Constructor

CREATE-POLAR-PLOT

RADIAL-CHART
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk radial-chart instance.

Constructor

CREATE-RADIAL-CHART

RIGHT-AXIS
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk right-axis instance.

Constructor

CREATE-RIGHT-AXIS

SPIRAL-PIE
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk spiral-pie instance.

Constructor

CREATE-SPIRAL-PIE

STATUS-TIMELINE
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk status-timeline instance.

Constructor

CREATE-STATUS-TIMELINE

STRIP-CHART
Super classes

XY-PLOT-GROUP PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk strip-chart instance.

Constructor

CREATE-STRIP-CHART

TABLE-CHART
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk table-chart instance.

Constructor

CREATE-TABLE-CHART

TERNARY-DIAGRAM
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk ternary-diagram instance.

Constructor

CREATE-TERNARY-DIAGRAM

THREED-BAR-CHART
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk threed-bar-chart instance.

Constructor

CREATE-3D-BAR-CHART

THREED-PLOT
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk threed-plot instance.

Constructor

CREATE-3D-PLOT

THREED-RIBBON-PLOT
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk threed-ribbon-plot instance.

Constructor

CREATE-3D-RIBBON-PLOT

TIME-CHART
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk time-chart instance.

Constructor

CREATE-TIME-CHART

TX-PLOT
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk tx-plot instance.

Constructor

CREATE-TX-PLOT

WINDROSE
Super classes

PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk windrose instance.

Constructor

CREATE-WINDROSE

X-LOGY-PLOT
Super classes

XY-PLOT-GROUP PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk x-logy-plot instance.

Constructor

CREATE-X-LOGY-PLOT

XY-PLOT
Super classes

XY-PLOT-GROUP PLOTCHART STANDARD-OBJECT SLOT-OBJECT T

Documentation

Instance holds pointer to tcl/tk xy-plot instance.

Constructor

CREATE-XY-PLOT

3. Functions

ADD-MILESTONE
Lambda list

add-milestone ( chart time-point &optional colour )

Documentation

  • chart - TIME-CHART to add milestone to

  • time-point - at which the milestone must be positioned

  • colour - of the triangle (defaults to black)

Adds another milestone to the current row of a TIME-CHART.

ADD-PERIOD
Lambda list

add-period ( chart time-begin time-end &optional colour )

Documentation

  • chart - TIME-CHART to add period to

  • time-begin - when period starts

  • time-end - when period ends

  • colour - of the triangle (defaults to black)

Adds another new time period to the current row of a GANTT-CHART or TIME-CHART.

ADD-ROW
Lambda list

add-row ( chart items )

Documentation

  • chart - TABLE-CHART to add row to

  • items - list of text items to add, one per column

Adds a row of information to a TABLE-CHART.

BACKGROUND
Lambda list

background ( chart part colour-or-image &optional direction brightness )

Documentation

  • chart - to modify

  • part - one of (:axes :plot :gradient :image)

  • colour-or-image - either a colour name, or an image reference

  • direction - one of (:top-down :bottom-up :left-right :right-left)

  • brightness - one of (:bright :dark)

Sets the background of a part of the plot

BALLOON
Lambda list

balloon ( chart x y text direction )

Documentation

  • chart - to modify

  • x - x-coordinate to point to

  • y - y-coordinate to point to

  • text - to display

  • direction - direction of the arrow, one of (:north :north-east :east :south-east :south :south-west :west :north-west)

Adds balloon text to the plot, with pointer to given coordinates.

Note
 not supported for 3D charts.
BALLOON-CONFIG
Lambda list

balloon-config ( chart &key font justify textcolour textcolor background outline margin rimwidth arrowsize )

Documentation

  • chart - to modify

  • font - name of font

  • justify - one of (:left :center :right)

  • textcolour textcolor - name of text colour

  • background - name of background colour

  • outline - name of outline colour

  • margin - in pixels, margin around text

  • rimwidth - in pixels, width of outline

  • arrowsize - in pixels, arrow length

Configures balloon text for given plot - settings apply to next call to chart-balloon

CELL-CONFIGURE
Lambda list

cell-configure ( chart &key background colour color font anchor justify )

Documentation

  • chart - TABLE-CHART to modify

  • background - colour

  • colour color - colour of text (foreground)

  • font - name of font

  • anchor - how to position text in cell

  • justify - layout of multiline text

Sets properties for displaying cells in subsequent rows.

COLOR
Lambda list

color ( chart parameter-1 parameter-2 )

Documentation

See COLOUR.

COLOR-MAP
Lambda list

color-map ( colours )

Documentation

See COLOUR-MAP.

COLORS
Lambda list

colors ( chart &rest colours )

Documentation

See COLOURS.

COLOUR
Lambda list

colour ( chart parameter-1 parameter-2 )

Documentation

  • chart - to modify

For GANTT-CHART

colour (chart keyword newcolour)

  • keyword - part of chart to change - one of (:description :completed :left :odd :even :summary :summarybar)

  • newcolour - colour for chosen part

Sets colour for a part of gantt chart.

For THREED-PLOT

colour (chart fill-colour border-colour)

  • fill-colour - colour for filling

  • border-colour - colour for border

Sets colour to use for polygon borders and interiors.

COLOUR-MAP
Lambda list

colour-map ( colours )

Documentation

  • colours - a list of colours, or one of pre-defined maps - (:grey :jet :cool :hot)

Sets the colours to use with the contour map methods: list or designator

COLOURS
Lambda list

colours ( chart &rest colours )

Documentation

  • chart - to modify

  • colour-1 colour-2 …​ - the colours to use for the slices/spokes

Sets the colours for the pie slices or radial chart spokes.

Error

if chart type is not PIE-CHART or SPIRAL-PIE.

CONFIG
Lambda list

config ( chart &key show-values value-font value-colour value-format use-background use-ticklines label-font label-colour )

Documentation

  • chart - to modify

  • show-values - T/nil, whether to show the values on top of bar or not

  • value-font - font for showing values

  • value-colour - colour for showing values

Option for BAR-CHART and HORIZONTAL-BAR-CHART:

  • value-format - format string for showing values

Options for THREED-BAR-CHART:

  • use-background - T/nil, whether to show left and back walls

  • use-ticklines - T/nil, whether to show ticklines

  • label-font - font for labels

  • label-colour - colour for labels

Sets configuration parameters for bar charts.

Error

if chart is not one of BAR-CHART, HORIZONTAL-BAR-CHART or THREED-BAR-CHART.

CONNECT
Lambda list

connect ( chart from to )

Documentation

  • chart - GANTT-CHART to modify

  • from - task to connect from

  • to - task to connect to

Connects task from to task to. The tasks are the return value from TASK.

CORNER-TEXT
Lambda list

corner-text ( chart xtext ytext ztext )

Documentation

  • chart - TERNARY-DIAGRAM to modify

  • xtext - text to display in bottom left corner

  • ytext - text to display in bottom right corner

  • ztext - text to display in top center corner

Displays given texts at each corner

CREATE-3D-BAR-CHART
Lambda list

create-3d-bar-chart ( canvas yaxis &key num-bars )

Documentation

  • canvas - parent canvas

  • yaxis - (min max step) axis definition

  • num-bars - number of bars to plot

Returns instance of a THREED-BAR-CHART.

CREATE-3D-PLOT
Lambda list

create-3d-plot ( canvas xaxis yaxis zaxis &key xlabels )

Documentation

  • canvas - parent canvas

  • xaxis - (min, max, step) axis definition

  • yaxis - (min, max, step) axis definition

  • zaxis - (min, max, step) axis definition

  • xlabels - list of labels for the x-axis

Returns a new instance of a THREED-PLOT.

CREATE-3D-RIBBON-PLOT
Lambda list

create-3d-ribbon-plot ( canvas yaxis zaxis )

Documentation

  • canvas - parent canvas

  • yaxis - (min, max, step) axis definition

  • zaxis - (min, max, step) axis definition

Returns a new instance of a THREED-RIBBON-PLOT.

CREATE-BAR-CHART
Lambda list

create-bar-chart ( canvas xlabels yaxis num-series &key xlabel-angle )

Documentation

  • canvas - parent canvas

  • xlabels - list of labels for the x-axis

  • yaxis - (min max step) axis definition

  • num-series - number of series to plot, or :stacked

  • xlabel-angle - angle at which to display x-axis labels

Returns a new instance of a BAR-CHART.

CREATE-BOX-PLOT
Lambda list

create-box-plot ( canvas xdata ydata &key orientation )

Documentation

  • canvas - parent canvas

  • xdata - either a numeric axis (min max step) or a list of labels

  • ydata - either a list of labels or a numeric axis (min max step)

  • orientation - one of (:horizontal :vertical)

When orientation is

  • :horizontal - xdata is a numeric axis and ydata a list of labels

  • :vertical - xdata is a list of labels and ydata a numeric axis.

Returns a new instance of a BOX-PLOT.

Error

if xdata/ydata are not one axis and one list.

CREATE-GANTT-CHART
Lambda list

create-gantt-chart ( canvas time-begin time-end &key num-items max-width bar-height ylabel-width )

Documentation

  • canvas - parent canvas

  • time-begin - clock scan format - see manual

  • time-end - clock scan format - see manual

  • num-items - expected/maximum number of items (for spacing)

  • max-width - expected/maximum width of descriptive text (defaults to 20)

  • bar-height - in pixels, alternative way to specify spacing

  • ylabel-width - in pixels, space for y labels

Returns a new instance of a GANTT-CHART.

CREATE-HISTOGRAM
Lambda list

create-histogram ( canvas xaxis yaxis &key xlabels ylabels box axesbox )

Documentation

  • canvas - parent canvas

  • xaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • yaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • xlabels - custom labels for the x-axis

  • ylabels - custom labels for the y-axis

  • box - used with plot-pack - see manual

  • axesbox - used with plot-pack - see manual

Returns a new instance of a HISTOGRAM.

CREATE-HORIZONTAL-BAR-CHART
Lambda list

create-horizontal-bar-chart ( canvas xaxis ylabels num-series )

Documentation

  • canvas - parent canvas

  • xaxis - (min max step) axis definition

  • ylabels - list of labels for the y-axis

  • num-series - number of series to plot, or :stacked

Returns instance of a HORIZONTAL-BAR-CHART.

CREATE-ISOMETRIC-PLOT
Lambda list

create-isometric-plot ( canvas xaxis yaxis stepsize )

Documentation

  • canvas - parent canvas

  • xaxis - (min max) axis definition

  • yaxis - (min max) axis definition

  • stepsize - either stepsize for the axes or :noaxes to not display the axes

Returns a new instance of an ISOMETRIC-PLOT.

CREATE-LOGX-LOGY-PLOT
Lambda list

create-logx-logy-plot ( canvas xaxis yaxis &key xlabels ylabels box axesbox timeformat gmt axesatzero isometric )

Documentation

  • canvas - parent canvas

  • xaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • yaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • xlabels - custom labels for the x-axis

  • ylabels - custom labels for the y-axis

  • box - used with plot-pack - see manual

  • axesbox - used with plot-pack - see manual

  • timeformat - designed for strip-charts - see manual

  • gmt - designed for strip-charts - see manual

  • axesatzero - T/nil to draw axes at (0,0) or in bottom-left corner

  • isometric - T/nil to rescale axes so a square appears as a square

Returns a new instance of a LOGX-LOGY-PLOT.

CREATE-LOGX-Y-PLOT
Lambda list

create-logx-y-plot ( canvas xaxis yaxis &key xlabels ylabels box axesbox timeformat gmt axesatzero isometric )

Documentation

  • canvas - parent canvas

  • xaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • yaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • xlabels - custom labels for the x-axis

  • ylabels - custom labels for the y-axis

  • box - used with plot-pack - see manual

  • axesbox - used with plot-pack - see manual

  • timeformat - designed for strip-charts - see manual

  • gmt - designed for strip-charts - see manual

  • axesatzero - T/nil to draw axes at (0,0) or in bottom-left corner

  • isometric - T/nil to rescale axes so a square appears as a square

Returns a new instance of a LOGX-Y-PLOT.

CREATE-PIE-CHART
Lambda list

create-pie-chart ( canvas )

Documentation

  • canvas - parent canvas

Returns a new instance of a PIE-CHART.

CREATE-POLAR-PLOT
Lambda list

create-polar-plot ( canvas radius-data &key xlabels ylabels box axesbox axesatzero isometric )

Documentation

  • canvas - parent canvas

  • radius-data - (max-radius, step-size) definition for radial axis

  • xlabels - custom labels for the x-axis

  • ylabels - custom labels for the y-axis

  • box - used with plot-pack - see manual

  • axesbox - used with plot-pack - see manual

  • axesatzero - T/nil to draw axes at (0,0) or in bottom-left corner

  • isometric - T/nil to rescale axes so a square appears as a square

Returns a new instance of POLAR-PLOT.

CREATE-RADIAL-CHART
Lambda list

create-radial-chart ( canvas names scale &key style )

Documentation

  • canvas - parent canvas

  • names - list of names for the spokes

  • scale - determines position of data on spokes

  • style - one of (:lines :cumulative :filled)

Returns a new instance of a RADIAL-CHART.

CREATE-RIGHT-AXIS
Lambda list

create-right-axis ( canvas yaxis )

Documentation

  • canvas - parent canvas

  • yaxis - (min max step) axis definition

Returns a new instance of a RIGHT-AXIS.

CREATE-SPIRAL-PIE
Lambda list

create-spiral-pie ( canvas )

Documentation

  • canvas - parent canvas

Returns a new instance of a SPIRAL-PIE.

CREATE-STATUS-TIMELINE
Lambda list

create-status-timeline ( canvas xaxis ylabels &key box axesbox showxaxis )

Documentation

  • canvas - parent canvas

  • xaxis - (min, max, step) axis definition

  • ylabels - list of labels for the y-axis

  • box - used with plot-pack - see manual

  • axesbox - used with plot-pack - see manual

  • showxaxis - T/nil, to display xaxis

Returns a new instance of STATUS-TIMELINE.

CREATE-STRIP-CHART
Lambda list

create-strip-chart ( canvas xaxis yaxis &key xlabels ylabels box axesbox timeformat gmt axesatzero isometric )

Documentation

  • canvas - parent canvas

  • xaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • yaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • xlabels - custom labels for the x-axis

  • ylabels - custom labels for the y-axis

  • box - used with plot-pack - see manual

  • axesbox - used with plot-pack - see manual

  • timeformat - designed for strip-charts - see manual

  • gmt - designed for strip-charts - see manual

  • axesatzero - T/nil to draw axes at (0,0) or in bottom-left corner

  • isometric - T/nil to rescale axes so a square appears as a square

Returns a new instance of a STRIP-CHART.

CREATE-TABLE-CHART
Lambda list

create-table-chart ( canvas columns &key widths )

Documentation

  • canvas - parent canvas

  • columns - list of strings for the column headings

  • widths - either a column-wise list or single value

Returns a new instance of a TABLE-CHART.

CREATE-TERNARY-DIAGRAM
Lambda list

create-ternary-diagram ( canvas &key box axesbox fractions steps )

Documentation

  • canvas - parent canvas

  • box - used with plot-pack - see manual

  • axesbox - used with plot-pack - see manual

  • fractions - T/nil to display 0/1 instead of 0/100%

  • steps - number of labels to use on each side

Returns a new instance of a TERNARY-DIAGRAM.

CREATE-TIME-CHART
Lambda list

create-time-chart ( canvas time-begin time-end &key num-items bar-height ylabel-width )

Documentation

  • canvas - parent canvas

  • time-begin - clock scan format - see manual

  • time-end - clock scan format - see manual

  • num-items - expected/maximum number of items (for spacing)

  • bar-height - in pixels, alternative way to specify spacing

  • ylabel-width - in pixels, space for y labels

Returns a new instance of a TIME-CHART.

CREATE-TX-PLOT
Lambda list

create-tx-plot ( canvas timeaxis xaxis &key box axesbox timeformat gmt axesatzero isometric )

Documentation

  • canvas - parent canvas

  • timeaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • xaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • box - used with plot-pack - see manual

  • axesbox - used with plot-pack - see manual

  • timeformat - designed for strip-charts - see manual

  • gmt - designed for strip-charts - see manual

  • axesatzero - T/nil to draw axes at (0,0) or in bottom-left corner

  • isometric - T/nil to rescale axes so a square appears as a square

Returns a new instance of a TX-PLOT.

CREATE-WINDROSE
Lambda list

create-windrose ( canvas radius-data &key num-sectors )

Documentation

  • canvas - parent canvas

  • radius-data - (min, max) radius definition

  • num-sectors - number of sectors to be plotted

Returns a new instance of a WINDROSE.

CREATE-X-LOGY-PLOT
Lambda list

create-x-logy-plot ( canvas xaxis yaxis &key xlabels ylabels box axesbox timeformat gmt axesatzero isometric )

Documentation

  • canvas - parent canvas

  • xaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • yaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • xlabels - custom labels for the x-axis

  • ylabels - custom labels for the y-axis

  • box - used with plot-pack - see manual

  • axesbox - used with plot-pack - see manual

  • timeformat - designed for strip-charts - see manual

  • gmt - designed for strip-charts - see manual

  • axesatzero - T/nil to draw axes at (0,0) or in bottom-left corner

  • isometric - T/nil to rescale axes so a square appears as a square

Returns a new instance of an X-LOGY-PLOT.

CREATE-XY-PLOT
Lambda list

create-xy-plot ( canvas xaxis yaxis &key xlabels ylabels box axesbox timeformat gmt axesatzero isometric )

Documentation

  • canvas - parent canvas

  • xaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • yaxis - (min, max, step) axis definition or (max, min, -step) for inverted axis

  • xlabels - custom labels for the x-axis

  • ylabels - custom labels for the y-axis

  • box - used with plot-pack - see manual

  • axesbox - used with plot-pack - see manual

  • timeformat - designed for strip-charts - see manual

  • gmt - designed for strip-charts - see manual

  • axesatzero - T/nil to draw axes at (0,0) or in bottom-left corner

  • isometric - T/nil to rescale axes so a square appears as a square

Returns a new instance of an XY-PLOT.

DATA-CONFIG
Lambda list

data-config ( chart series &key colour color type symbol radius width filled fillcolour style smooth boxwidth whiskers whiskerwidth mediancolour medianwidth )

Documentation

Sets the configuration for drawing of data in a given series, for specified chart types.

  • chart - to modify

  • series - to configure

Options for BOX-PLOT:

  • boxwidth - width (or height) of the box

  • whiskers - one of (:extremes :iqr :none) for how to draw whiskers

  • whiskerwidth - line thickness

  • mediancolour - colour of median line

  • medianwidth - thickness of median line

Options for HISTOGRAM POLAR-PLOT RIGHT-AXIS STRIP-CHART TERNARY-DIAGRAM TX-PLOT XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT:

  • colour color - colour of data series

  • type - drawing mode, one of (:line :symbol :both)

  • symbol - when used, one of (:plus :cross :circle :up (triangle pointing up) :down (triangle pointing down) :dot (filled circle) :upfilled :downfilled)

  • radius - of symbol

  • width - of line

  • filled - whether to fill area above/below line, one of (:no :up :down)

  • fillcolour - colour to use in filling area

Options for HISTOGRAM also include:

  • style - for drawing histogram - one of (:filled :spike :plateau :stair)

Options for TERNARY-DIAGRAM also include:

  • smooth - T/nil to use rounded corners

    Error

    if chart type is not recognised.

DOT-CONFIG
Lambda list

dot-config ( chart series &key colour color scale radius scalebyvalue outline classes effect-3d )

Documentation

  • chart - to modify

  • colour color - colour of dot

  • scale - scale factor for radius→pixels conversion

  • radius - of dot

  • scalebyvalue - t/nil to turn scale by value on (default) or off

  • outline - t/nil to display outline of dot

  • classes - flat pairs of limits and colours (e.g. '(0 :green 2 :red 3 :blue))

  • effect-3d - t/nil to turn 3d effect on or off (default)

Sets the configuration options for drawing dots on plots.

Error

if chart type is not one of POLAR-PLOT STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

DRAW-BOX-AND-WHISKERS
Lambda list

draw-box-and-whiskers ( chart series xcrd ycrd )

Documentation

  • chart - to modify

  • series - name of series the data belong to

  • xcrd - x-coordinate of box or list of values

  • ycrd - y-coordinate of box or list of values

Draw a box and whiskers in the plot. One of xcrd or ycrd should be a list, from which the box and whiskers are computed, the other is the point on its axis at which to draw the box.

Error
DRAW-CIRCLE
Lambda list

draw-circle ( chart xc yc radius &optional colour )

Documentation

  • chart - ISOMETRIC-PLOT to modify

  • xc - float, x-coordinate of circle centre

  • yc - float, y-coordinate of circle centre

  • radius - float, radius of circle

  • colour - for outline

Draw the outline of specified circle on an isometric-plot.

DRAW-CONTOUR-FILL
Lambda list

draw-contour-fill ( chart xcrds ycrds values &optional classes )

Documentation

  • chart - to modify

  • xcrds - list of lists, each an x-coordinate of grid cell

  • ycrds - list of lists, each a y-coordinate of grid cell

  • values - list of lists, value at (x, y) grid cell

  • classes - list of class values

Draws filled contours for the given values on the grid.

Error

if chart type is not one of STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

DRAW-CONTOUR-LINES
Lambda list

draw-contour-lines ( chart xcrds ycrds values &optional classes )

Documentation

  • chart - to modify

  • xcrds - list of lists, each an x-coordinate of grid cell

  • ycrds - list of lists, each a y-coordinate of grid cell

  • values - list of lists, value at (x, y) grid cell

  • classes - list of class values

Draws contour lines for the given values on the grid.

Error

if chart type is not one of STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

DRAW-CONTOUR-LINES-FUNCTION-VALUES
Lambda list

draw-contour-lines-function-values ( chart xvec yvec valuesmat &optional classes )

Documentation

  • chart - to modify

  • xvce - list of x-coordinates in increasing order

  • yvec - list of y-coordinates in increasing order

  • valuesmat - list of lists, value at (x, y) grid cell

  • classes - list of class values

Draws contour lines for the given values on the grid.

Error

if chart type is not one of STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

DRAW-DOT
Lambda list

draw-dot ( chart series xcrd ycrd value )

Documentation

  • chart - to modify

  • series - which dot belongs to

  • xcrd - float, x-coordinate

  • ycrd - float, y-coordinate

  • value - float, value determining size and colour

Draws a dot in the given chart.

Error

if chart type is not one of POLAR-PLOT STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

DRAW-FILLED-CIRCLE
Lambda list

draw-filled-circle ( chart xc yc radius &optional colour )

Documentation

  • chart - ISOMETRIC-PLOT to modify

  • xc - float, x-coordinate of circle centre

  • yc - float, y-coordinate of circle centre

  • radius - float, radius of circle

  • colour - for outline

Draw and fill specified circle on an isometric-plot.

DRAW-FILLED-POLYGON
Lambda list

draw-filled-polygon ( chart series coords )

Documentation

  • canvas - TERNARY-DIAGRAM to modify

  • series - name of data series

  • coords - list of triples of coordinates

Draws a filled polygon defined by series of coordinates (triplets).

DRAW-FILLED-RECTANGLE
Lambda list

draw-filled-rectangle ( chart x1 y1 x2 y2 &optional colour )

Documentation

  • chart - ISOMETRIC-PLOT to modify

  • x1 - float, min x-coordinate of rectangle

  • y2 - float, min y-coordinate of rectangle

  • x1 - float, max x-coordinate of rectangle

  • y2 - float, max y-coordinate of rectangle

  • colour - for outline

Draw and fill specified rectangle on an isometric-plot.

DRAW-GRID
Lambda list

draw-grid ( chart xcrds ycrds )

Documentation

  • chart - to modify

  • xcrds - list of lists, each an x-coordinate of grid cell

  • ycrds - list of lists, each a y-coordinate of grid cell

Draws grid cells as lines connecting the given coordinates.

Error

if chart type is not one of STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

DRAW-INTERVAL
Lambda list

draw-interval ( chart series x-coord ymin ymax &optional ycenter )

Documentation

  • chart - to modify

  • series - name of data series

  • x-coord - float, x-coordinate - or time-coordinate, for TX-PLOT

  • ymin - float, minimum y-value

  • ymax - float, maximum y-value

  • ycenter - if given, a symbol is drawn in centre

Adds a vertical error interval to chart.

Error

if chart type is not one of STRIP-CHART TX-PLOT XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

DRAW-LABEL-DOT
Lambda list

draw-label-dot ( chart x y text &optional orientation )

Documentation

  • chart - to modify

  • x - float, x-coordinate of dot

  • y - float, y-coordinate of dot

  • text - to display as label

  • orientation - position of label relative to dot - one of (:n :s :e :w)

Draws a label and dot in the given chart: configure using DATA-CONFIG with 'labeldot' as series name.

Error

if chart type is not one of POLAR-PLOT STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

DRAW-LINE
Lambda list

draw-line ( chart series coords )

Documentation

  • canvas - TERNARY-DIAGRAM to modify

  • series - name of data series

  • coords - list of triples of coordinates

Draws a continuous line defined by series of coordinates (triplets).

DRAW-MINMAX
Lambda list

draw-minmax ( chart series xcoord ymin ymax )

Documentation

  • chart - to modify

  • series - which dot belongs to

  • xcoord - float, x-coordinate

  • ymin - float, minimum y-coordinate

  • ymax - float, maximum y-coordinate

Draws a filled strip in the given chart.

Error

if chart type is not one of POLAR-PLOT STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

DRAW-RECTANGLE
Lambda list

draw-rectangle ( chart x1 y1 x2 y2 &optional colour )

Documentation

  • chart - ISOMETRIC-PLOT to modify

  • x1 - float, min x-coordinate of rectangle

  • y2 - float, min y-coordinate of rectangle

  • x1 - float, max x-coordinate of rectangle

  • y2 - float, max y-coordinate of rectangle

  • colour - for outline

Draw the outline of specified rectangle on an isometric-plot.

DRAW-REGION
Lambda list

draw-region ( chart series xlist ylist )

Documentation

  • chart - to modify

  • series - which polygon belongs to

  • xlist - floats, x-coordinates of points

  • ylist - floats, y-coordinates of points

Draws a filled polygon on the given chart.

Error

if chart type is not one of POLAR-PLOT STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

DRAW-TICKLINES
Lambda list

draw-ticklines ( chart &optional colour )

Documentation

Turns on the ticklines, with optional colour.

DRAW-TRENDLINE
Lambda list

draw-trendline ( chart series x-coord y-coord )

Documentation

  • chart - to modify

  • series - which data belong to

  • x-coord - float, x-coordinate

  • y-coord - float, y-coordinate

Draws a trend line on xy-style plots.

Error

if chart type is not one of STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

DRAW-VECTOR
Lambda list

draw-vector ( chart series x-coord y-coord ucmp vcmp )

Documentation

  • chart - to modify

  • series - which data belong to

  • x-coord - float, x-coordinate of arrow

  • y-coord - float, y-coordinate of arrow

  • ucmp - x-component / length of vector

  • vcmp - y-component / angle of vector

Draws a vector (line with arrow) on xy-style plots.

Error

if chart type is not one of STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

DRAW-VERTICAL-LINE
Lambda list

draw-vertical-line ( chart text time-point &key color colour dash fill width )

Documentation

Options for STATUS-TIMELINE only:

  • dash - dash pattern for line, one of (:lines :dots1 :dots2 :dots3 :dots4 :dots5)

  • fill - fill pattern for line

  • width - of line

Adds a vertical line to a chart.

Error

if chart type not recognised.

DRAW-X-BAND
Lambda list

draw-x-band ( chart ymin ymax )

Documentation

  • chart - to modify

  • ymin - float, lower bound

  • ymax - float, upper bound

Draws a horizontal light-grey band.

DRAW-Y-BAND
Lambda list

draw-y-band ( chart xmin xmax )

Documentation

  • chart - to modify

  • ymin - float, lower bound

  • ymax - float, upper bound

Draws a vertical light-grey band.

EXPLODE
Lambda list

explode ( chart segment )

Documentation

  • chart - PIE-CHART to modify

  • segment - an integer index for the slice to draw outside the main circle

Displays segment number out of the circle.

FONT
Lambda list

font ( chart keyword newfont )

Documentation

  • chart - GANTT-CHART to modify

  • keyword - part of chart to change - one of (:description :summary :scale)

  • newfont - name of font

Changes font of part of gantt chart.

GRIDSIZE
Lambda list

gridsize ( chart nxcells nycells )

Documentation

  • chart - THREED-PLOT to modify

  • nxcells - integer > 0 of number of grid cells in x-direction

  • nycells - integer > 0 of number of grid cells in y-direction

Sets grid size in two dimensions.

HORIZONTAL-SCROLLBAR
Lambda list

horizontal-scrollbar ( chart hscroll )

Documentation

Connect a horizontal scrollbar to chart.

INTERPOLATE-DATA
Lambda list

interpolate-data ( chart data contours )

Documentation

  • chart - THREED-PLOT to modify

  • data - list of lists: list of rows of x-values

  • contours - list of values in ascending order defining countour boundaries

Plots given list-of-lists data with interpolated contours.

LEGEND
Lambda list

legend ( chart series text &optional spacing )

Documentation

  • chart - to modify

  • series - name of data series

  • text - string to display

  • spacing - integer, vertical spacing

Adds an entry to the chart legend

LEGEND-CONFIG
Lambda list

legend-config ( chart &key background border canvas font legend-type position spacing )

Documentation

  • chart - to modify

  • background - name of background colour

  • border - name of border colour

  • canvas - reference to canvas

  • font - name of font

  • legend-type - one of (:rectangle :line)

  • position - one of (:top-left :top-right :bottom-left :bottom-right)

  • spacing - integer, vertical spacing

Configures the chart legend

LEGEND-ISOMETRIC-LINES
Lambda list

legend-isometric-lines ( chart values classes )

Documentation

  • chart - to modify

  • values - list of lists, value at (x, y) grid cell as used in drawing

  • classes - list of class values as used in drawing

Adds contour classes to the legend as coloured lines.

Error

if chart type is not one of STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

LEGEND-REMOVE
Lambda list

legend-remove ( chart series )

Documentation

  • chart - to modify

  • series - name of data series

Removes series from legend and redraws it

LEGEND-SHADES
Lambda list

legend-shades ( chart values classes )

Documentation

  • chart - to modify

  • values - list of lists, value at (x, y) grid cell as used in drawing

  • classes - list of class values as used in drawing

Adds contour classes to the legend as coloured rectangles.

Error

if chart type is not one of STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

MILESTONE
Lambda list

milestone ( chart text time &optional colour )

Documentation

  • chart - GANTT-CHART or TIME-CHART to add milestone to

  • time-point - at which the milestone must be positioned

  • colour - of the triangle (defaults to black)

Adds a milestone to the current row of a GANTT-CHART or TIME-CHART.

PERIOD
Lambda list

period ( chart text time-begin time-end &optional colour )

Documentation

  • chart - GANTT-CHART or TIME-CHART to add period to

  • time-begin - when period starts

  • time-end - when period ends

  • colour - of the triangle (defaults to black)

Adds a new time period to the current row of a GANTT-CHART or TIME-CHART.

PLAINTEXT
Lambda list

plaintext ( chart x y text &optional direction )

Documentation

  • chart - to modify

  • x - x-coordinate

  • y - y-coordinate

  • text - string to display

  • direction - one of (:north :north-east :east :south-east :south :south-west :west :north-west)

Adds plaintext to the plot, at given coordinates.

Note
 not supported for 3D charts.
PLAINTEXT-CONFIG
Lambda list

plaintext-config ( chart &key font justify text-colour text-color )

Documentation

  • chart - to modify

  • font - name of font

  • justify - one of (:left :center :right)

  • textcolour textcolor - name of text colour

Configures plaintext for given plot - settings apply to next call to chart-balloon.

PLOT
Lambda list

plot ( chart &rest args )

Documentation

Generic call to plot function, with arguments varying based on chart type:

BAR-CHART or HORIZONTAL-BAR-CHART

plot (chart series data colour &optional direction brightness)

  • chart - to modify

  • series - name of series the data belong to

  • data - values of series, one per label

  • colour - colour of the bars

  • direction - one of (:uniform :left-right :right-left) for colour change

  • brightness - one of (:bright :dark)

BOX-PLOT

plot (chart series label values)

  • chart - to modify

  • series - name of data series

  • label - label along x or y axis that data belong to

  • values - list of values from which box-and-whiskers data are extracted

HISTOGRAM

plot (chart series x-coord y-coord)

  • chart - to modify

  • series - name of series the data belong to

  • x-coord - x coordinate of bar - defines the right edge

  • y-coord - y coordinate, or height, of bar

PIE-CHART or SPIRAL-PIE

plot (chart data)

  • chart - to modify

  • data - list of (label value) pairs, defining each slice in the pie chart. The value is used to control the angle of the pie slice in a PIE-CHART or radius of the slice in a SPIRAL-PIE.

POLAR-PLOT RIGHT-AXIS STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

plot (chart series x-coord y-coord)

  • chart - to modify

  • series - name of series the data belong to

  • x-coord - float, x-coordinate of point to plot

  • y-coord - float, y-coordinate of point to plot

RADIAL-CHART

plot (chart data colour &optional thickness)

  • chart - to modify

  • data - list of values, one per spoke

  • colour - for this set of data

  • thickness - for width of line

STATUS-TIMELINE

plot (chart series start stop &optional colour)

  • chart - to modify

  • series - name of series the data belong to

  • start - float, start time (x-coordinate)

  • stop - float, end time (x-coordinate)

  • colour - colour of bar

Draws a bar from start to stop points.

TERNARY-DIAGRAM

plot (chart series xcrd ycrd zcrd text &optional direction)

  • chart - to modify

  • series - name of data series

  • xcrd - x coordinate

  • ycrd - y coordinate

  • zcrd - z coordinate

  • text - text to display

  • direction - one of (:n :s :e :w :ne :nw :se :sw) - placement of text relative to point

THREED-BAR-CHART

plot (chart label yvalue colour)

  • chart - to modify

  • label - shown below bar

  • yvalue - height of bar

  • colour - colour of the bar

THREED-RIBBON-PLOT

plot (chart yzpairs)

  • chart - to modify

  • yzpairs - list of pairs of (y, z) coordinates

TX-PLOT

plot (chart series time-coord x-coord)

  • chart - to modify

  • series - name of data series

  • time-coord - time coordinate for value

  • x-coord - x-coord for value

Plots a point at (time-coord, x-coord) on chart.

WINDROSE

plot (chart data colour)

  • chart - to modify

  • data - list of data values, defining distance from centre

  • colour - name of the bar colour

Error

if chart type not recognised.

PLOT-CONFIG
Lambda list

plot-config ( charttype component property value )

Documentation

  • charttype - identifier for type of chart

  • component - component of chart to configure - one of (:leftaxis :rightaxis :background :margin) etc.

  • property - of component

  • value - to set for property

Sets a new value for given charttype-component-property.

Details on the components and properties can be found in the tk documentation for plotconfig and plotstyle.

PLOT-CUMULATIVE
Lambda list

plot-cumulative ( chart series x-coord y-coord )

Documentation

  • chart - HISTOGRAM to modify

  • series - name of series the data belong to

  • x-coord - x coordinate of bar - defines the right edge

  • y-coord - y coordinate, or height, of bar

Adds a data point to the HISTOGRAM, accumulating previous points.

PLOT-DATA
Lambda list

plot-data ( chart data )

Documentation

  • chart - THREED-PLOT to modify

  • data - list of lists: list of rows of x-values

Plots given data.

PLOT-ERASE
Lambda list

plot-erase ( chart )

Documentation

  • chart - to erase

Erases given chart and all associated resources.

PLOT-LIST
Lambda list

plot-list ( chart series xlist ylist &optional every )

Documentation

  • chart - to modify

  • series - name of data series

  • xlist - list of x-coordinates

  • ylist - list of y-coordinates

  • every - t/nil to indicate how often symbol should be drawn

Draws a series of data as a whole.

Error

if chart type is not one of STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

PLOT-PACK
Lambda list

plot-pack ( canvas direction &rest charts )

Documentation

  • canvas - to place the charts onto

  • direction - one of (:top :left :bottom :right)

  • charts - one or more charts to place

Copies contents of the given charts onto one canvas.

RCHART
Lambda list

rchart ( chart series xcoord ycoord )

Documentation

  • canvas - to modify

  • series - name of data series

  • xcoord - float, x-coordinate of point to plot

  • ycoord - float, y-coordinate of point to plot

Using rchart instead of plot shows +/- 1 s.d. line around data.

Error

if chart type is not one of STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

RIBBON
Lambda list

ribbon ( chart yzpairs )

Documentation

  • chart - THREED-PLOT to modify

  • yzpairs - list of pairs of (y, z) coordinates

Plots a ribbon based on given yz-pairs.

SAVE-PLOT
Lambda list

save-plot ( chart filename &key plotregion )

Documentation

  • chart - to use

  • filename - name of file to save to (postscript only supported)

  • plotregion - one of (:bbox :window)

Saves the chart to a postscript file.

SEPARATOR
Lambda list

separator ( chart )

Documentation

Adds a separating line to table chart.

SUBTITLE
Lambda list

subtitle ( chart title )

Documentation

  • chart - to modify

  • title - string to display

Sets the chart subtitle.

SUMMARY
Lambda list

summary ( chart text &rest args )

Documentation

  • chart - GANTT-CHART to modify

  • text - text summarising the tasks

  • args - one or more tasks, as returned from TASK

Adds summary text covering given tasks.

TASK
Lambda list

task ( chart text time-begin time-end completed )

Documentation

  • chart - GANTT-CHART to modify

  • text - summary to display on left-side of chart

  • time-begin - the start time

  • time-end - the end time

  • completed - percentage of task completed, integer from 0 to 100

Adds a task with its time period and level of completion to the chart. Returns a task-name (Tcl variable name) which can be passed to CONNECT or <<summary-function.

TITLE-TEXT
Lambda list

title-text ( chart title &optional placement )

Documentation

  • chart - to modify

  • title - text of title

  • placement - position of title - one of (:center :left :right)

Sets title of the whole chart.

V-SUBTEXT
Lambda list

v-subtext ( chart text )

Documentation

  • chart - to modify

  • text - string to display

Sets the subtext of the (vertical) y-axis, and displays vertically along axis.

V-TEXT
Lambda list

v-text ( chart text )

Documentation

  • chart - to modify

  • text - text to draw on axis

Sets title of the (vertical) y-axis, and draws it vertically.

VECTOR-CONFIG
Lambda list

vector-config ( chart series &key colour color scale centred type centered )

Documentation

  • chart - to modify

  • series - name of data series

  • colour color - colour of arrow

  • scale - scale factor to convert arrow size to pixels

  • centred - t/nil to indicate if coordinates refer to arrow start or centre

  • type - interpretation of coordinates - one of (:cartesian :polar :nautical)

Configuration options for drawing vectors on xy-plots.

Error

if chart type is not one of STRIP-CHART XY-PLOT X-LOGY-PLOT LOGX-Y-PLOT LOGX-LOGY-PLOT

VERTICAL-SCROLLBAR
Lambda list

vertical-scrollbar ( chart vscroll )

Documentation

Connect a vertical scrollbar to chart.

X-CONFIG
Lambda list

x-config ( chart &key format tick-length tick-lines minor-ticks label-offset scale )

Documentation

  • chart - to modify

  • format - tcl format string for numbers, see manual

  • tick-length - in pixels, length of tick marks

  • tick-lines - t/nil, whether to draw tick lines

  • minor-ticks - number of minor tickmarks

  • label-offset - in pixels, space between label and tickmark

  • scale - (min max step) axis-definition

Configure options for x-axis.

X-SUBTEXT
Lambda list

x-subtext ( chart text )

Documentation

  • chart - to modify

  • text - string to display

Sets the subtext of the (horizontal) x-axis.

X-TEXT
Lambda list

x-text ( chart text )

Documentation

  • chart - to modify

  • text - text to draw on axis

Sets title of the (horizontal) x-axis

X-TICKLINES
Lambda list

x-ticklines ( chart &optional colour dash )

Documentation

  • chart - to modify

  • colour - colour of the lines (defaults to black)

  • dash - dash pattern for lines, one of (:lines :dots1 :dots2 :dots3 :dots4 :dots5)

Draw vertical ticklines at each tick location

Y-CONFIG
Lambda list

y-config ( chart &key format tick-length tick-lines minor-ticks label-offset scale )

Documentation

  • chart - to modify

  • format - tcl format string for numbers, see manual

  • tick-length - in pixels, length of tick marks

  • tick-lines - t/nil, whether to draw tick lines

  • minor-ticks - number of minor tickmarks

  • label-offset - in pixels, space between label and tickmark

  • scale - (min max step) axis-definition

Configure options for y-axis.

Y-SUBTEXT
Lambda list

y-subtext ( chart text )

Documentation

  • chart - to modify

  • text - string to display

Sets the subtext of the (vertical) y-axis.

Y-TEXT
Lambda list

y-text ( chart text )

Documentation

  • chart - to modify

  • text - text to draw on axis

Sets title of the (vertical) y-axis

Y-TICKLINES
Lambda list

y-ticklines ( chart &optional colour dash )

Documentation

  • chart - to modify

  • colour - colour of the lines (defaults to black)

  • dash - dash pattern for lines, one of (:lines :dots1 :dots2 :dots3 :dots4 :dots5)

Draw horizontal ticklines at each tick location