TickLabels

TickLabels class

Represents the tick-mark labels associated with tick marks on a chart axis.

class TickLabels;

Properties

Property	Type	Description
font	Font	Readonly. Returns a Font object that represents the font of the specified TickLabels object.
autoScaleFont	boolean	True if the text in the object changes font size when the object size changes. The default value is True.
backgroundMode	BackgroundMode	Gets and sets the display mode of the background
rotationAngle	number	Represents text rotation angle in clockwise.
isAutomaticRotation	boolean	Indicates whether the rotation angle is automatic
numberFormat	string	Represents the format string for the TickLabels object.
number	number	Represents the format number for the TickLabels object.
numberFormatLinked	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).
displayNumberFormat	string	Readonly. Gets and sets the display number format of tick labels.
offset	number	Gets and sets the distance of labels from the category axis. Only for category (x) axis.
readingOrder	TextDirectionType	Represents text reading order.
directionType	ChartTextDirectionType	Gets and sets the direction of text.
tickLabelItems	TickLabelItem[]	Readonly. Gets the display tick labels of the axis.
alignmentType	TickLabelAlignmentType	Gets and sets the text alignment for the tick labels on the axis.

Methods

Method	Description
getFont()	@deprecated. Please use the ‘font’ property instead. Returns a Font object that represents the font of the specified TickLabels object.
getAutoScaleFont()	@deprecated. Please use the ‘autoScaleFont’ property instead. True if the text in the object changes font size when the object size changes. The default value is True.
setAutoScaleFont(boolean)	@deprecated. Please use the ‘autoScaleFont’ property instead. True if the text in the object changes font size when the object size changes. The default value is True.
getBackgroundMode()	@deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background
setBackgroundMode(BackgroundMode)	@deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background
getRotationAngle()	@deprecated. Please use the ‘rotationAngle’ property instead. Represents text rotation angle in clockwise.
setRotationAngle(number)	@deprecated. Please use the ‘rotationAngle’ property instead. Represents text rotation angle in clockwise.
isAutomaticRotation()	@deprecated. Please use the ‘isAutomaticRotation’ property instead. Indicates whether the rotation angle is automatic
setIsAutomaticRotation(boolean)	@deprecated. Please use the ‘isAutomaticRotation’ property instead. Indicates whether the rotation angle is automatic
get_NumberFormat()	@deprecated. Please use the ’numberFormat’ property instead. Represents the format string for the TickLabels object.
setNumberFormat(string)	@deprecated. Please use the ’numberFormat’ property instead. Represents the format string for the TickLabels object.
getNumber()	@deprecated. Please use the ’number’ property instead. Represents the format number for the TickLabels object.
setNumber(number)	@deprecated. Please use the ’number’ property instead. Represents the format number for the TickLabels object.
getNumberFormatLinked()	@deprecated. Please use the ’numberFormatLinked’ property instead. 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)	@deprecated. Please use the ’numberFormatLinked’ property instead. 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()	@deprecated. Please use the ‘displayNumberFormat’ property instead. Gets and sets the display number format of tick labels.
getOffset()	@deprecated. Please use the ‘offset’ property instead. Gets and sets the distance of labels from the category axis. Only for category (x) axis.
setOffset(number)	@deprecated. Please use the ‘offset’ property instead. Gets and sets the distance of labels from the category axis. Only for category (x) axis.
getReadingOrder()	@deprecated. Please use the ‘readingOrder’ property instead. Represents text reading order.
setReadingOrder(TextDirectionType)	@deprecated. Please use the ‘readingOrder’ property instead. Represents text reading order.
getDirectionType()	@deprecated. Please use the ‘directionType’ property instead. Gets and sets the direction of text.
setDirectionType(ChartTextDirectionType)	@deprecated. Please use the ‘directionType’ property instead. Gets and sets the direction of text.
getTickLabelItems()	@deprecated. Please use the ’tickLabelItems’ property instead. Gets the display tick labels of the axis.
getAlignmentType()	@deprecated. Please use the ‘alignmentType’ property instead. Gets and sets the text alignment for the tick labels on the axis.
setAlignmentType(TickLabelAlignmentType)	@deprecated. Please use the ‘alignmentType’ property instead. Gets and sets the text alignment for the tick labels on the axis.
isNull()	Checks whether the implementation object is null.

font

Readonly. Returns a Font object that represents the font of the specified TickLabels object.

font : Font;

autoScaleFont

True if the text in the object changes font size when the object size changes. The default value is True.

autoScaleFont : boolean;

backgroundMode

Gets and sets the display mode of the background

backgroundMode : BackgroundMode;

rotationAngle

Represents text rotation angle in clockwise.

rotationAngle : number;

Remarks

br>0: Not rotated.

255: Top to Bottom.

-90: Downward.

90: Upward.</br

isAutomaticRotation

Indicates whether the rotation angle is automatic

isAutomaticRotation : boolean;

numberFormat

Represents the format string for the TickLabels object.

numberFormat : string;

Remarks

The formatting string is same as a custom format string setting to a cell. For example, “$0”.

number

Represents the format number for the TickLabels object.

number : number;

numberFormatLinked

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).

numberFormatLinked : boolean;

displayNumberFormat

Readonly. Gets and sets the display number format of tick labels.

displayNumberFormat : string;

offset

Gets and sets the distance of labels from the category axis. Only for category (x) axis.

offset : 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.

readingOrder

Represents text reading order.

readingOrder : TextDirectionType;

directionType

Gets and sets the direction of text.

directionType : ChartTextDirectionType;

tickLabelItems

Readonly. Gets the display tick labels of the axis.

tickLabelItems : TickLabelItem[];

Remarks

Only available after calling Chart.Calculate() method.

alignmentType

Gets and sets the text alignment for the tick labels on the axis.

alignmentType : TickLabelAlignmentType;

getFont()

@deprecated. Please use the ‘font’ property instead. Returns a Font object that represents the font of the specified TickLabels object.

getFont() : Font;

Returns

Font

getAutoScaleFont()

@deprecated. Please use the ‘autoScaleFont’ property instead. True if the text in the object changes font size when the object size changes. The default value is True.

getAutoScaleFont() : boolean;

setAutoScaleFont(boolean)

@deprecated. Please use the ‘autoScaleFont’ property instead. 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()

@deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background

getBackgroundMode() : BackgroundMode;

Returns

BackgroundMode

setBackgroundMode(BackgroundMode)

@deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background

setBackgroundMode(value: BackgroundMode) : void;

Parameters:

Parameter	Type	Description
value	BackgroundMode	The value to set.

getRotationAngle()

@deprecated. Please use the ‘rotationAngle’ property instead. Represents text rotation angle in clockwise.

getRotationAngle() : number;

Remarks

br>0: Not rotated.

255: Top to Bottom.

-90: Downward.

90: Upward.</br

setRotationAngle(number)

@deprecated. Please use the ‘rotationAngle’ property instead. Represents text rotation angle in clockwise.

setRotationAngle(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

br>0: Not rotated.

255: Top to Bottom.

-90: Downward.

90: Upward.</br

isAutomaticRotation()

@deprecated. Please use the ‘isAutomaticRotation’ property instead. Indicates whether the rotation angle is automatic

isAutomaticRotation() : boolean;

setIsAutomaticRotation(boolean)

@deprecated. Please use the ‘isAutomaticRotation’ property instead. Indicates whether the rotation angle is automatic

setIsAutomaticRotation(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

get_NumberFormat()

@deprecated. Please use the ’numberFormat’ property instead. 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)

@deprecated. Please use the ’numberFormat’ property instead. 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()

@deprecated. Please use the ’number’ property instead. Represents the format number for the TickLabels object.

getNumber() : number;

setNumber(number)

@deprecated. Please use the ’number’ property instead. Represents the format number for the TickLabels object.

setNumber(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getNumberFormatLinked()

@deprecated. Please use the ’numberFormatLinked’ property instead. 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)

setNumberFormatLinked(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getDisplayNumberFormat()

@deprecated. Please use the ‘displayNumberFormat’ property instead. Gets and sets the display number format of tick labels.

getDisplayNumberFormat() : string;

getOffset()

@deprecated. Please use the ‘offset’ property instead. Gets and sets the distance of labels from the category axis. Only for category (x) axis.

getOffset() : number;

Remarks

setOffset(number)

@deprecated. Please use the ‘offset’ property instead. Gets and sets the distance of labels from the category axis. Only for category (x) axis.

setOffset(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

getReadingOrder()

@deprecated. Please use the ‘readingOrder’ property instead. Represents text reading order.

getReadingOrder() : TextDirectionType;

Returns

TextDirectionType

setReadingOrder(TextDirectionType)

@deprecated. Please use the ‘readingOrder’ property instead. Represents text reading order.

setReadingOrder(value: TextDirectionType) : void;

Parameters:

Parameter	Type	Description
value	TextDirectionType	The value to set.

getDirectionType()

@deprecated. Please use the ‘directionType’ property instead. Gets and sets the direction of text.

getDirectionType() : ChartTextDirectionType;

Returns

ChartTextDirectionType

setDirectionType(ChartTextDirectionType)

@deprecated. Please use the ‘directionType’ property instead. Gets and sets the direction of text.

setDirectionType(value: ChartTextDirectionType) : void;

Parameters:

Parameter	Type	Description
value	ChartTextDirectionType	The value to set.

getTickLabelItems()

@deprecated. Please use the ’tickLabelItems’ property instead. Gets the display tick labels of the axis.

getTickLabelItems() : TickLabelItem[];

Returns

TickLabelItem[]

Remarks

Only available after calling Chart.Calculate() method.

getAlignmentType()

@deprecated. Please use the ‘alignmentType’ property instead. Gets and sets the text alignment for the tick labels on the axis.

getAlignmentType() : TickLabelAlignmentType;

Returns

TickLabelAlignmentType

setAlignmentType(TickLabelAlignmentType)

@deprecated. Please use the ‘alignmentType’ property instead. 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.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;