# Interface: CoreScaleOptions
# Hierarchy
CoreScaleOptions
# Properties
# alignToPixels
• alignToPixels: boolean
Align pixel values to device pixels
# Defined in
types/index.d.ts:1168 (opens new window)
# backgroundColor
• backgroundColor: Color
Background color of the scale area.
# Defined in
types/index.d.ts:1172 (opens new window)
# clip
• clip: boolean
Clip the dataset drawing against the size of the scale instead of chart area.
Default
true
# Defined in
types/index.d.ts:1182 (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
# Defined in
types/index.d.ts:1164 (opens new window)
# max
• max: unknown
User defined maximum value for the scale, overrides maximum value from data.
# Defined in
types/index.d.ts:1195 (opens new window)
# min
• min: unknown
User defined minimum value for the scale, overrides minimum value from data.
# Defined in
types/index.d.ts:1191 (opens new window)
# reverse
• reverse: boolean
Reverse the scale.
Default
false
# Defined in
types/index.d.ts:1177 (opens new window)
# suggestedMax
• suggestedMax: unknown
Adjustment used when calculating the minimum data value.
# Defined in
types/index.d.ts:1203 (opens new window)
# suggestedMin
• suggestedMin: unknown
Adjustment used when calculating the maximum data value.
# Defined in
types/index.d.ts:1199 (opens new window)
# weight
• weight: number
The weight used to sort the axis. Higher weights are further away from the chart area.
Default
true
# Defined in
types/index.d.ts:1187 (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
# Defined in
types/index.d.ts:1231 (opens new window)
# afterCalculateLabelRotation
▸ afterCalculateLabelRotation(axis): void
Callback that runs after tick rotation is determined.
# Parameters
| Name | Type |
|---|---|
axis | Scale<CoreScaleOptions> |
# Returns
void
# Defined in
types/index.d.ts:1247 (opens new window)
# afterDataLimits
▸ afterDataLimits(axis): void
Callback that runs after data limits are determined.
# Parameters
| Name | Type |
|---|---|
axis | Scale<CoreScaleOptions> |
# Returns
void
# Defined in
types/index.d.ts:1223 (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
# Defined in
types/index.d.ts:1255 (opens new window)
# afterSetDimensions
▸ afterSetDimensions(axis): void
Callback that runs after dimensions are set.
# Parameters
| Name | Type |
|---|---|
axis | Scale<CoreScaleOptions> |
# Returns
void
# Defined in
types/index.d.ts:1215 (opens new window)
# afterTickToLabelConversion
▸ afterTickToLabelConversion(axis): void
Callback that runs after ticks are converted into strings.
# Parameters
| Name | Type |
|---|---|
axis | Scale<CoreScaleOptions> |
# Returns
void
# Defined in
types/index.d.ts:1239 (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
# Defined in
types/index.d.ts:1259 (opens new window)
# beforeBuildTicks
▸ beforeBuildTicks(axis): void
Callback that runs before ticks are created.
# Parameters
| Name | Type |
|---|---|
axis | Scale<CoreScaleOptions> |
# Returns
void
# Defined in
types/index.d.ts:1227 (opens new window)
# beforeCalculateLabelRotation
▸ beforeCalculateLabelRotation(axis): void
Callback that runs before tick rotation is determined.
# Parameters
| Name | Type |
|---|---|
axis | Scale<CoreScaleOptions> |
# Returns
void
# Defined in
types/index.d.ts:1243 (opens new window)
# beforeDataLimits
▸ beforeDataLimits(axis): void
Callback that runs before data limits are determined.
# Parameters
| Name | Type |
|---|---|
axis | Scale<CoreScaleOptions> |
# Returns
void
# Defined in
types/index.d.ts:1219 (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
# Defined in
types/index.d.ts:1251 (opens new window)
# beforeSetDimensions
▸ beforeSetDimensions(axis): void
Callback that runs before dimensions are set.
# Parameters
| Name | Type |
|---|---|
axis | Scale<CoreScaleOptions> |
# Returns
void
# Defined in
types/index.d.ts:1211 (opens new window)
# beforeTickToLabelConversion
▸ beforeTickToLabelConversion(axis): void
Callback that runs before ticks are converted into strings.
# Parameters
| Name | Type |
|---|---|
axis | Scale<CoreScaleOptions> |
# Returns
void
# Defined in
types/index.d.ts:1235 (opens new window)
# beforeUpdate
▸ beforeUpdate(axis): void
Callback called before the update process starts.
# Parameters
| Name | Type |
|---|---|
axis | Scale<CoreScaleOptions> |
# Returns
void