React PolarChart - argumentAxis.label

Specifies properties for argument axis labels.

Selector: Label
Type:

Object

Axis labels represent textual values for axis ticks, which are not visible by default. To specify custom settings for the argument axis labels, use the label configuration object. 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 at once. Note that values specified for the argument axis individually (in the argumentAxis.label object) override values that are specified for all axes (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 argument axis.

Type:

Function

Function parameters:
argument:

Object

Information on the argument.

Object structure:
Name Type Description
value

Date

|

Number

|

String

The raw argument 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 by argument axis labels.

Type:

Function

Function parameters:
argument:

Object

Information on the argument.

Object structure:
Name Type Description
value

Date

|

Number

|

String

The raw argument 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 properties for axis labels.

Selector: Font
Type:

Object

format

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

Selector: Format
Type:

Format

Default Value: undefined

See the format section for information 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 property. It accepts the following values.

  • hide
    Hides certain axis labels leaving more space for the others.
  • none
    Leaves axis labels overlapped.
NOTE
Specifying this property with the "enlargeTickInterval" and "ignore" values is deprecated.

visible

Indicates whether or not axis labels are visible.

Type:

Boolean

Default Value: true