@finchart

Appearance

Documentation / @finchart/core / index / ResolvedYAxisOptions

Interface: ResolvedYAxisOptions ​

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

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

Extends ​

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 ​

YAxisOptions.format

minTickSpacing ​

minTickSpacing: number

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

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

Overrides ​

YAxisOptions.minTickSpacing

position ​

position: "left" | "right"

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

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.

Overrides ​

YAxisOptions.position

showLabels ​

showLabels: boolean

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

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

Overrides ​

YAxisOptions.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.

Inherited from ​

YAxisOptions.size

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 ​

YAxisOptions.ticks