CT GET LABEL ATTRIBUTES

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

version 1


CT GET LABEL ATTRIBUTES (area; object; axis; position; orientation; format{; frequency})

ParameterTypeDescription
areaLongint4D Chart area
objectLongintObject ID
axisIntegerChart axis
0 = Category
1 = Series
2 = Values
positionIntegerReceives position of label
0 = None
1 = Top
2 = Left
3 = Bottom
4 = Right
orientationIntegerReceives label orientation
0 = Normal
1 = Vertical
2 = Rotated right
3 = Rotated left
4 = Staggered
5 = Wrap around
formatStringReceives label format
frequencyIntegerReceives label display

Description

The CT GET LABEL ATTRIBUTES command returns in the position, orientation, and format parameters the attributes for the label of the axis specified by area, object, and axis.

position is the position of the axis labels relative to the graph.

orientation is the orientation of each label. The following label orientations are available for each axis:

format is the display format for the label text. When the display format is "General", an empty string "" is returned in the format parameter. For more information on the special characters used in display formats, see the 4th Dimension Design Reference.

The optional parameter frequency receives the label display frequency for the series or categories axis. This parameter returns the number of categories/series of the graph for which only one label is displayed. By default, this parameter returns 1(all labels are displayed). If the axis is the Values axis, frequency returns the value -32000. For information on setting the frequency parameter, see the description of the CT SET LABEL ATTRIBUTES command.

Note: To get the text attributes of axis labels, use the CT GET CHART TEXT ATTRIBUTES command

Example

This example returns the category axis label attributes for the chart specified by $ChartID in the $Position, $Orient, and $Format parameters.

   CT GET LABEL ATTRIBUTES (Area;$ChartID;0;$Position;$Orient;$Format)

See Also

CT GET CHART TEXT ATTRIBUTES, CT SET LABEL ATTRIBUTES.


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