Linear Radial Axis
The following additional configuration options are provided by the radial linear scale.
Namespace:
Namespace: options.scales[scaleId]
Name | Type | Default | Description |
---|---|---|---|
type | string | Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart. | |
alignToPixels | boolean | false | Align pixel values to device pixels. |
backgroundColor | Color | Background color of the scale area. | |
display | boolean |string | true | Controls the axis global visibility (visible when true , hidden when false ). When display: ‘auto’ , the axis is visible only if at least one associated dataset is visible. |
grid | object | Grid line configuration. | |
min | number | User defined minimum number for the scale, overrides minimum value from data. more… | |
max | number | User defined maximum number for the scale, overrides maximum value from data. | |
reverse | boolean | false | Reverse the scale. |
stacked | boolean |string | false | Should the data be stacked. more… |
suggestedMax | number | Adjustment used when calculating the maximum data value. | |
suggestedMin | number | Adjustment used when calculating the minimum data value. more… | |
ticks | Tick configuration. | ||
weight | number | 0 | The weight used to sort the axis. Higher weights are further away from the chart area. |
Tick Configuration
Namespace: options.scales[scaleId].ticks
Namespace: options.scales[scaleId].ticks
Name | Type | Scriptable | Default | Description |
---|---|---|---|---|
backdropColor | Yes | ‘rgba(255, 255, 255, 0.75)’ | Color of label backdrops. | |
backdropPadding | Padding | 2 | Padding of label backdrop. | |
callback | function | Returns the string representation of the tick value as it should be displayed on the chart. See . | ||
display | boolean | true | If true, show tick labels. | |
color | Color | Yes | Chart.defaults.color | Color of ticks. |
font | Font | Yes | Chart.defaults.font | See |
major | object | {} | Major ticks configuration. | |
padding | number | 3 | Sets the offset of the tick labels from the axis | |
showLabelBackdrop | boolean | Yes | true for radial scale, false otherwise | If true, draw a background behind the tick labels. |
textStrokeColor | Yes | `` | The color of the stroke around the text. | |
textStrokeWidth | Yes | 0 | Stroke width around the text. | |
z | number | 0 | z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top. |
Given the number of axis range settings, it is important to understand how they all interact with each other.
The suggestedMax
and suggestedMin
settings only change the data values that are used to scale the axis. These are useful for extending the range of the axis while maintaining the auto fit behaviour.
In this example, the largest positive value is 50, but the data maximum is expanded out to 100. However, because the lowest data value is below the suggestedMin
setting, it is ignored.
In contrast to the suggested*
settings, the min
and max
settings set explicit ends to the axes. When these are set, some data points may not be visible.
Step Size
If set, the scale ticks will be enumerated by multiple of stepSize
, having one tick per increment. If not set, the ticks are labeled automatically using the nice numbers algorithm.
The following options are used to configure angled lines that radiate from the center of the chart to the point labels. Namespace: options.scales[scaleId].angleLines
The scriptable context is described in section.
Point Label Options
The following options are used to configure the point labels that are shown on the perimeter of the scale. Namespace: options.scales[scaleId].pointLabels
Name | Type | Scriptable | Default | Description |
---|---|---|---|---|
backdropColor | true | undefined | Background color of the point label. | |
backdropPadding | Padding | 2 | Padding of label backdrop. | |
display | boolean | true | if true, point labels are shown. | |
callback | function | Callback function to transform data labels to point labels. The default implementation simply returns the current string. | ||
color | Yes | Chart.defaults.color | Color of label. | |
font | Font | Yes | Chart.defaults.font | See Fonts |
padding | Yes | 5 | Padding between chart and point labels. |
The scriptable context is described in section.
Internally, the linear radial scale uses numeric data