@finchart

Appearance

Documentation / @finchart/core / index / PlotConfig

Interface: PlotConfig ​

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

Extended by ​

Properties ​

axis? ​

optional axis?: object

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

x is shared by every pane; y is per pane. The y here is the default, and an individual pane overrides it via PaneOptions.axis — but placement (size, position) is decided only here (see YAxisOptions).

x? ​

optional x?: XAxisOptions

y? ​

optional y?: YAxisOptions

axisDrag? ​

optional axisDrag?: boolean

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

Whether dragging on an axis slice can adjust the scale. Enabled if omitted. Vertical drag on the y-axis = that pane's value axis (autoScale turns off); horizontal drag on the x-axis = zooming x. A tool (an input consumer) always gets first claim.

maxBarSpacing? ​

optional maxBarSpacing?: number

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

minBarSpacing? ​

optional minBarSpacing?: number

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

Lower and upper bound, in pixels, for how much space one bar occupies — the limits of zoom. A zoom that would push one domain unit outside this pixel range is clamped on the spot.

Defaults to the coordinate system's own default if omitted — the bar-index coordinate system (barIndexX) uses min 0.5 / max 200, and a continuous coordinate system has no limit. 0 turns off the limit in that direction — a value that says "none" on top of the default.

padding? ​

optional padding?: Padding

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

Outer margin. DEFAULT_PADDING if omitted.

paneGap? ​

optional paneGap?: number

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

Gap between panes (px). Defaults to 0 if omitted.

preserveLiveRightEdgeOnZoomOut? ​

optional preserveLiveRightEdgeOnZoomOut?: boolean

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

While the latest bar is visible, keep a zoom-out from moving the right edge farther into empty space. A pan or a zoom while browsing history still follows the usual cursor-anchored behavior. Off by default.

resizablePanes? ​

optional resizablePanes?: boolean

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

Whether dragging a divider can resize pane heights. Enabled if omitted.

rightOffset? ​

optional rightOffset?: number

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

Empty space after the last bar, in domain units (bar count, for a bar-index coordinate system). Only applies to fitting (fitDomains, first data) — pan/zoom belong to the user.

shiftVisibleRangeOnNewBar? ​

optional shiftVisibleRangeOnNewBar?: boolean

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

When a new bar arrives, if the last bar was in view, shift the window right by that much. Doesn't shift while looking at history — the window mustn't get dragged along mid-scroll. Off by default: silently moving the window is the worse mistake.

showGrid? ​

optional showGrid?: boolean

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

Whether grid lines are drawn. On if omitted.

style? ​

optional style?: object

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

Overrides the CSS variable / default only for the fields given here.

grid? ​

optional grid?: Partial<LineStyle>