label

Specifies options for value axis labels.

Type: Object

Axis labels represent textual values for axis ticks, which are not visible by default. To specify custom settings for the value axis labels, use the label configuration object. If you need to set a common value for labels on all axes, use the commonAxisSettings | label configuration object. This object exposes the properties that can be specified for labels on all axes simultaneously. Note that a value specified for the value axis individually (in the valueAxis | label object) overrides the value that is specified in the commonAxisSettings | label object.

Show Example:
jQuery

In this example, additional text is added to the value axis labels using the customizeText option.


                                    

                                    

alignment

Specifies the label's position relative to the tick (grid line).

Type: String
Default Value: undefined
Accepted Values: 'left' | 'center' | 'right'

Show Example:
jQuery

Use the drop-down menu at the bottom to change the value axis' alignment option.


                                    

                                    

customizeHint

Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis.

Type: function(axisValue)
Function parameters:
axisValue: Object
An object providing access to the value displayed by the axis label.
Object structure:
The value as it is specified in the data source.
valueText: String
The value with applied format and precision.
Return Value: String
The text to be displayed in the hint.

This option accepts a function that must return the required text. When implementing this function, use its parameter to access the value displayed by the axis label.

customizeText

Specifies a callback function that returns the text to be displayed in value axis labels.

Type: function(axisValue)
Function parameters:
axisValue: Object
Defines an axis value.
Object structure:
Specifies the axis value that is currently represented.
valueText: String
Specifies the currently represented axis value with an applied format, if the format and precision (optional) properties are specified.
Return Value: String
The text to be displayed by a value axis label.
Cannot be used in themes.

When implementing a callback function for this configuration option, use the value to be displayed in a label. This value can be accessed using the fields of the object that is passed as the function's parameter. Alternatively, you can use the this object within the function. This object has the same structure as the object passed as a parameter.

For general information on data formatting, refer to the Data Formatting topic.

Show Example:
jQuery

In the example below, additional text is added to the value axis' label values using the customizeText option.


                                    

                                    

font

Specifies font options for axis labels.

Type: Object

Show Example:
jQuery

In this example, the font color of the value axis label text is black, and the font size is increased to 15 pixels.


                                    

                                    

format

Specifies a format for the text displayed by axis labels.

Type: String
Default Value: ''
Accepted Values: 'currency' | 'fixedPoint' | 'percent' | 'decimal' | 'exponential' | 'largeNumber' | 'thousands' | 'millions' | 'billions' | 'trillions' | 'longDate' | 'longTime' | 'monthAndDay' | 'monthAndYear' | 'quarterAndYear' | 'shortDate' | 'shortTime' | 'millisecond' | 'day' | 'month' | 'quarter' | 'year'

Labels display axis values. You can apply formatting to the label text by using one of the available formats.

NOTE: You can set a precision for a label text when the 'fixedPoint', 'exponential', 'currency' or 'percent' format is applied. Use the precision property to do this.

For details on formatting, refer to the Data Formatting topic.

Show Example:
jQuery

The example below shows a chart with formatted value axis labels. The format of these labels is set to 'fixedPoint' using the format option.


                                    

                                    

indentFromAxis

Specifies the spacing between an axis and its labels in pixels.

Type: Number
Default Value: 10

IdentFromAxis ChartJS

overlappingBehavior

Specifies the overlap resolving algorithm to be applied to axis labels.

Type: String|Object
Default Value: 'enlargeTickInterval'
Accepted Values: 'ignore' | 'stagger' | 'rotate' | 'enlargeTickInterval'

When labels overlap each other, you can specify how these labels will be displayed by setting the overlappingBehavior option. The values accepted by this option depend on whether an axis is horizontal or vertical.

NOTE: By default, the argument axis is horizontal and the value axis is vertical. To swap the axes over, assign true to the rotated property.

For a vertical axis, the following values can be assigned to the overlappingBehavior option.

  • ignore
    Leave the labels overlapped.

  • enlargeTickInterval
    Leave the labels as they are, but enlarge the axis tick intervals so that the labels do not overlap.

Horizontal axis' labels have two more modes. These modes are always applied regardless of there being a label overlap or not.

  • stagger
    Arrange labels in a staggered manner. The spacing between label rows will be 5 pixels.

  • rotate
    Rotate labels so that they are perpendicular to the axis.

To set custom spacing between staggered rows or the custom rotation angle for the 'stagger' and 'rotate' modes, assign an object to the overlappingBehavior configuration property. Set the object's mode property to the required mode, and set the staggeringSpacing or rotationAngle property to the required value.

Show Example:
jQuery

In the following example, the chart is rotated and the value axis tick interval is intentionally set to a very small value, so that the labels overlap each other. The overlap is resolved by staggering the labels with 2 pixel spacing.


                                    

                                    

precision

Specifies a precision for the formatted value displayed in the axis labels.

Type: Number
Default Value: 0

This property's value must be an integer indicating the number of digits to show in the axis values displayed in labels. This property value is used when labels display axis values in one of the following numeric formats: 'fixedPoint', 'exponential', 'currency' or 'percent'. To learn how to set a format for axis values, refer to the format property description.

For general information on data formatting, refer to the Data Formatting topic.

Show Example:
jQuery

The example below represents a chart with formatted value axis labels. The format of these labels is set to 'fixedPoint' using the format option, and the presicion is set to 2 using the precision option.


                                    

                                    

visible

Indicates whether or not axis labels are visible.

Type: Boolean
Default Value: true

Show Example:
jQuery

Use the check box at the bottom to change the visibility of the value axis labels.