IControlState
Defined in: js-api/src/u2core/protocol.ts:103
The typed, JSON-safe state block every Control fills — what generic bdd steps read.
Keys a kind does not have are absent (never null-filled). Read on demand, never cached.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
busy? | boolean | Async work in flight (dialog OK, async view, source load, wizard step). | js-api/src/u2core/protocol.ts:127 |
checked? | boolean | "mixed" | Checkbox / switch state. | js-api/src/u2core/protocol.ts:139 |
current? | string | Key of the current tab / wizard step / active breadcrumb. | js-api/src/u2core/protocol.ts:149 |
enabled | boolean | No aria-disabled="true" / disabled on the root. | js-api/src/u2core/protocol.ts:113 |
error? | string | null | The validation / error-row message the user sees; null when none. | js-api/src/u2core/protocol.ts:125 |
expanded? | boolean | Section / accordion pane / tree node / disclosure expanded. | js-api/src/u2core/protocol.ts:137 |
extra? | object | Free per-kind readings that do not deserve a typed key (a stat card's delta). Same contract as IWidgetStatus.values: number | string |
focused | boolean | document.activeElement is the root or inside it (or inside a popup this control owns). | js-api/src/u2core/protocol.ts:117 |
items? | IItemsState | Collection-like controls: every item, rendered or not. | js-api/src/u2core/protocol.ts:145 |
kind | string | The data-u2 value; for a platform DG.Widget without one, widget.type ('Scatter plot'). | js-api/src/u2core/protocol.ts:105 |
label? | string | The accessible name the user sees: label part, button text, dialog/section title. | js-api/src/u2core/protocol.ts:111 |
name? | string | Explicit identity — equal to data-u2-name. Never derived from a caption. | js-api/src/u2core/protocol.ts:109 |
open? | boolean | Popup / dropdown / dialog open. | js-api/src/u2core/protocol.ts:135 |
placeholder? | string | The hint the empty editor shows. | js-api/src/u2core/protocol.ts:133 |
pressed? | boolean | Toggle button state (aria-pressed). | js-api/src/u2core/protocol.ts:141 |
readOnly? | boolean | Shown but not editable (aria-readonly). | js-api/src/u2core/protocol.ts:119 |
required? | boolean | Must have a value (aria-required). | js-api/src/u2core/protocol.ts:121 |
selected? | boolean | For a selectable card / row-like control. | js-api/src/u2core/protocol.ts:143 |
selection? | string[] | Keys of the selected items (list, tree, table, multi-choice, chips, multi-select). | js-api/src/u2core/protocol.ts:147 |
tag? | string | The registry tag when the control was built from a spec node or its kind maps to one. | js-api/src/u2core/protocol.ts:107 |
text? | string | The value as displayed (the editor's text, the chosen option's caption, a checkbox 'true'/'false'). | js-api/src/u2core/protocol.ts:131 |
valid? | boolean | Inputs, forms, wizard steps: no validation message. | js-api/src/u2core/protocol.ts:123 |
value? | JsonValue | Raw value, JSON-projected (inputs; a range slider: [lo, hi]). | js-api/src/u2core/protocol.ts:129 |
visible | boolean | Connected, not under a hidden element, and laid out. | js-api/src/u2core/protocol.ts:115 |