@finchart

Appearance

Documentation / @finchart/core / index / ResolvedXAxisOptions

Interface: ResolvedXAxisOptions ​

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

format, ticks, and size stay optional in the resolved shape — there their absence is a behavior (default arithmetic, measuring), not a default value.

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 ​

XAxisOptions.format

minTickSpacing ​

minTickSpacing: number

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

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

Overrides ​

XAxisOptions.minTickSpacing

showLabels ​

showLabels: boolean

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

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

Overrides ​

XAxisOptions.showLabels

size? ​

optional size?: number

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

Fixed height (px) of the axis space. Skips measurement if given. A label bigger than this gets clipped — that's what "fixed" means.

Inherited from ​

XAxisOptions.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 ​

XAxisOptions.ticks