|
|
|
|
|
|
|
|
|
version 1
CT GET LEGEND ATTRIBUTES (area; object; display; orientation; reverseOrder; reverseKey; location; horizOffset; vertOffset)
| Parameter | Type | Description | |
| area | Longint |  | 4D Chart area |
| object | Longint | | Object ID |
| display | Integer |  | Is legend displayed? |
| 0 = No | |||
| 1 = Yes | |||
| orientation | Integer | | Receives orientation of the series in the legend |
| 0 = Horizontal | |||
| 1 = Vertical | |||
| reverseOrder | Integer | | Using reverse order? |
| 0 = Not reversed | |||
| 1 = Reversed | |||
| reverseKey | Integer | | Key and text reversed? |
| 0 = Not reversed | |||
| 1 = Reversed | |||
| location | Integer | | Receives location code |
| horizOffset | Integer | | Receives horizontal offset from |
| plot's left side in points | |||
| vertOffset | Integer | | Receives vertical offset from plot's |
| top side in points |
Description
The CT GET LEGEND ATTRIBUTES command returns the attributes of the legend specified by area and object in the variables for the display, orientation, reverseOrder, reverseKey, location, horizOffset, and vertOffset parameters.
display specifies whether or not the legend is displayed.
orientation specifies whether the series in the legend are displayed vertically or horizontally with regard to each other. The following are examples of vertical and horizontal legends:
Vertical Legend Horizontal Legend
reverseOrder specifies whether the order of the series in the legend is reversed.
reverseKey specifies whether the series label and the key that explains the unique pattern and color of the series are reversed. The default is to show the key to the left of the label.
The following table lists the codes for the location parameter:
| Code | Location |
| 0 | Legend's location is not one of the built-in locations |
| 1 | Top left |
| 2 | Bottom left |
| 3 | Top right |
| 4 | Bottom right |
| 5 | Left |
| 6 | Right |
| 7 | Top |
| 8 | Bottom |
horizOffset and vertOffset are used when location is not one of the built-in legend locations (location = 0). horizOffset is expressed in points from the left side of the graph to the left side of the legend. vertOffset is expressed in points from the top of the graph to the top of the legend.
Note: To get the text attributes of legend text, use the CT GET CHART TEXT ATTRIBUTES command.
Example
This example gets the legend text attributes for the chart specified by $ChartID.
CT GET LEGEND ATTRIBUTES (Area;$ChartID;$Display;$Orient;$ReverseO; $ReverseK;$Location;$HorizOff;$VertOff
See Also
CT GET CHART TEXT ATTRIBUTES, CT Get legend text, CT SET LEGEND ATTRIBUTES, CT SET LEGEND TEXT.
|
|
|
|
|
|
|
|
|