Skip to main content

Interface: ChromePluginOf<TViewContext>

Defined in: api/plugin.ts:49

A plugin that is chrome and nothing else — timeShading(). It declares no Field, reserves no store and claims no edit hook. So it installs on the Gantt, and gantt.plugins reconfigures it live.

data?: never makes the wrong install site unrepresentable. GanttOptions.plugins takes this arm alone. So a plugin with a data half is a red squiggle in the editor, never a runtime discovery. It is the rule that keeps a shared scale off a Gantt that names preset.

Extends​

Type Parameters​

TViewContext​

TViewContext = unknown

Properties​

aggregators?​

optional aggregators?: undefined

Defined in: api/plugin.ts:61

data?​

optional data?: undefined

Defined in: api/plugin.ts:54

fields?​

optional fields?: undefined

Defined in: api/plugin.ts:59

Dataset-owned state, registered at construction (#496 grill round 3). Unrepresentable here for the same reason data?: never is: a chrome-only plugin has no data() to run them against. So a Field it named would install silently dropped, on the wrong site, with no error — GanttOptions.plugins never reads this member.

fieldTypes?​

optional fieldTypes?: undefined

Defined in: api/plugin.ts:60

hierarchySource?​

optional hierarchySource?: undefined

Defined in: api/plugin.ts:62

id​

id: string

Defined in: api/plugin.ts:34

Inherited from​

PluginIdentity.id

requires?​

optional requires?: readonly string[]

Defined in: api/plugin.ts:39

Plugin ids that must also be installed. Does not imply an order in the array: installation resolves setup order from requires alone, so [a, b] and [b, a] install identically. A required id nobody installs throws MissingPluginError. One list covers both halves (ADR 0019).

Inherited from​

PluginIdentity.requires

Methods​

view()​

view(ctx): void | Disposer

Defined in: api/plugin.ts:53

Variants, renderers, decorations, commands and keys. Runs once, as a Gantt mounts. It returns a Disposer for the plugin's own resources, or nothing at all (review P4). Every register* and every onDomEvent files its own removal in ctx.disposables.

Parameters​

ctx​

TViewContext

Returns​

void | Disposer