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.


                                    

                                    

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

Function parameters:
axisValue:

Object

Information on the axis value.

Object structure:
value:

Date

|

Number

|

String

The raw value.

valueText:

String

The formatted value converted to a string.

Return Value:

String

The text for the hint to display.

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.

Show Example:
jQuery

In the example below, the value axis labels are detailed in a hint. This is performed using the label's customizeHint option.


                                    

                                    

customizeText

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

Type:

function

Function parameters:
axisValue:

Object

Information on the axis value.

Object structure:
value:

Date

|

Number

|

String

The raw value.

valueText:

String

The formatted value converted to a string.

Return Value:

String

The text for the label to display.

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

Formats a value before it is displayed in an axis label.

Type:

Format

Default Value: undefined

See the format section for details on accepted values.

See Also
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: 5

IdentFromAxis ChartJS

overlappingBehavior

Decides how to arrange axis labels when there is not enough space to keep all of them.

Type:

String

Default Value: 'hide'
Accepted Values: 'hide' | 'none'

When axis labels overlap each other, you can rearrange them by setting the overlappingBehavior option. It accepts the following values.

  • hide
    Hides certain axis labels leaving more space for the others.
  • none
    Leaves axis labels overlapped.

When using the widget as an ASP.NET MVC Control, specify this option using the PolarChartOverlappingBehavior enum. This enum accepts the following values: Hide and None.

NOTE
Specifying this option with the "enlargeTickInterval" and "ignore" values is deprecated.

precision

Deprecated

Use the valueAxis.label.format.precision option instead.

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

Type:

Number

Default Value: undefined

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.