Documentation / @finchart/core / index / PaneChange

Interface: PaneChange

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

The change a pane announces. It states what changed. The three axes are independent of each other, so they're spelled out as three fields — merging them into one would mean rebuilding the whole x index even for a single margin change (a full merge sort over every point, under a bar index coordinate system).

Properties

data

data: boolean

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

The drawn points changed. The x index needs rebuilding and the value axis needs refitting. Changes to the list (addSeries, dispose) belong here too — the union of drawn points changed.

If false, only the picture needs redrawing: value axis swap, decorations, and the pane settings below.

---

refit

refit: boolean

Defined in: packages/core/src/plot/pane.ts:82

The imperative SeriesHandle.setData replaced the source outright. Only meaningful when data is true.

---

settings?

optional settings?: boolean

Defined in: packages/core/src/plot/pane.ts:102

The pane's layout (flex, minHeight) or its value axis's mode (autoScale, invert, the scale instance, a value range set by hand) changed.

Kept separate from data changes because panesChange is a promise that "the panes changed" — firing it on every append would waste effort for anything following the layout.

---

xValues?

optional xValues?: boolean

Defined in: packages/core/src/plot/pane.ts:93

True: the set of x values being drawn changed. Omitting it is read as changed. Even among changes where data is true, most ticks only change values — replacing the bar in progress puts a different value at the same x, so the bar-index mapping has no reason to recount.

Omitting is the safe side — when unsure, recount. The only place that can say false is the one that knows the verdict (TypedEntry.updateLast).