charton

Appearance

charton API

charton API / @chart-on/ui / index / DrawingSettingsContext

Interface: DrawingSettingsContext ​

Defined in: ui/src/drawing-settings.ts:354

What DrawingSettingsOptions.headerControl gets for the dialog of a drawing with style fields.

Properties ​

chart ​

readonly chart: Chart

Defined in: ui/src/drawing-settings.ts:355

host ​

readonly host: HTMLElement

Defined in: ui/src/drawing-settings.ts:357

The element the dialog opens in, for dialogs of the control's own.

type ​

readonly type: string

Defined in: ui/src/drawing-settings.ts:359

The drawing's tool type.

Methods ​

setStyle() ​

setStyle(values): boolean

Defined in: ui/src/drawing-settings.ts:368

Fill style fields in, previewed like an edit: Ok commits them, Cancel drops them. Fields the form does not show, or would refuse (such as a number out of range or an unknown choice), are left out. Returns whether any field was filled in; false once the dialog has closed.

Parameters ​

values ​

FormValues

Returns ​

boolean

style() ​

style(): FormValues

Defined in: ui/src/drawing-settings.ts:361

The style fields (the Style and Levels tabs) with the values the form shows now.

Returns ​

FormValues