# Interface: TickOptions

# Properties

# backdropColor

backdropColor: Scriptable<Color, ScriptableScaleContext>

Color of label backdrops.

Default

'rgba(255, 255, 255, 0.75)'

# Defined in

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


# backdropPadding

backdropPadding: number | ChartArea

Padding of tick backdrop.

Default

2

# Defined in

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


# callback

callback: (this: Scale<CoreScaleOptions>, tickValue: string | number, index: number, ticks: Tick[]) => string | number | string[] | number[]

# Type declaration

▸ (this, tickValue, index, ticks): string | number | string[] | number[]

Returns the string representation of the tick value as it should be displayed on the chart. See callback.

# Parameters
Name Type
this Scale<CoreScaleOptions>
tickValue string | number
index number
ticks Tick[]
# Returns

string | number | string[] | number[]

# Defined in

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


# color

color: ScriptableAndArray<Color, ScriptableScaleContext>

Color of tick

See

Defaults.color

# Defined in

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


# display

display: boolean

If true, show tick labels.

Default

true

# Defined in

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


# font

font: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableScaleContext>

see Fonts

# Defined in

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


# major

major: Object

# Type declaration

Name Type Description
enabled boolean If true, major ticks are generated. A major tick will affect autoskipping and major will be defined on ticks in the scriptable options context. Default false

# Defined in

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


# padding

padding: number

Sets the offset of the tick labels from the axis

# Defined in

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


# showLabelBackdrop

showLabelBackdrop: Scriptable<boolean, ScriptableScaleContext>

If true, draw a background behind the tick labels.

Default

false

# Defined in

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


# textStrokeColor

textStrokeColor: Scriptable<Color, ScriptableScaleContext>

The color of the stroke around the text.

Default

undefined

# Defined in

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


# textStrokeWidth

textStrokeWidth: Scriptable<number, ScriptableScaleContext>

Stroke width around the text.

Default

0

# Defined in

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


# z

z: number

z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.

Default

0

# Defined in

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