TickLabels
TickLabels class
Represents the tick-mark labels associated with tick marks on a chart axis.
class TickLabels;
Methods
| Method | Description |
|---|---|
| getFont() | Returns a Font object that represents the font of the specified TickLabels object. |
| getAutoScaleFont() | True if the text in the object changes font size when the object size changes. The default value is True. |
| setAutoScaleFont(boolean) | True if the text in the object changes font size when the object size changes. The default value is True. |
| getBackgroundMode() | Gets and sets the display mode of the background |
| setBackgroundMode(BackgroundMode) | Gets and sets the display mode of the background |
| getRotationAngle() | Represents text rotation angle in clockwise. |
| setRotationAngle(number) | Represents text rotation angle in clockwise. |
| isAutomaticRotation() | Indicates whether the rotation angle is automatic |
| setIsAutomaticRotation(boolean) | Indicates whether the rotation angle is automatic |
| get_NumberFormat() | Represents the format string for the TickLabels object. |
| setNumberFormat(string) | Represents the format string for the TickLabels object. |
| getNumber() | Represents the format number for the TickLabels object. |
| setNumber(number) | Represents the format number for the TickLabels object. |
| getNumberFormatLinked() | True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). |
| setNumberFormatLinked(boolean) | True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). |
| getDisplayNumberFormat() | Gets and sets the display number format of tick labels. |
| getOffset() | Gets and sets the distance between the axis labels and the axis line. |
| setOffset(number) | Gets and sets the distance between the axis labels and the axis line. |
| getReadingOrder() | Represents text reading order. |
| setReadingOrder(TextDirectionType) | Represents text reading order. |
| getDirectionType() | Gets and sets the direction of text. |
| setDirectionType(ChartTextDirectionType) | Gets and sets the direction of text. |
| getTickLabelItems() | Gets the display tick labels of the axis. |
| getAlignmentType() | Gets and sets the text alignment for the tick labels on the axis. |
| setAlignmentType(TickLabelAlignmentType) | Gets and sets the text alignment for the tick labels on the axis. |
getFont()
Returns a Font object that represents the font of the specified TickLabels object.
getFont() : Font;
Returns
getAutoScaleFont()
True if the text in the object changes font size when the object size changes. The default value is True.
getAutoScaleFont() : boolean;
setAutoScaleFont(boolean)
True if the text in the object changes font size when the object size changes. The default value is True.
setAutoScaleFont(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getBackgroundMode()
Gets and sets the display mode of the background
getBackgroundMode() : BackgroundMode;
Returns
setBackgroundMode(BackgroundMode)
Gets and sets the display mode of the background
setBackgroundMode(value: BackgroundMode) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | BackgroundMode | The value to set. |
getRotationAngle()
Represents text rotation angle in clockwise.
getRotationAngle() : number;
Remarks
0: Not rotated.
255: Top to Bottom.
-90: Downward.
90: Upward.
setRotationAngle(number)
Represents text rotation angle in clockwise.
setRotationAngle(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
0: Not rotated.
255: Top to Bottom.
-90: Downward.
90: Upward.
isAutomaticRotation()
Indicates whether the rotation angle is automatic
isAutomaticRotation() : boolean;
setIsAutomaticRotation(boolean)
Indicates whether the rotation angle is automatic
setIsAutomaticRotation(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
get_NumberFormat()
Represents the format string for the TickLabels object.
get_NumberFormat() : string;
Remarks
The formatting string is same as a custom format string setting to a cell. For example, “$0”.
setNumberFormat(string)
Represents the format string for the TickLabels object.
setNumberFormat(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
Remarks
The formatting string is same as a custom format string setting to a cell. For example, “$0”.
getNumber()
Represents the format number for the TickLabels object.
getNumber() : number;
setNumber(number)
Represents the format number for the TickLabels object.
setNumber(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getNumberFormatLinked()
True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
getNumberFormatLinked() : boolean;
setNumberFormatLinked(boolean)
True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
setNumberFormatLinked(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getDisplayNumberFormat()
Gets and sets the display number format of tick labels.
getDisplayNumberFormat() : string;
getOffset()
Gets and sets the distance between the axis labels and the axis line.
getOffset() : number;
Remarks
The default distance is 100 percent, which represents the default spacing between the axis labels and the axis line. The value can be an integer percentage from 0 through 1000, relative to the axis label’s font size.
setOffset(number)
Gets and sets the distance between the axis labels and the axis line.
setOffset(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
The default distance is 100 percent, which represents the default spacing between the axis labels and the axis line. The value can be an integer percentage from 0 through 1000, relative to the axis label’s font size.
getReadingOrder()
Represents text reading order.
getReadingOrder() : TextDirectionType;
Returns
setReadingOrder(TextDirectionType)
Represents text reading order.
setReadingOrder(value: TextDirectionType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TextDirectionType | The value to set. |
getDirectionType()
Gets and sets the direction of text.
getDirectionType() : ChartTextDirectionType;
Returns
setDirectionType(ChartTextDirectionType)
Gets and sets the direction of text.
setDirectionType(value: ChartTextDirectionType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ChartTextDirectionType | The value to set. |
getTickLabelItems()
Gets the display tick labels of the axis.
getTickLabelItems() : TickLabelItem[];
Returns
Remarks
Only available after calling Chart.Calculate() method.
getAlignmentType()
Gets and sets the text alignment for the tick labels on the axis.
getAlignmentType() : TickLabelAlignmentType;
Returns
setAlignmentType(TickLabelAlignmentType)
Gets and sets the text alignment for the tick labels on the axis.
setAlignmentType(value: TickLabelAlignmentType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TickLabelAlignmentType | The value to set. |