Documentation / @finchart/react / PlotOptions

Type Alias: PlotOptions

PlotOptions = Pick<PlotOptionsPatch, "padding" | "resizablePanes" | "shiftVisibleRangeOnNewBar" | "preserveLiveRightEdgeOnZoomOut" | "axisDrag" | "rightOffset" | "minBarSpacing" | "maxBarSpacing">

Defined in: react/src/hooks/plot-options.ts:18

The plot options that have no prop of their own. axis belongs to <XAxis>/<YAxis>, style.grid to gridStyle, and showGrid and paneGap are props — one door per value, because two doors to the same value erase each other (the value axis once had two, and whichever effect ran last won).

A key that is missing reverts to what the plot was built with. The list is a Pick, named twice — here and in pickPlotOptions — on purpose: an option the core adds later is not in this door until the wrapper has decided how it reverts, rather than admitted by the type and dropped at runtime. And a variable typed as the wider PlotOptionsPatch still assigns to a Pick, so the keys are picked by name before anything reaches the plot.