xmCHART 3.4 - Reference
Last updated: 2010-09-04

Legend index previous next

 
LegendBackground(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:

LegendBackground()
LegendBackground(lightYellow;;2;white;;3)

Notes:
shadowOffset > 0: shadow bottom right
shadowOffset < 0: shadow top left.


LegendOptions(location;placeInside;hOffset;vOffset;distribution;markerType;              markerWidth;markerHeight;markerGap;rowGap;columnGap;textLocation;
             markerShape)
Argument required type range default notes
location   int 0..9 centerRight location constants
placeInside   int 0..1 off flag constants
hOffset   num -10000..+10000 0 Dimension:[pt]
vOffset   num -10000..+10000 0 Dimension:[pt]
distribution   int[] -1..1000 10 see notes
markerType   int 0..7 automatic legend marker types
markerWidth   num 0..10000 12 Dimension:[pt]
markerHeight   num 0..10000 12 Dimension:[pt]
markerGap   num -10000..+10000 6 Dimension:[pt]
rowGap   num -10000..+10000 4 Dimension:[pt]
columnGap   num -10000..+10000 8 Dimension:[pt]
textLocation   int 1..9 centerRight location constants
markerShape   int 1..3 1  

Examples:

LegendOptions(bottomRight;on;;;1;15;15)
LegendOptions(;;;;2)        // 2 rows (variable num of columns)
LegendOptions(;;;;2 -1)     // 2 rows (same as above)
LegendOptions(;;;;-1 2)     // 2 columns (variable num of rows)
LegendOptions(;;;;3 -1 1)   // 3 rows with layout column by column
LegendOptions(;;;;-1 1 0 1) // 1 column, bottom to top

Notes:

distribution flags:
[1]: numOfRows, range: -1..1000, default: 10
[2]: numOfColums, range: -1..1000, default: -1 (-1...variable)
[3]: doArrangeColumnByColumn, range: 0..1, default: 0
[4]: doArrangeReversed 0..1, default: 0
[5]: useEquidstantColumnWidths, range: 0..1, default: 0
[6]: useEquidstantRowHeights, range: 0..1, default: 0


LegendStyle(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:

LegendStyle("Times")
LegendStyle("Times";12;bold)
LegendStyle(;;bold+underline;blue)

Notes:
 


LegendTexts(text1;text2...)
Argument required type range default notes
text1..10000   str 0..1000   max. 1000 chars/text

Examples:

LegendTexts("Q1";"Q2";"Q3";"Q4")
LegendTexts("Turnover\nDepartment A";"Turnover\nDepartment B")

Notes:
Texts consisting of several lines are possible by entering a line feed "\n".


©2010 X2max Software index previous next