@finchart

Appearance

Documentation / @finchart/core / index / AxisOptions

Interface: AxisOptions ​

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

How ticks are picked and shown. Can be overridden per pane.

Placement (size, position) isn't here because there's only one axis slice per chart, so there's no room to give different panes different widths or sides.

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

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.

showLabels? ​

optional showLabels?: boolean

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

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

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.