@finchart

Appearance

Documentation / @finchart/core / index / YAxisOptions

Interface: YAxisOptions ​

Defined in: packages/core/src/plot/types.ts:57

What the y-axis (value axis) has in addition. Both fields are chart-wide.

Extends ​

Extended by ​

Properties ​

format? ​

optional format?: (value, step?) => string

Defined in: packages/core/src/plot/types.ts:36

Tick value to display string. If a ticks strategy is present, this isn't used for ticks themselves, but it's still used, regardless of the strategy, as the default formatting for decorations (crosshair badge, tooltip, legend, priceLine). The second argument is the tick spacing, used to pick how many digits distinguish neighboring ticks.

Parameters ​

value ​

number

step? ​

number

Returns ​

string

Inherited from ​

AxisOptions.format

minTickSpacing? ​

optional minTickSpacing?: number

Defined in: packages/core/src/plot/types.ts:38

Minimum pixels one tick occupies. Falls back to a per-direction default if omitted.

Inherited from ​

AxisOptions.minTickSpacing

position? ​

optional position?: "left" | "right"

Defined in: packages/core/src/plot/types.ts:64

Which side the y-axis is on. Left by default. Chart-wide — there's only one slice, so different panes can't have different sides.

showLabels? ​

optional showLabels?: boolean

Defined in: packages/core/src/plot/types.ts:28

Whether tick labels are shown on the overlay. Default true.

Inherited from ​

AxisOptions.showLabels

size? ​

optional size?: number

Defined in: packages/core/src/plot/types.ts:59

Fixed width (px) of the axis space. Skips measurement if given.

ticks? ​

optional ticks?: TickStrategy

Defined in: packages/core/src/plot/types.ts:44

Placement and labeling of ticks, as one unit — where timeTicks (the time axis) goes. Read for both x and y, and per pane too. If a strategy is present, the default arithmetic and format aren't used.

Inherited from ​

AxisOptions.ticks