clean-jsdoc-theme TypeDoc APIv0.0.0

Widget

Source: parity.ts:40

A widget. Extends Base and implements Named.


Constructors

new Widget(id: string, name: string): Widget

Parameters

  • id (string)
  • name (string)

Returns

Widget

Hierarchy

Implements


Properties

id: string

readonly
parity.ts:18

Inherited from id

Primary identifier.

name: string

readonly
parity.ts:41

Implementation of name

Human-readable name.

Accessors

get label(): string

A getter accessor.

Methods

describe(): string

Overrides describe

Overrides Base.describe.

Returns

  • string

load(): Promise<void>

Load this widget's data asynchronously.

Returns

  • Promise<void>

toJSON(): { id: string }

Overrides toJSON

Serialize to a plain object.

Properties

  • id (string)

Returns

  • { id: string }