Skip to content

charton API


charton API / @chart-on/core / index / DrawingPatch

Interface: DrawingPatch ​

Defined in: packages/core/src/drawing/manager.ts:212

Fields update() and preview() change; omitted fields stay, style is merged.

Properties ​

autoscale? ​

optional autoscale?: boolean

Defined in: packages/core/src/drawing/manager.ts:220


below? ​

optional below?: boolean

Defined in: packages/core/src/drawing/manager.ts:221


group? ​

optional group?: string

Defined in: packages/core/src/drawing/manager.ts:224


hidden? ​

optional hidden?: boolean

Defined in: packages/core/src/drawing/manager.ts:223


history? ​

optional history?: boolean

Defined in: packages/core/src/drawing/manager.ts:219


indicator? ​

optional indicator?: string

Defined in: packages/core/src/drawing/manager.ts:227

Id of the indicator the drawing belongs to; '' unties it.


locked? ​

optional locked?: boolean

Defined in: packages/core/src/drawing/manager.ts:216


name? ​

optional name?: string

Defined in: packages/core/src/drawing/manager.ts:225


persist? ​

optional persist?: boolean

Defined in: packages/core/src/drawing/manager.ts:218


points? ​

optional points?: DrawingPoint[]

Defined in: packages/core/src/drawing/manager.ts:213


selectable? ​

optional selectable?: boolean

Defined in: packages/core/src/drawing/manager.ts:217


style? ​

optional style?: DrawingStyle

Defined in: packages/core/src/drawing/manager.ts:214


text? ​

optional text?: string

Defined in: packages/core/src/drawing/manager.ts:215


visibleOn? ​

optional visibleOn?: IntervalRange[] | null

Defined in: packages/core/src/drawing/manager.ts:229

Intervals the drawing shows on; null or [] shows it on every interval.


zIndex? ​

optional zIndex?: number

Defined in: packages/core/src/drawing/manager.ts:222