CT SET LEGEND ATTRIBUTES

4D - Documentation   Français   English   German   4D Chart, Command Theme List   4D Chart, Command Alphabetical List   Back   Previous   Next

version 1


CT SET LEGEND ATTRIBUTES (area; object; display; orientation; reverseOrder; reverseKey; location; horizOffset; vertOffset)

ParameterTypeDescription
areaLongint4D Chart area
objectLongintObject ID
displayIntegerDisplay legend?
0 = No
1 = Yes
orientationIntegerOrientation of the series in the legend
0 = Horizontal
1 = Vertical
reverseOrderIntegerReverse order?
-1 = No change
0 = Do not reverse
1 = Reverse
reverseKeyIntegerUsing reverse order?
-1 = No change
0 = Do not reverse
1 = Reverse
locationIntegerLocation code
horizOffsetIntegerIf location = 0: Horizontal offset from
plot's left side in points
vertOffsetIntegerIf location = 0: Vertical offset from
plot's top side in points

Description

The CT SET LEGEND ATTRIBUTES command sets the attributes of the legend specified by area and object.

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. Here 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 contains the codes for the location parameter:

CodeLocation
-1No change
0Position legend using horizOffset and vertOffset
1Top left
2Bottom left
3Top right
4Bottom right
5Left
6Right
7Top
8Bottom

horizOffset and vertOffset are used when location is set to 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 displays the legend, centered at the top of the graph.

   CT SET LEGEND ATTRIBUTES (Area;$ChartID;1;0;0;0;7;0;0)

See Also

CT GET LEGEND ATTRIBUTES, CT Get legend text, CT SET CHART TEXT ATTRIBUTES, CT SET LEGEND TEXT.


4D - Documentation   Français   English   German   4D Chart, Command Theme List   4D Chart, Command Alphabetical List   Back   Previous   Next