PanelStack

class

Back to Helios Web API

Kind

class

Source

src/ui/panels/PanelStack.js:29

Description

Collapsible stack of UI subpanels used by the optional Helios UI.

Signature

export class PanelStack {

Parameters

Name	Type	Attributes	Default	Description
options	Object	optional		Stack options.
|items	Array.<Object>	optional		Initial panel items.

Lifecycle

Creation, initialization, prewarming, cleanup, and renderer lifetime.

destroy()

Source: src/ui/panels/PanelStack.js:116

Manages destroy for the current instance.

Configuration

General configuration setters and compatibility helpers.

setStatus(id, status) → {this}

Source: src/ui/panels/PanelStack.js:108

Set the status setting.

Parameters

Name	Type	Attributes	Default	Description
id				Value passed to setStatus.
status				Value passed to setStatus.

Returns

This instance.

Type this

Utilities

Additional public helpers that do not belong to a narrower API area.

add(options) → {Object|this}

Source: src/ui/panels/PanelStack.js:38

Read or set the add setting.

Parameters

Name	Type	Attributes	Default	Description
options	Object			Options object for this operation.

Returns

Current add value when called without arguments; otherwise this instance for chaining.

Type Object|this

Example

helios.add({
  enabled: true,
});