JavaScript/jQuery Chart - commonAxisSettings.label
Axis labels display the values of major axis ticks.
The commonAxisSettings.label object, which is described here, specifies common settings for all axis labels in the chart. To configure only those labels that belong to a particular axis, use the following objects.
Axis-specific settings override common settings.
component
An alias for the template property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
displayMode
This property accepts one of the following values.
- rotate
Rotates axis labels through the angle specified by the rotationAngle property. - stagger
Arranges axis labels in two rows in a staggering manner. An empty space between the rows is specified by the staggeringSpacing property. - standard
Does not change the default disposition of axis labels.
overlappingBehavior
When axis labels overlap each other, you can rearrange them by setting the overlappingBehavior property. Depending on whether an axis is horizontal or vertical, this property accepts different values.
The following values can be specified for both horizontal and vertical axes.
- hide
Hides certain axis labels leaving more space for the others. - none
Leaves axis labels overlapped.
The following values can be specified for horizontal axes only.
- rotate
Rotates axis labels through the angle specified by the rotationAngle property. - stagger
Arranges axis labels in two rows in a staggering manner. An empty space between the rows is specified by the staggeringSpacing property.
See Also
position
You can specify the following positions for labels on the valueAxis:
Value | Result |
---|---|
'inside', 'right' | |
'outside', 'left' |
The following positions are available for labels on the argumentAxis:
Value | Result |
---|---|
'inside', 'top' | |
'outside', 'bottom' |
The "inside" and "outside" values allow you to retain the label's position when you rotate the chart.
render
An alias for the template property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
rotationAngle
Specifies the rotation angle of axis labels. Applies only if displayMode or overlappingBehavior is "rotate".
staggeringSpacing
Adds a pixel-measured empty space between two staggered rows of axis labels. Applies only if displayMode or overlappingBehavior is "stagger".
textOverflow
Specifies what to do with axis labels that overflow the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing.
The textOverflow property does not apply if the displayMode or overlappingBehavior property is used to rotate axis labels.
wordWrap
This property affects the vertical axis only when the placeholderSize property limits space for labels.
The following modes are available:
"normal"
Text breaks only at allowed breakpoints (for example, a space between two words)."breakWord"
Words can be broken if there are no available breakpoints in the line."none"
Word wrap is disabled.
If the text overflows the container even after word wrap, the UI component applies the textOverflow property.