@finchart

Appearance

Documentation / @finchart/tools / DrawingToolsOptions

Interface: DrawingToolsOptions ​

Defined in: tools/src/tools.ts:96

Properties ​

defaults? ​

optional defaults?: object

Defined in: tools/src/tools.ts:122

What a drawing of this kind is born with when it is drawn by hand — the fields that are not geometry. A Fibonacci drawn with the pointer is otherwise its anchors and nothing else, so without this there is no way for a hand to get log-spaced levels or a level list of its own.

Hand-drawn only: add takes exactly what it is given, and clearing a field with update({ … : undefined }) goes back to the built-in default, not to this. Read once — the tool keeps its own copy.

fib? ​

optional fib?: Pick<FibRetracement, "levels" | "levelSpacing">

fibExtension? ​

optional fibExtension?: Pick<FibExtension, "levels" | "levelSpacing">

plot ​

plot: DrawingStage

Defined in: tools/src/tools.ts:98

Input, coordinates, and render requests belong to the chart → DrawingStage

priority? ​

optional priority?: number

Defined in: tools/src/tools.ts:102

Input priority. Higher claims first. Omit for 0.

snap? ​

optional snap?: boolean

Defined in: tools/src/tools.ts:111

Snapping — drawing and anchor dragging stick to a bar's values (close, low, high) and the bar's x. Off by default (TradingView convention). Moving the whole drawing doesn't snap, to preserve its relative layout. Toggle it at runtime with api.setSnap.

snapRadius? ​

optional snapRadius?: number

Defined in: tools/src/tools.ts:127

The snap radius (px). Default 8. Free-hand drawing when the candidate is outside it. A hit-test distance, so not a CSS variable.

style? ​

optional style?: Partial<LineStyle>

Defined in: tools/src/tools.ts:104

Overrides the CSS variables and defaults.

zIndex? ​

optional zIndex?: number

Defined in: tools/src/tools.ts:100

Stacking order. Omit for the decoration default (above the series).