xmCHART 3.3 - Reference
Last updated: 2008-06-24

Charts index previous next


AreaChart(appearanceConstants;doShiftIntervalValues)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
doShiftIntervalValues   int 0..1 off flag constants

Examples:

AreaChart()
AreaChart(shadow+horizontal+label;on)

Notes:
 


AreaChart2D(appearanceConstants;fillAreaToAxis)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
fillAreaToAxis   int 0..2 0 see notes

Examples:

AreaChart2D()
AreaChart2D(shadow;1)

Notes:

fillAreaToAxis = 0: no fill to axis (default)
fillAreaToAxis = 1: fill area to x-axis
fillAreaToAxis = 2: fill area to y-axis


AreaChartOptions(useLineStyle;referenceValue;splitPosNegStacks)
Argument required type range default notes
useLineStyle   int 0..1 off flag constants
referenceValue   num -9e99..+9e99 0  
splitPosNegStacks   int 0..1 on flag constants

Examples:

AreaChartOptions(on)
AreaChartOptions(;;off)

Notes:
 


BarChart(appearanceConstants;categoryGap;seriesGap;barDepth)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
categoryGap   num 0..1000 100 in % of bar width
seriesGap   num -100..1000 see notes in % of bar width
barDepth   num 0..1000 0 in % of bar width

Examples:

BarChart()
BarChart(stacked;25)
BarChart(shadow+proportional;0;0;50)
BarChart(shadow+horizontal+label;;-50)

Notes:
default series gap for non-stacked bar charts: 0%
default series gap for stacked bar charts: -100%


BarChart2D(appearanceConstants;categoryGap;seriesGap;barDepth)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
categoryGap   num 0..1000 100 in % of bar width
seriesGap   num -100..1000 see notes in % of bar width
barDepth   num 0..1000 0 in % of bar width

Examples:

BarChart2D()
BarChart2D(stacked;25)
BarChart2D(shadow+proportional;0;0;50)
BarChart2D(shadow+horizontal+label;;-50)

Notes:
default series gap for non-stacked bar charts: 0%
default series gap for stacked bar charts: -100%


BarChartOptions(showConnectingLines;referenceValue;makeColorSplit)
Argument required type range default notes
showConnectingLines   int 0..1 off flag constants
referenceValue   num -9e99..+9e99 0  
makeColorSplit   int 0..1 off flag constants

Examples:

BarChartOptions(on)
BarChartOptions(;;on)

Notes:
 


BoxPlot(appearanceConstants;upperBoxPercentile;lowerBoxPercentile;
        upperWhiskerPercentile;lowerWhiskerPercentile)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
upperBoxPercentile   num 0..100 75 in [%]
lowerBoxPercentile   num 0..100 25 in [%]
upperWhiskerPercentile   num 0..100 90 in [%]
lowerWhiskerPercentile   num 0..100 10 in [%]

Examples:

BoxPlot(horizontal)
BoxPlot(;80;20;95;5)

Notes:
 


BoxPlotOptions(itemGap;isPercentileGraph;doFillBox;showMean;showMedian;
               showOutliersOnly;showCapsOnly;capLength;confidenceInterval)
Argument required type range default notes
itemGap   num -100..1000 100 in % of box width
isPercentileGraph   int 0..1 off flag constants
doFillBox   int 0..1 off flag constants
showMean   int 0..1 off flag constants
showMedian   int 0..1 off flag constants
showOutliersOnly   int 0..1 off flag constants
showCapsOnly   int 0..1 off flag constants
capLength   num 0..1000 50 in % of box width
confidenceInterval   num 0..99.9999   in % probability

Examples:

BoxPlotOptions(;;;on;on;on)
BoxPlotOptions(50;on)
BoxPlotOptions(;on;on;on;on;off;off;;95)

Notes:
 


BubbleChart(appearanceConstants;doShiftIntervalValues)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
doShiftIntervalValues   int 0..1 off flag constants

Examples:

BubbleChart(shadow)
BubbleChart(label+horizontal;on)

Notes:
 


BubbleChart2D(appearanceConstants)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants

Examples:

BubbleChart2D()
BubbleChart2D(label+shadow)

Notes:
 


BubbleChartOptions(maxDiameter;bubbleType)
Argument required type range default notes
maxDiameter   num 0..1000 30 Dimension: [pt]
bubbleType   int 1..2 areaProp bubble types

Examples:

BubbleChartOptions(50)
BubbleChartOptions(30;diameterProp)

Notes:
 


CandlestickChart(appearanceConstants;itemGap;highTickMarkLength;
                 highTickMarkAlignment;lowTickMarkLength;lowTickMarkAlignment)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
itemGap   num 0..1000 100 in [%] of box width
highTickMarkLength   num 0..100 0 in [%] of box width
highTickMarkAlignment   int 1..3 center horizontal alignments
lowTickMarkLength   num 0..100 0 in [%] of box width
lowTickMarkAlignment   int 1..3 center horizontal alignments

Examples:

CandlestickChart(;;5;right;5;left)
CandlestickChart(horizontal+shadow;50)

Notes:
 


CandlestickChart2D(appearanceConstants;itemGap;highTickMarkLength;
                 highTickMarkAlignment;lowTickMarkLength;lowTickMarkAlignment)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
itemGap   num 0..1000 100 in [%] of box width
highTickMarkLength   num 0..100 0 in [%] of box width
highTickMarkAlignment   int 1..3 center horizontal alignments
lowTickMarkLength   num 0..100 0 in [%] of box width
lowTickMarkAlignment   int 1..3 center horizontal alignments

Examples:

CandlestickChart2D(;;5;right;5;left)
CandlestickChart2D(horizontal+shadow;50)

Notes:
 


GanttChart(appearanceConstants;categoryGap;barDepth)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
categoryGap   num 0..1000 100 in % of bar width
barDepth   num 0..1000 0 in % of bar width

Examples:

GanttChart(label)
GanttChart(shadow+label;50;30)

Notes:
 


HighLowChart(appearanceConstants;doShiftIntervalValues;highLowChartType;
             highTickMarkLength;highTickMarkAlignment;lowTickMarkLength;
             lowTickMarkAlignment;closeTickMarkLength;closeTickMarkAlignment;
             openTickMarkLength;openTickMarkAlignment)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
doShiftIntervalValues   int 0..1 off flag constants
highLowChartType   int 1..3 highLow high-low chart constants
highTickMarkLength   num 0..100 25 in [%] of interval width
highTickMarkAlignment   int 1..3 center horizontal alignments
lowTickMarkLength   num 0..100 25 in [%] of interval width
lowTickMarkAlignment   int 1..3 center horizontal alignments
closeTickMarkLength   num 0..100 25 in [%] of interval width
closeTickMarkAlignment   int 1..3 center horizontal alignments
openTickMarkLength   num 0..100 25 in [%] of interval width
openTickMarkAlignment   int 1..3 center horizontal alignments

Examples:

HighLowChart(;on)
HighLowChart(horizontal;on;highLowClose)

Notes:
 


HighLowChart2D(appearanceConstants;highLowChartType;
              highTickMarkLength;highTickMarkAlignment;lowTickMarkLength;
              lowTickMarkAlignment;closeTickMarkLength;closeTickMarkAlignment;
              openTickMarkLength;openTickMarkAlignment)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
highLowChartType   int 1..3 highLow high-low chart constants
highTickMarkLength   num 0..100 25 in [%] of interval width
highTickMarkAlignment   int 1..3 center horizontal alignments
lowTickMarkLength   num 0..100 25 in [%] of interval width
lowTickMarkAlignment   int 1..3 center horizontal alignments
closeTickMarkLength   num 0..100 25 in [%] of interval width
closeTickMarkAlignment   int 1..3 center horizontal alignments
openTickMarkLength   num 0..100 25 in [%] of interval width
openTickMarkAlignment   int 1..3 center horizontal alignments

Examples:

HighLowChart2D(;on)
HighLowChart2D(horizontal;on;highLowClose)

Notes:
 


Histogram(appearanceConstants;categoryGap;seriesGap)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
categoryGap   num 0..1000 0 in % of bar width
seriesGap   num -100..1000 0 in % of bar width

Examples:

Histogram(;100)
Histogram(horizontal)

Notes:
 


HistogramOptions(doCountData;doMoveHigher;doIncludeEnds;frequencyLineOptions)
Argument required type range default notes
doCountData   int 0..1 off flag constants
doMoveHigher   int 0..1 on flag constants
doIncludeEnds   int 0..1 on flag constants
frequencyLineOptions   int 0..3 none frequency line options

Examples:

HistogramOptions(on)
HistogramOptions(;;;ogive)

Notes:
 


HistogramRange(minValue;maxValue;numOfBins)
Argument required type range default notes
minValue   num -9e99..+9e99 (autom.)  
maxValue   num -9e99..+9e99 (autom.)  
numOfBins   int 1..10000 10  

Examples:

HistogramRange(10;20;20)
HistogramRange(0;50)

Notes:
 


LineChart(appearanceConstants;doShiftIntervalValues)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
doShiftIntervalValues   int 0..1 off flag constants

Examples:

LineChart(shadow+symbol)
LineChart(shadow+horizontal+label;on)

Notes:
 


LineChart2D(appearanceConstants)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants

Examples:

LineChart2D()
LineChart2D(label+symbol+shadow)

Notes:
 


PieChart(appearanceConstants;pieDepth;innerRadius;startAngle;arcAngle)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
pieDepth   num 0..200 0 in % of pie radius
innerRadius   num 0..100 0 in % of pie radius
startAngle   num -360..+360 0 Dimension: [deg]
arcAngle   num -360..+360 360 Dimension: [deg]

Examples:

PieChart(label+oval;;80)
PieChart(label;20;80;-135;270)

Notes:
 


PieChartAuxLines(horizontalLength;extensionLength;vAlignment;width;color;
                 pattern)
Argument required type range default notes
horizontalLength   num 0..1000 10 in % of pie radius
extensionLength   num 0..1000 0 not implemented.
vAlignment   int 1..3 center vertical alignments
width   num[] 0.100 1 Dimension:[pt]
color   rgba 0..255 gray color constants
pattern   int 1..128 black pattern constants

Examples:

PieChartAuxLines(10;;bottom)
PieChartAuxLines(;;bottom;;black)

Notes:
 


PieChartCenterLabelBackground(fillColor;fillPattern;borderWidth;borderColor;
                              borderPattern;shadowOffset;shadowColor;
                              shadowPattern)
Argument required type range default notes
fillColor   rgba 0..255 white color constants
fillPattern   int 1..128 black pattern constants
borderWidth   num[] 0..100 1 Dimension:[pt]
borderColor   rgba 0..255 black color constants
borderPattern   int 1..128 black pattern constants
shadowOffset   num -100..100 0 Dimension:[pt]
shadowColor   rgba 0..255 gray color constants
shadowPattern   int 1..128 black pattern constants

Examples:

PieChartCenterLabelBackground(;transparent)
PieChartCenterLabelBackground(yellow;;;;;2)

Notes:
 


PieChartCenterLabelStyle(font;size;style;color;alignment;orientation;
                         maxWidth;maxHeight;ellipsisPosition)
Argument required type range default notes
font   str 0..255 "ApplFont" MacOS:Geneva/Windows:Arial
size   int 0.127 9 Dimension:[pt]
style   int 0..7 plain text styles
color   rgba

0..255

 black color constants
alignment   int 1..3 center horizontal alignments
orientation   num -360..+360 0 Dimension: [deg]
maxWidth   num -1..10000 -1 Dimension: [pt]
maxHeight   num -1..10000 -1 Dimension: [pt]
ellipsisPosition   int 0..4 3  

Examples:

PieChartCenterLabelStyle("Times";14)
PieChartCenterLabelStyle(;;bold)

Notes:
 


PieChartCenterLabelText(text)
Argument required type range default notes
text   str 0..1000 "" format specifiers

Examples:

PieChartCenterLabelText("Distribution\nA")
PieChartCenterLabelText("|u|")// show total

Notes:
 



PieChartExplodeDepths(explodeOffset;sliceIndex1;sliceIndex2...)
Argument required type range default notes
explodeOffset   num 0..100 20 in % of pie depth
sliceIndex1..1000   int -3..1000 none explode constants

Examples:

PieChartExplodeDepths(15;2)
PieChartExplodeDepths(20;max)
PieChartExplodeDepths(20;2;4;6;8)

Notes:
 



PieChartExplodes(explodeOffset;sliceIndex1;sliceIndex2...)
Argument required type range default notes
explodeOffset   num 0..100 20 in % of pie radius
sliceIndex1..1000   int -3..1000 none explode constants

Examples:

PieChartExplodes(15;all)
PieChartExplodes(20;max)
PieChartExplodes(20;2;4;6;8)

Notes:
 

 

 
PieChartInnerLabelBackground(fillColor;fillPattern;borderWidth;borderColor;
                             borderPattern;shadowOffset;shadowColor;
                             shadowPattern)
Argument required type range default notes
fillColor   rgba 0..255 white color constants
fillPattern   int 1..128 black pattern constants
borderWidth   num[] 0..100 1 Dimension:[pt]
borderColor   rgba 0..255 black color constants
borderPattern   int 1..128 black pattern constants
shadowOffset   num -100..100 0 Dimension:[pt]
shadowColor   rgba 0..255 gray color constants
shadowPattern   int 1..128 black pattern constants

Examples:

PieChartInnerLabelBackground(yellow)
PieChartInnerLabelBackground(;transparent)

Notes:
 


PieChartInnerLabelStyle(font;size;style;color;alignment;orientation;
                         maxWidth;maxHeight;ellipsisPosition)
Argument required type range default notes
font   str 0..255 "ApplFont" MacOS:Geneva/Windows:Arial
size   int 0.127 9 Dimension:[pt]
style   int 0..7 plain text styles
color   rgba

0..255

 black color constants
alignment   int 1..3 left horizontal alignments
orientation   num -360..+360 0 Dimension: [deg]
maxWidth   num -1..10000 -1 Dimension: [pt]
maxHeight   num -1..10000 -1 Dimension: [pt]
ellipsisPosition   int 0..4 3  

Examples:

PieChartInnerLabelStyle("Times";14)
PieChartInnerLabelStyle(;12;bold+underline)

Notes:
 


PieChartInnerLabelTexts(text1;text2...)
Argument required type range default notes
text1..10000   str 0..1000 "" format specifiers

Examples:

PieChartInnerLabelTexts("|||f1|%")// shows percent values
PieChartInnerLabelTexts("|u|\n(|f1|%)")// shows absolute and percent values

Notes:
 


PieChartLabelOptions(useRelativeLimits;outerLabelOffset;innerLabelOffset)
Argument required type range default notes
useRelativeLimits   int 0..1 off flag constants
outerLabelOffset   num -100..+100 0 in % of pie radius
innerLabelOffset   num -100..+100 0 in % of pie radius

Examples:

PieChartLabelOptions(on)
PieChartLabelOptions(;10;-5)

Notes:
 


PolarChart(appearanceConstants;startAngle;arcAngle)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
startAngle   num -360..+360 0 Dimension: [deg]
arcAngle   num -360..+360 360 Dimension: [deg]

Examples:

PolarChart(oval)
PolarChart(symbol+label+shadow)

Notes:
 


PolarChartOptions(scalingAxisIndex;gridShape;doAddArrows;doNotClosePolygon;
                  numOfAxes)
Argument required type range default notes
scalingAxisIndex   int 0..10000 1 0…no scaling
gridShape   int 0..3 oval grid shapes
doAddArrows   int 0..1 off flag constants
doNotClosePolygon   int 0..1 off flag constants
numOfAxes   int 2..100 12  

Examples:

PolarChartOptions(1;poly)
PolarChartOptions(;;;;36)

Notes:
 


RadarChart(appearanceConstants;startAngle;arcAngle;doShiftIntervals)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
startAngle   num -360..+360 0 Dimension: [deg]
arcAngle   num -360..+360 360 Dimension: [deg]
doShiftIntervals   int 0..1 off flag constants

Examples:

RadarChart(label+oval;90)
RadarChart(symbol+shadow;120;-240)

Notes:
 


RadarChartOptions(scalingAxisIndex;gridShape;doAddArrows;doNotClosePolygon)
Argument required type range default notes
scalingAxisIndex   int 0..10000 1 0…no scaling
gridShape   int 0..3 oval grid shapes
doAddArrows   int 0..1 off flag constants
doNotClosePolygon   int 0..1 off flag constants

Examples:

RadarChartOptions(4;poly)
RadarChartOptions(0;oval;on)

Notes:
 


ScatterChart(appearanceConstants;doShiftIntervals)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants
doShiftIntervals   int 0..1 off flag constants

Examples:

ScatterChart()
ScatterChart(shadow+horizontal+label;on)

Notes:
 


ScatterChart2D(appearanceConstants)
Argument required type range default notes
appearanceConstants   int 0..127 default chart appearance constants

Examples:

ScatterChart2D()
ScatterChart2D(label+shadow)

Notes:
 

©2008 X2max Software index previous next