Skip to content

Documentation / @finchart/core / index / TickStrategyContext

Interface: TickStrategyContext ​

Defined in: packages/core/src/axis/types.ts:52

The context a TickStrategy receives. The domain is in scale space.

Properties ​

domainOf ​

domainOf: (x) => number

Defined in: packages/core/src/axis/types.ts:61

The data's x → domain value. For mapping a boundary back into the domain.

Parameters ​

x ​

number

Returns ​

number


max ​

max: number

Defined in: packages/core/src/axis/types.ts:54


min ​

min: number

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


minTickSpacing ​

minTickSpacing: number

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


positionOf ​

positionOf: (value) => number

Defined in: packages/core/src/axis/types.ts:67

Where a domain value is drawn along the axis, in pixels — the frame's own scale, so a strategy thins what will actually be drawn rather than an estimate of it made from the window's average density.

Parameters ​

value ​

number

Returns ​

number


snap? ​

optional snap?: (value) => number

Defined in: packages/core/src/axis/types.ts:74

In a bar-index coordinate system, the bar a boundary is drawn on: its own, or the first after it — "December" lands on December's first trading day even when the 1st is a Sunday. Absent where the domain is continuous and a boundary is drawn where it falls.

Parameters ​

value ​

number

Returns ​

number


span ​

span: number

Defined in: packages/core/src/axis/types.ts:56

Available pixels.


xOf ​

xOf: (value) => number

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

Domain value → the data's x. In bar-index coordinates, recovers that bar's x.

Parameters ​

value ​

number

Returns ​

number