Class ChartObjects

Shared object operations for widgets and custom terminals. No DOM is created.

Index

Constructors

Methods

destroy focus get list openSettings refresh register remove select setLocked setVisible subscribe

Constructors

constructor

new ChartObjects(chart: Chart, options?: ChartObjectsOptions): ChartObjects
Parameters
- chart: Chart
- options: ChartObjectsOptions = {}
Returns ChartObjects
- Defined in src/model/chart-objects.ts:107

Methods

destroy

destroy(): void
Detach this observer and its providers, leaving chart objects in place.

Returns void
- Defined in src/model/chart-objects.ts:311

focus

focus(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in src/model/chart-objects.ts:215

get

get(id: string): undefined | ChartObjectSnapshot
Parameters
- id: string
Returns undefined | ChartObjectSnapshot
- Defined in src/model/chart-objects.ts:128

list

list(): readonly ChartObjectSnapshot[]
Current immutable inventory, also refreshed for hosts with unsignalled provider state.

Returns readonly ChartObjectSnapshot[]
- Defined in src/model/chart-objects.ts:127

openSettings

openSettings(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in src/model/chart-objects.ts:214

refresh

refresh(): void
Re-read explicitly registered host state without installing a polling timer.

Returns void
- Defined in src/model/chart-objects.ts:167

register

register(provider: ChartObjectProvider): () => void
Provider IDs receive a custom: prefix and cannot replace built-in objects.
Parameters
- provider: ChartObjectProvider
Returns () => void
- Defined in src/model/chart-objects.ts:139

remove

remove(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in src/model/chart-objects.ts:213

select

select(id: null | string, additive?: boolean): boolean
Parameters
- id: null | string
- additive: boolean = false
Returns boolean
- Defined in src/model/chart-objects.ts:189

setLocked

setLocked(id: string, on: boolean): boolean
Parameters
- id: string
- on: boolean
Returns boolean
- Defined in src/model/chart-objects.ts:212

setVisible

setVisible(id: string, on: boolean): boolean
Parameters
- id: string
- on: boolean
Returns boolean
- Defined in src/model/chart-objects.ts:211

subscribe

subscribe(
listener: (objects: readonly ChartObjectSnapshot[]) => void,
): () => void
Delivers current state immediately, then only inventory changes.
Parameters
- listener: (objects: readonly ChartObjectSnapshot[]) => void
Returns () => void
- Defined in src/model/chart-objects.ts:131