Chart Plug-in Scripting Reference

Overview

The chart implements bar, area, line, pie, scatter, and cylinder charts for single or multiple datasets.

The charts can be interactively hit tested, and the appearance and colors can be controlled.

Charts include numeric units for X and Y data, and a labeled legend if desired.

Messages: nodemove, nodechange, nodeselect

Nodemove is sent when the position of the chart changes.

Nodechange is sent when the items in the chart are inserted or deleted.

Nodeselect is sent when the selected item changes.

 

Commands and Functions

addcolors

addcolors(node name $)

Automatically add colors to the chart.

alignget, alignset

legend align # = alignget(node name $)
alignset(node name $, legend align #)

Get or set the alignment of the chart legend.

Values are -1 to 1 for top, middle, and bottom.

axisdecimalget, axisdecimalset

axis decimals # = axisdecimalget(node name $)
axisdecimalset(node name $, axis decimals #)

Set the number of decimal places for numbers on the axis.
See: axisformatxset, axisformatxget, axisformatyset, axisformatyget

axisformatxget, axisformatxset, axisformatyget, axisformatyset

axis format $ = axisformatxget(node name $)
axisformatxset(node name $, axis format $)
axis format $ = axisformatyget(node name $)
axisformatyset(node name $, axis format $)

Get or set the numeric format of the given chart axis.

Available options are: none, numbers, integers, dollars, pennies, and dates.

The dates setting renders values as the number of seconds that have elapsed since 1970.

The none setting shows plain values, the numbers setting shows values with commas.

The dollars setting shows US currency, the pennies setting is dollars with 2 decimal places.
See: axisdecimalset, axisdecimalget

axismaxxget, axismaxxset

max x #.# = axismaxxget(node name $)
axismaxxset(node name $, axis max x #.#)

Set or get the x axis maximum.

axismaxyget, axismaxyset

max y #.# = axismaxyget(node name $)
axismaxyset(node name $, axis max y #.#)

Set or get the y axis maximum.

axisminxget, axisminxset

min x #.# = axisminxget(node name $)
axisminxset(node name $, axis min x #.#)

Set or get the x axis minimum.

axisminyget, axisminyset

min y #.# = axisminyget(node name $)
axisminyset(node name $, axis min y #.#)

Set or get the y axis minimum.

axisnamexget, axisnamexset

axis name $ = axisnamexget(node name $)
axisnamexset(node name $, axis name $)

Set or get the x axis name.

axisnameyget, axisnameyset

axis name $ = axisnameyget(node name $)
axisnameyset(node name $, axis name $)

Set or get the y axis name.

axisthickget, axisthickset

heavy axis TF = axisthickget(node name $)
axisthickset(node name $, heavy axis TF)

Hide or show thick axis.

boundsget, boundsset

rectangle $ = boundsget(node name $)
boundsset(node name $, rectangle $)

Get or set the boundary rectangle of the object.

countgroups

total groups # = countgroups(node name $)

Returns the total number of groups.

countitems

total items # = countitems(node name $)

Returns the total number of items in all groups.

deleteitem

deleteitem(node name $, item index #)

Deletes an item.

depthget, depthset

depth # = depthget(node name $)
depthset(node name $, depth #)

Get or set the Z depth of the chart.

This setting applies a 3D look and feel to all chart elements.

enabledget, enabledset

enabled TF = enabledget(node name $)
enabledset(node name $, enabled TF)

Get or set the enabled attribute of the chart. If enabled, the chart inverts selected items.
See: itemselectget, itemselectset, multiselectget, multiselectset, selectget, selectset

fillcolorget, fillcolorset

fill color $ = fillcolorget(node name $)
fillcolorset(node name $, fill color $)

Get or set the fill color for the chart.

fillget, fillset

fill TF = fillget(node name $)
fillset(node name $, fill TF)

Get or set if the chart is filled or transparent.

fontnameget, fontnameset

font name $ = fontnameget(node name $)
fontnameset(node name $, font name $)

Get or set the font name for the entire chart.

fontsizeget, fontsizeset

font size # = fontsizeget(node name $)
fontsizeset(node name $, font size #)

Get or set the font size for the entire chart.

fullget, fullset, infoget, infoset

full $ = fullget(node name $)
fullset(node name $, full $)
info $ = infoget(node name $)
infoset(node name $, info $)

Get or set XML data that describes all the settings for this node.

The fullget and fullset routines have a header element with appropriate namespaces, infoget and infoset are an XML snippet for access as a property. Example:

mynode.info.title = "new title"

groupcolorget, groupcolorset

thecolor $ = groupcolorget(node name $, group #)
groupcolorset(node name $, group #, thecolor $)

Set or get the group color.

groupnameget, groupnameset

group name $ = groupnameget(node name $, group #)
groupnameset(node name $, group #, group name $)

Set or get the group name.

guidexget, guidexset

guide x #.# = guidexget(node name $)
guidexset(node name $, guide x #.#)

Set or get the x guide.
See: showguidexset, showguidexget

guideyget, guideyset

guide y #.# = guideyget(node name $)
guideyset(node name $, guide y #.#)

Set or get the y guide.
See: showguideyset, showguideyget

handlesget, handlesset

handles TF = handlesget(node name $)
handlesset(node name $, handles TF)

Turn on or off dragable handles for reshaping the node.

This routine is used by the system tool palettes for manual positioning.
See: markersget, markersset, partget, partset

hiliteget, hiliteset

hilite $ = hiliteget(node name $)
hiliteset(node name $, hilite $)

Get or set the hilite of the chart, which inverts some area of the chart image.

Hilites include: legend, axisx, axisy, title, body and none.

This is useful to show mouse selection of different parts of a chart.
See: hittestarea

hittest

hit item index # = hittest(node name $, hor #, ver #)

Returns the index of the item clicked on, or zero if the mouse is not in an item.

hittestarea

hit area $ = hittestarea(node name $, hor #, ver #)

Returns the basic area of the chart that was clicked on.

Available areas include: legend, axisx, axisy, title, body and none.
See: hiliteset, hiliteget

insertitem

insertitem(node name $, after index #)

Inserts a new item after the given position. Use zero to insert at the beginning of the chart.

itemcolorget, itemcolorset

color $ = itemcolorget(node name $, item index #)
itemcolorset(node name $, item index #, color $)

Get or set the color of an item.

itemgroupget, itemgroupset

group # = itemgroupget(node name $, item index #)
itemgroupset(node name $, item index #, group #)

Set or get the item group.

itemnameget, itemnameset

item name $ = itemnameget(node name $, item index #)
itemnameset(node name $, item index #, item name $)

Get or set the name of an item.

itemselectget, itemselectset

select TF = itemselectget(node name $, item index #)
itemselectset(node name $, item index #, select TF)

Get or set the selected item attribute. If an item is selected, it will appear inverted.

Selecting a new item will deselect the old one, unless multiselect is true.
See: enabledget, enabledset, multiselectset, multiselectget, selectget, selectset

itemstyleget, itemstyleset

item style name $ = itemstyleget(node name $, item index #)
itemstyleset(node name $, item index #, item style name $)

Get or set the style of an item.

Styles include: none, littledot, bigdot, littlerect, bigrect, diamond, bigoval, littleoval, and cross.

itemxget, itemxset

x #.# = itemxget(node name $, item index #)
itemxset(node name $, item index #, x #.#)

Set or get the item x value.

itemyget, itemyset

y #.# = itemyget(node name $, item index #)
itemyset(node name $, item index #, y #.#)

Set or get the item y value.

linecolorget, linecolorset

line color $ = linecolorget(node name $)
linecolorset(node name $, line color $)

Get or set the line color for the chart axis, guides, and legend.

marginget, marginset

margin # = marginget(node name $)
marginset(node name $, margin #)

Get or set the margin of the chart.

This setting controls the space between bars in bar and cylinder graphs and how much a selected item will move in a pie chart.

Set the margin to zero for the default value.

markersget, markersset

markers TF = markersget(node name $)
markersset(node name $, markers TF)

Turn on or off the node outline to show selection.

This routine is used by the system tool palettes to show that a node is selected.
See: handlesset, handlesget, partget, partset

multiselectget, multiselectset

multiselect TF = multiselectget(node name $)
multiselectset(node name $, multiselect TF)

If true, multiple items can be selected, if false, only one item at a time can be selected.
See: itemselectset, itemselectget, enabledget, enabledset, selectget, selectset

partget, partset

part # = partget(node name $, hor #, ver #)
partset(node name $, hor #, ver #, part #)

Get or set the points for an individual handle.
See: markersget, markersset, handlesset, handlesget

selectcolorget, selectcolorset

select color $ = selectcolorget(node name $)
selectcolorset(node name $, select color $)

Get or set the select color for selected chart items.

selectget, selectset

item index # = selectget(node name $)
selectset(node name $, item index #)

Get or set the currently selected item, or zero for no item selected.

If multiple items are selected, selectget will return the first selected item.
See: enabledget, enabledset, multiselectget, multiselectset, itemselectset, itemselectget

shadedget, shadedset

shaded TF = shadedget(node name $)
shadedset(node name $, shaded TF)

Get or set the shaded attribute of the chart.

This applies a subtle color ramp to all chart elements.

showguidexget, showguidexset

show guide x TF = showguidexget(node name $)
showguidexset(node name $, show guide x TF)

Get or set the visibility of the x guide line.
See: guidexset, guidexget

showguideyget, showguideyset

show guide y TF = showguideyget(node name $)
showguideyset(node name $, show guide y TF)

Get or set the visibility of the y guide line.
See: guideyset, guideyget

showlegendget, showlegendset

show legend TF = showlegendget(node name $)
showlegendset(node name $, show legend TF)

Hide or show the legend.

shownamesget, shownamesset

show names TF = shownamesget(node name $)
shownamesset(node name $, show names TF)

Show names on individual items.

showpercentget, showpercentset

show percent TF = showpercentget(node name $)
showpercentset(node name $, show percent TF)

Show percentages.

showunitsxget, showunitsxset

show units x TF = showunitsxget(node name $)
showunitsxset(node name $, show units x TF)

Show and hide the units on the X axis.

showunitsyget, showunitsyset

show units y TF = showunitsyget(node name $)
showunitsyset(node name $, show units y TF)

Show and hide the units on the Y axis.

stackedget, stackedset

stacked TF = stackedget(node name $)
stackedset(node name $, stacked TF)

Get or set the stacked attribute of the chart.

This changes bar and area charts to have a stacked appearance.

styleget, styleset

style name $ = styleget(node name $)
styleset(node name $, style name $)

Get or set the style of the chart.

Available styles include: bar, pie, area, line, scatter, and cylinder.

textcolorget, textcolorset

text color $ = textcolorget(node name $)
textcolorset(node name $, text color $)

Get or set the text color for the axis and legend.

titlefontnameget, titlefontnameset

title font name $ = titlefontnameget(node name $)
titlefontnameset(node name $, font name $)

Get or set the font name of the title.

titlefontsizeget, titlefontsizeset

title font size # = titlefontsizeget(node name $)
titlefontsizeset(node name $, font size #)

Get or set the font size of the title.

titleget, titleset

title $ = titleget(node name $)
titleset(node name $, title $)

Get or set the title for the chart.

titletextcolorget, titletextcolorset

title text color $ = titletextcolorget(node name $)
titletextcolorset(node name $, title text color $)

Get or set the text color for the title.