- Interface: CartesianScaleOptions
Interface: CartesianScaleOptions
Hierarchy
-
↳
CartesianScaleOptions
Properties
alignToPixels
• alignToPixels: boolean
Align pixel values to device pixels
Inherited from
CoreScaleOptions.alignToPixels
Defined in
index.esm.d.ts:1090 (opens new window)
axis
• axis: "x"
| "y"
Which type of axis this is. Possible values are: ‘x’, ‘y’. If not set, this is inferred from the first character of the ID which should be ‘x’ or ‘y’.
Defined in
index.esm.d.ts:2817 (opens new window)
display
• display: boolean
| "auto"
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.
default
true
Inherited from
Defined in
index.esm.d.ts:1086 (opens new window)
grid
• grid: GridLineOptions
Defined in
index.esm.d.ts:2835 (opens new window)
max
• max: number
User defined maximum value for the scale, overrides maximum value from data.
Defined in
index.esm.d.ts:2827 (opens new window)
min
• min: number
User defined minimum value for the scale, overrides minimum value from data.
Defined in
index.esm.d.ts:2822 (opens new window)
offset
• offset: boolean
If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to true for a bar chart by default.
default
false
Defined in
index.esm.d.ts:2833 (opens new window)
position
• position: "left"
| "right"
| "bottom"
| "top"
| "center"
| { [scale: string]: number
; }
Position of the axis.
Defined in
index.esm.d.ts:2813 (opens new window)
reverse
• reverse: boolean
Reverse the scale.
default
false
Inherited from
Defined in
index.esm.d.ts:1095 (opens new window)
stacked
• Optional
stacked: boolean
| "single"
If true, data will be comprised between datasets of data
default
false
Defined in
index.esm.d.ts:2852 (opens new window)
ticks
• ticks: TickOptions
& { align
: "start"
| "end"
| "center"
; autoSkip
: boolean
; autoSkipPadding
: number
; crossAlign
: "center"
| "near"
| "far"
; includeBounds
: boolean
; labelOffset
: number
; maxRotation
: number
; minRotation
: number
; mirror
: boolean
; padding
: number
; sampleSize
: number
}
Defined in
index.esm.d.ts:2854 (opens new window)
title
• title: Object
Type declaration
Name | Type |
---|---|
color | Color |
display | boolean |
font | FontSpec |
padding | Object |
padding.bottom | number |
padding.top | number |
text | string | string [] |
Defined in
index.esm.d.ts:2837 (opens new window)
weight
• weight: number
The weight used to sort the axis. Higher weights are further away from the chart area.
default
true
Inherited from
Defined in
index.esm.d.ts:1100 (opens new window)
Methods
afterBuildTicks
▸ afterBuildTicks(axis
): void
Callback that runs after ticks are created. Useful for filtering ticks.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void
Inherited from
CoreScaleOptions.afterBuildTicks
Defined in
index.esm.d.ts:1128 (opens new window)
afterCalculateLabelRotation
▸ afterCalculateLabelRotation(axis
): void
Callback that runs after tick rotation is determined.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void
Inherited from
CoreScaleOptions.afterCalculateLabelRotation
Defined in
index.esm.d.ts:1144 (opens new window)
afterDataLimits
▸ afterDataLimits(axis
): void
Callback that runs after data limits are determined.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void
Inherited from
CoreScaleOptions.afterDataLimits
Defined in
index.esm.d.ts:1120 (opens new window)
afterFit
▸ afterFit(axis
): void
Callback that runs after the scale fits to the canvas.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void
Inherited from
Defined in
index.esm.d.ts:1152 (opens new window)
afterSetDimensions
▸ afterSetDimensions(axis
): void
Callback that runs after dimensions are set.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void
Inherited from
CoreScaleOptions.afterSetDimensions
Defined in
index.esm.d.ts:1112 (opens new window)
afterTickToLabelConversion
▸ afterTickToLabelConversion(axis
): void
Callback that runs after ticks are converted into strings.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void
Inherited from
CoreScaleOptions.afterTickToLabelConversion
Defined in
index.esm.d.ts:1136 (opens new window)
afterUpdate
▸ afterUpdate(axis
): void
Callback that runs at the end of the update process.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void
Inherited from
Defined in
index.esm.d.ts:1156 (opens new window)
beforeBuildTicks
▸ beforeBuildTicks(axis
): void
Callback that runs before ticks are created.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void
Inherited from
CoreScaleOptions.beforeBuildTicks
Defined in
index.esm.d.ts:1124 (opens new window)
beforeCalculateLabelRotation
▸ beforeCalculateLabelRotation(axis
): void
Callback that runs before tick rotation is determined.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void
Inherited from
CoreScaleOptions.beforeCalculateLabelRotation
Defined in
index.esm.d.ts:1140 (opens new window)
beforeDataLimits
▸ beforeDataLimits(axis
): void
Callback that runs before data limits are determined.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void
Inherited from
CoreScaleOptions.beforeDataLimits
Defined in
index.esm.d.ts:1116 (opens new window)
beforeFit
▸ beforeFit(axis
): void
Callback that runs before the scale fits to the canvas.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void
Inherited from
Defined in
index.esm.d.ts:1148 (opens new window)
beforeSetDimensions
▸ beforeSetDimensions(axis
): void
Callback that runs before dimensions are set.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void
Inherited from
CoreScaleOptions.beforeSetDimensions
Defined in
index.esm.d.ts:1108 (opens new window)
beforeTickToLabelConversion
▸ beforeTickToLabelConversion(axis
): void
Callback that runs before ticks are converted into strings.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void
Inherited from
CoreScaleOptions.beforeTickToLabelConversion
Defined in
index.esm.d.ts:1132 (opens new window)
beforeUpdate
▸ beforeUpdate(axis
): void
Callback called before the update process starts.
Parameters
Name | Type |
---|---|
axis | Scale <CoreScaleOptions > |
Returns
void