React PolarChart - valueAxis.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.

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:
Name Type Description
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.

NOTE
As an alternative to the function’s parameter you can use the this keyword.

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:
Name Type Description
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.
NOTE
As an alternative to the function’s parameter you can use the this keyword.
See Also

font

Specifies font options for axis labels.

Type:

Object

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

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