Interface: CartesianScaleOptions

Interface: CartesianScaleOptions

Hierarchy

CoreScaleOptions

↳ CartesianScaleOptions

Properties

alignToPixels

• alignToPixels: boolean

Align pixel values to device pixels

Inherited from

CoreScaleOptions.alignToPixels

Defined in

types/index.d.ts:1162 (opens new window)

axis

• axis: "x" | "y" | "r"

Which type of axis this is. Possible values are: ‘x’, ‘y’, ‘r’. If not set, this is inferred from the first character of the ID which should be ‘x’, ‘y’ or ‘r’.

Defined in

types/index.d.ts:3162 (opens new window)

border

• border: BorderOptions

Defined in

types/index.d.ts:3182 (opens new window)

bounds

• bounds: "data" | "ticks"

Scale boundary strategy (bypassed by min/max time options)

data: make sure data are fully visible, ticks outside are removed
ticks: make sure ticks are fully visible, data outside are truncated

Since

2.7.0

Default

‘ticks’

Defined in

types/index.d.ts:3141 (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

CoreScaleOptions.display

Defined in

types/index.d.ts:1158 (opens new window)

grid

• grid: Partial<GridLineOptions>

Defined in

types/index.d.ts:3180 (opens new window)

max

• max: number

User defined maximum value for the scale, overrides maximum value from data.

Defined in

types/index.d.ts:3172 (opens new window)

min

• min: number

User defined minimum value for the scale, overrides minimum value from data.

Defined in

types/index.d.ts:3167 (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

types/index.d.ts:3178 (opens new window)

position

• position: "center" | "left" | "top" | "bottom" | "right" | { [scale: string]: number; }

Position of the axis.

Defined in

types/index.d.ts:3146 (opens new window)

reverse

• reverse: boolean

Reverse the scale.

Default

false

Inherited from

CoreScaleOptions.reverse

Defined in

types/index.d.ts:1167 (opens new window)

stack

• Optional stack: string

Stack group. Axes at the same position with same stack are stacked.

Defined in

types/index.d.ts:3151 (opens new window)

stackWeight

• Optional stackWeight: number

Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.

Default

Defined in

types/index.d.ts:3157 (opens new window)

stacked

• Optional stacked: boolean | "single"

If true, data will be comprised between datasets of data

Default

false

title

• title: Object

Options for the scale title.

Type declaration

Name	Type	Description
`align`	Align	Alignment of the axis title.
`color`	Color	Color of the axis label.
`display`	`boolean`	If true, displays the axis title.
`font`	ScriptableAndScriptableOptions<`Partial`<FontSpec>, ScriptableCartesianScaleContext>	Information about the axis title font.
`padding`	`number` \| { `bottom`: `number` ; `top`: `number` ; `y`: `number` }	Padding to apply around scale labels.
`text`	`string` \| `string`[]	The text for the title, e.g. “# of People” or “Response Choices”.