Class Element

source · [−]
Expand description

An on-screen element that shows up the one report

Constructors

source

new (id: string): Element

All elements have an id associated to encourage short unique ids for all elements.

Properties

Cached renders.

String of text shown on expand or on hover that gives more details.

Internal id used in filesystem refs and urls so no spaces or nasty chars please. Please set this yourself if possible.

Current state of the element.

Title, this should make it really clear what the element is about.

Methods

source

_init

source

(): Promise<void>

Overridable universal element initialization implementation.

source

_render

source

(renderer: Renderer): Promise<string>

Overridable render implementation. Results from this must not be cached.

source

_run

source

(): Promise<void>

Overridable universal elememnt execution implementation.

source

(): boolean

source

(): Element[]

source

(): Promise<void>

source

(renderer: Renderer): Promise<string>

User-facing render implementation.

source

(): Promise<void>

Universal method applicable to all elements for executing their functions. DO NOT OVERRIDE. Please override _run instead which is called internally.

source

(ctx: Context): Promise<void>

source

(description: string): Element

source

(title: string): Element