charton

Appearance

charton API

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

Abstract Interface: OptionsHandle<O, W> ​

Defined in: packages/core/src/annotations/lines.ts:42

Handle shared by price and trade lines, time bands, price zones and text labels.

Extended by ​

Type Parameters ​

O ​

O extends object

W ​

W extends HandleOwner

Properties ​

owner ​

protected readonly owner: W

Defined in: packages/core/src/annotations/lines.ts:48

Accessors ​

options ​

Get Signature ​

get options(): Readonly<O>

Defined in: packages/core/src/annotations/lines.ts:54

Returns ​

Readonly<O>

visible ​

Get Signature ​

get visible(): boolean

Defined in: packages/core/src/annotations/lines.ts:58

Returns ​

boolean

Methods ​

applyOptions() ​

applyOptions(patch): void

Defined in: packages/core/src/annotations/lines.ts:63

Merge new options and redraw. Throws on invalid options, leaving the current ones.

Parameters ​

patch ​

Partial<O>

Returns ​

void

check() ​

abstract protected check(options): void

Defined in: packages/core/src/annotations/lines.ts:82

Parameters ​

options ​

O

Returns ​

void

optionsChanged() ​

protected optionsChanged(): void

Defined in: packages/core/src/annotations/lines.ts:88

Drop caches derived from the options.

Returns ​

void

prepare() ​

protected prepare(_options): void

Defined in: packages/core/src/annotations/lines.ts:85

Hook between checking and committing new options; may throw to reject them.

Parameters ​

_options ​

O

Returns ​

void

remove() ​

remove(): void

Defined in: packages/core/src/annotations/lines.ts:78

Returns ​

void

setVisible() ​

setVisible(visible): void

Defined in: packages/core/src/annotations/lines.ts:73

Hide or show it; its options are kept.

Parameters ​

visible ​

boolean

Returns ​

void