xmCHART 3.4 - Reference
Last updated: 2010-06-05

Graphics Primitives index previous next


AddArc(left;top;width;height;startAngle;arcAngle;lineWidth;lineColor;
       linePattern)
Argument required type range default notes
left • num -9e99..+9e99    
top • num -9e99..+9e99    
width • num 0..+9e99    
height • num 0..+9e99    
startAngle   num -360..+360 0 Dimension: [deg]
arcAngle   num -360..+360 90 Dimension: [deg]
lineWidth   num[] 0..100 1 Dimension: [pt]
lineColor   rgba 0..255 black color constants
linePattern   int 1..128 black pattern constants

Examples:

AddArc(50;50;250;150)
AddArc(50;50;250;150;180;180;2)
AddArc(50;50;250;150;180;180;3 10 5;violet)

Notes:
 


AddArrow(hStart;vStart;hEnd;vEnd;lineWidth;lineColor;linePattern;headLocation;
         headLength;headWidth;headInset;hasHollowHead)
Argument required type range default notes
hStart • num -9e99..+9e99    
vStart • num -9e99..+9e99    
hEnd • num -9e99..+9e99    
vEnd • num -9e99..+9e99    
lineWidth   num[] 0..100 1 Dimension: [pt]
lineColor   rgba 0..255 black color constants
linePattern   int 1..128 black pattern constants
headLocation   int 0..3 end arrow head locations
headLength   num 0..1000 16 Dimension: [pt]
headWidth   num 0..1000 8 Dimension: [pt]
headInset   num -1000..1000 0 Dimension: [pt]
hasHollowHead   int 0..1 off flag constants

Examples:

AddArrow(50;50;200;200;2;blue;;;30;15;10)
AddArrow(100;150;100;0;1;darkGray;;begin+end)

Notes:
 


AddClipOval(type;left;top;width;height)
Argument required type range default notes
type   int 1..3 sect clipping constants
left • num -9e99..+9e99    
top • num -9e99..+9e99    
width • num 0..+9e99    
height • num 0..+9e99    

Examples:

AddClipOval(diff;0;0;400;300)
AddClipOval(;50;50;150;150)

Notes:
Currently the clipping functions are supported only in Windows OS.


AddClipPolygon(type;scanDirection;listOfCoords)
Argument required type range default notes
type   int 1..3 sect clipping constants
scanDirection   int 1..2 xxyy scan directions
listOfCoords • num[] -9e99..+9e99    

Examples:

AddClipPolygon(;xxyy;350 50 250 150 250 100 350 250 350 50)
AddClipPolygon(union;xyxy;350 50 250 150 250 100 350 250 350 50)

Notes:
Currently the clipping functions are supported only in Windows OS.


AddClipRect(type;left;top;width;height)
Argument required type range default notes
type   int 1..3 sect clipping constants
left • num -9e99..+9e99    
top • num -9e99..+9e99    
width • num 0..+9e99    
height • num 0..+9e99    

Examples:

AddClipRect(sect;0;0;100;100)
AddClipRect(diff;50;50;250;150)

Notes:
Currently the clipping functions are supported only in Windows OS.


AddClipReset()
Argument required type range default notes

Example:
AddClipReset()

Notes:
Currently the clipping functions are supported only in Windows OS.


AddClipRoundRect(type;left;top;width;height;hCurvature;vCurvature)
Argument required type range default notes
type   int 1..3 sect clipping constants
left • num -9e99..+9e99    
top • num -9e99..+9e99    
width • num 0..+9e99    
height • num 0..+9e99    
hCurvature   num 0..100 12 Dimension: [pt]
vCurvature   num 0..100 12 Dimension: [pt]

Examples:

AddClipRoundRect(diff;0;0;400;300)
AddClipRoundRect(;50;50;150;150;16;16)

Notes:
 


AddClipSlice(type;left;top;width;height;startAngle;arcAngle;innerRadius)
Argument required type range default notes
type   int 1..3 sect clipping constants
left • num -9e99..+9e99    
top • num -9e99..+9e99    
width • num 0..+9e99    
height • num 0..+9e99    
startAngle   num -360..+360 0 Dimension: [deg]
arcAngle   num -360..+360 90 Dimension: [deg]
innerRadius   num 0..100 0 in % of slice radius

Examples:

AddClipSlice(union;50;50;250;150)
AddClipSlice(;50;50;250;150;-45;90)

Notes:
Currently the clipping functions are supported only in Windows OS.


AddClipSmoothPolygon(type;scanDirection;listOfCoords)
Argument required type range default notes
type   int 1..3 sect clipping constants
scanDirection   int 1..2 xxyy scan directions
listOfCoords • num[] -9e99..+9e99    

Examples:

AddClipSmoothPolygon(;xxyy;350 50 250 150 250 100 350 250 350 50)
AddClipSmoothPolygon(;xyxy;350 50 250 150 250 100 350 250 350 50)

Notes:
Currently the clipping functions are supported only in Windows OS.


AddEllipse(left;top;width;height;lineWidth;lineColor;linePattern)
Argument required type range default notes
left • num -9e99..+9e99    
top • num -9e99..+9e99    
width • num 0..+9e99    
height • num 0..+9e99    
lineWidth   num[] 0..100 1 Dimension: [pt]
lineColor   rgba 0..255 black color constants
linePattern   int 1..128 black pattern constants

Examples:

AddEllipse(150;20;150;150)
AddEllipse(150;20;150;150;3;blue)

Notes:
 


AddFrame(left;top;width;height;frameWidth;frameColor;framePattern)
Argument required type range default notes
left • num -9e99..+9e99    
top • num -9e99..+9e99    
width • num 0..+9e99    
height • num 0..+9e99    
frameWidth   num[] 0..100 1 Dimension: [pt]
frameColor   rgba 0..255 black color constants
framePattern   int 1..128 black pattern constants

Examples:

AddFrame(50;50;250;150)
AddFrame(50;50;250;150;3;red)

Notes:
 


AddLine(hStart;vStart;hEnd;vEnd;lineWidth;lineColor;linePattern)
Argument required type range default notes
hStart • num -9e99..+9e99    
vStart • num -9e99..+9e99    
hEnd • num -9e99..+9e99    
vEnd • num -9e99..+9e99    
lineWidth   num[] 0..100 1 Dimension: [pt]
lineColor   rgba 0..255 black color constants
linePattern   int 1..128 black pattern constants

Examples:

AddLine(50;150;250;0)
AddLine(100;150;100;0;1;darkGray)

Notes:
 


AddOval(left;top;width;height;fillColor;fillPattern)
Argument required type range default notes
left • num -9e99..+9e99    
top • num -9e99..+9e99    
width • num 0..+9e99    
height • num 0..+9e99    
fillColor   rgba 0..255 black color constants
fillPattern   int 1..128 black pattern constants

Examples:

AddOval(50;20;150;150)
AddOval(50;20;150;150;red)
AddOval(50;20;250;150;0 100 100 200)

Notes:
 

 
AddPath(pathData;fillColor;fillPattern;borderWidth;borderColor;
        borderPattern;shadowOffset;shadowColor;shadowPattern)
Argument required type range default notes
pathData • num[] -9e99..+9e99    
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:

AddPath(2  50 50     // move to 50 50
        3 100 50     // line to 100 50
        3 100 100    // line to 100 100
        1;           // close path
        darkYellow;; // fill
        3;darkRed)   // border

Notes:
Path constants: 1...close path,      2...move to,
                3...line to,         4...quadratic Bezier to,
                5...cubic Bezier to, 6...elliptical arc to


AddPicture(left;top;width;height;sourceType;sourceName;location;adjustment;
           isProportional)
Argument required type range default notes
left • num -9e99..+9e99    
top • num -9e99..+9e99    
width   num 0..10000 (pict width) Dimension: [pt]
height   num 0..10000 (pict height) Dimension: [pt]
sourceType   int 1..3 clipboard picture source constants
sourceName   str 0..1000 "" max. 1000 chars.
location   int 1..9 centerCenter location constants
adjustment   int 1..5 reduceOrEnlarge picture adjustment const.
isProportional   int 0..1 off flag constants

Examples:

AddPicture(100;100) // use the picture in the clipboard
AddPicture(100;100;;;file;"Pictures/logo.png")
AddPicture(100;100;;;file;"C:/Programs/Plots/logo.png")
AddPicture(100;100;;;file;"Macintosh HD/Pictures/logo.pdf")

Notes:
 


AddPolygon(scanDirection;listOfCoords;fillColor;fillPattern)
Argument required type range default notes
scanDirection   int 1..2 xxyy scan directions
listOfCoords • num[] -9e99..+9e99    
fillColor   rgba 0..255 black color constants
fillPattern   int 1..128 black pattern constants

Examples:

AddPolygon(xxyy;50 50 150 150 150 100 50 250)
AddPolygon(xyxy;50 50 150 150 150 100 50 250;blue)

Notes:
 

 
AddPolyline(scanDirection;listOfCoords;lineWidth;lineColor;linePattern)
Argument required type range default notes
scanDirection   int 1..2 xxyy scan directions
listOfCoords • num[] -9e99..+9e99    
lineWidth   num[] 0..100 1 Dimension: [pt]
lineColor   rgba 0..255 black color constants
linePattern   int 1..128 black pattern constants

Examples:

AddPolyline(xxyy;50 50 150 150 150 100 50 250)
AddPolyline(xyxy;50 50 150 150 150 100 50 250;2;blue)

Notes:
 


AddRect(left;top;width;height;fillColor;fillPattern)
Argument required type range default notes
left • num -9e99..+9e99    
top • num -9e99..+9e99    
width • num 0..+9e99    
height • num 0..+9e99    
fillColor   rgba 0..255 black color constants
fillPattern   int 1..128 black pattern constants

Examples:

AddRect(50;50;250;150)
AddRect(53;53;250;150;gray)

Notes:
 


AddRoundFrame(left;top;width;height;hCurvature;vCurvature;frameWidth;
              frameColor;framePattern)
Argument required type range default notes
left • num -9e99..+9e99    
top • num -9e99..+9e99    
width • num 0..+9e99    
height • num 0..+9e99    
hCurvature   num 0..100 12 Dimension: [pt]
vCurvature   num 0..100 12 Dimension: [pt]
frameWidth   num[] 0..100 1 Dimension: [pt]
frameColor   rgba 0..255 black color constants
framePattern   int 1..128 black pattern constants

Examples:

AddRoundFrame(50;50;250;150;;;2;red)
AddRoundFrame(50;50;250;150;16;16;2)

Notes:
 


AddRoundRect(left;top;width;height;hCurvature;vCurvature;fillColor;fillPattern)
Argument required type range default notes
left • num -9e99..+9e99    
top • num -9e99..+9e99    
width • num 0..+9e99    
height • num 0..+9e99    
hCurvature   num 0..100 12 Dimension: [pt]
vCurvature   num 0..100 12 Dimension: [pt]
fillColor   rgba 0..255 black color constants
fillPattern   int 1..128 black pattern constants

Examples:

AddRoundRect(50;50;250;150)
AddRoundRect(50;50;250;150;16;16;lightGray)

Notes:
 


AddSlice(left;top;width;height;startAngle;arcAngle;innerRadius;fillColor;
         fillPattern)
Argument required type range default notes
left • num -9e99..+9e99    
top • num -9e99..+9e99    
width • num 0..+9e99    
height • num 0..+9e99    
startAngle   num -360..+360 0 Dimension: [deg]
arcAngle   num -360..+360 90 Dimension: [deg]
innerRadius   num 0..100 0 in % of slice radius
fillColor   rgba 0..255 black color constants
fillPattern   int 1..128 black pattern constants

Examples:

AddSlice(50;50;250;150;-45;90)
AddSlice(50;50;250;150;45;90;20;red)

Notes:
 


AddSmoothPolygon(scanDirection;listOfCoords;fillColor;fillPattern)
Argument required type range default notes
scanDirection   int 1..2 xxyy scan directions
listOfCoords • num[] -9e99..+9e99    
fillColor   rgba 0..255 black color constants
fillPattern   int 1..128 black pattern constants

Examples:

AddSmoothPolygon(xxyy;350 50 250 150 250 100 350 250 350 50;red)
AddSmoothPolygon(xyxy;350 50 250 150 250 100 350 250 350 50;0 90 200)

Notes:
 


AddSmoothPolyline(scanDirection;listOfCoords;lineWidth;lineColor;linePattern)
Argument required type range default notes
scanDirection   int 1..2 xxyy scan directions
listOfCoords • num[] -9e99..+9e99    
lineWidth   num[] 0..100 1 Dimension: [pt]
lineColor   rgba 0..255 black color constants
linePattern   int 1..128 black pattern constants

Examples:

AddSmoothPolyline(xxyy;350 50 250 150 250 100 350 250 350 50)
AddSmoothPolyline(xyxy;350 50 250 150 250 100 350 250 350 50;3;red)

Notes:
 

 
AddSymbol(hPosition;vPosition;symbolType;symbolSize;lineWidth;symbolColor;
          symbolPattern)
Argument required type range default notes
hPosition • num -9e99..+9e99    
vPosition • num -9e99..+9e99    
symbolType   int 0..18 bullet symbol constants
symbolSize   num 0..100 9 Dimension: [pt]
lineWidth   num[] 0..100 1 Dimension: [pt]
symbolColor   rgba 0..255 black color constants
symbolPattern   int 1..128 black pattern constants

Examples:

AddSymbol(100;150;bullet;10;1;darkGray)
AddSymbol(100;150;circle)

Notes:
 

 
AddText(hPosition;vPosition;text;font;size;style;color;hAlignment;
        vAlignment;orientation;maxWidth;maxHeight;ellipsisPosition)
Argument required type range default notes
hPosition • num -9e99..+9e99    
vPosition • num -9e99..+9e99    
text   str 0..10000 "" max. 10000 chars.
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
hAlignment   int 1..3 left horizontal alignments
vAlignment   int 1..4 baseline vertical 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:

AddText(125;135;"LABEL";"ApplFont";32;bold;blue)
AddText(205;155;"Item-2";"Times";16;bold+underline;red)

Notes:
 


©2010 X2max Software index previous next