Documentation / @zerotal/admin / index / ChartWidget

Class: ChartWidget

Defined in: admin/src/widgets/Widget.ts:146

Extends

PollableWidget

Constructors

Constructor

new ChartWidget(title, resolver): ChartWidget

Defined in: admin/src/widgets/Widget.ts:152

Parameters

title

string

resolver

ChartResolver

Returns

ChartWidget

Overrides

PollableWidget.constructor

Methods

poll()

poll(interval): this

Defined in: admin/src/widgets/Widget.ts:36

Re-render this widget every interval — "10s", "1m". Costs a query per tick per viewer, so reach for it on dashboards that are watched, not on every widget by habit.

Parameters

interval

string

Returns

this

Inherited from

PollableWidget.poll

key()

key(key): this

Defined in: admin/src/widgets/Widget.ts:48

Name this widget, so a saved dashboard layout can refer to it.

Worth setting on any widget whose title might change: a layout keyed by title silently resets the moment somebody rewords a heading, whereas an explicit key survives it.

Parameters

key

string

Returns

this

Inherited from

PollableWidget.key

widgetKey()

widgetKey(index): string

Defined in: admin/src/widgets/Widget.ts:54

The identity a layout stores. Falls back to the title, then the position.

Parameters

index

number

Returns

string

Inherited from

PollableWidget.widgetKey

columns()

columns(n): this

Defined in: admin/src/widgets/Widget.ts:159

Grid span on the dashboard (1–4).

Parameters

n

number

Returns

this

height()

height(px): this

Defined in: admin/src/widgets/Widget.ts:165

Canvas height in pixels.

Parameters

px

number

Returns

this

data()

data(): Promise<ChartData>

Defined in: admin/src/widgets/Widget.ts:170

Returns

Promise<ChartData>