charton

Appearance

charton API

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

Class: TimeBand ​

Defined in: packages/core/src/annotations/zones.ts:105

Handle returned by chart.annotations.addTimeBand.

Extends ​

Constructors ​

Constructor ​

new TimeBand(options, owner): TimeBand

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

Parameters ​

options ​

TimeBandOptions

owner ​

ZoneOwner

Returns ​

TimeBand

Inherited from ​

ZoneHandle<TimeBandOptions>.constructor

Properties ​

owner ​

protected readonly owner: ZoneOwner

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

Inherited from ​

ZoneHandle.owner

Accessors ​

options ​

Get Signature ​

get options(): Readonly<O>

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

Returns ​

Readonly<O>

Inherited from ​

ZoneHandle.options

visible ​

Get Signature ​

get visible(): boolean

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

Returns ​

boolean

Inherited from ​

ZoneHandle.visible

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

Inherited from ​

ZoneHandle.applyOptions

check() ​

protected check(o): void

Defined in: packages/core/src/annotations/zones.ts:106

Parameters ​

o ​

TimeBandOptions

Returns ​

void

Overrides ​

ZoneHandle.check

optionsChanged() ​

protected optionsChanged(): void

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

Drop caches derived from the options.

Returns ​

void

Inherited from ​

ZoneHandle.optionsChanged

prepare() ​

protected prepare(next): void

Defined in: packages/core/src/annotations/zones.ts:95

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

Parameters ​

next ​

TimeBandOptions

Returns ​

void

Inherited from ​

ZoneHandle.prepare

remove() ​

remove(): void

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

Returns ​

void

Inherited from ​

ZoneHandle.remove

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

Inherited from ​

ZoneHandle.setVisible