GuideStore

Extends

• AbstractStore<GuideStoreListener>

Constructors

Constructor

new GuideStore(params): GuideStore;

Parameters

Parameter	Type
params	GuideStoreParams

Returns

GuideStore

Overrides

AbstractStore.constructor

Properties

Property	Type	Inherited from
anchoredOverlayStore	AnchoredOverlayStore	-
guideWorkflows	GuideWorkflow<GuideWorkflowOptions, ReactorComponentSelections, any>[]	-
logger	Logger	AbstractStore.logger
selectionDirectives	{ [id: string]: { directive: SelectIdentifier; resolve: (t) => any; }; }	-
visibleComponents	{ [id: string]: VisibleComponentIdentifier<any, ComponentSelection<any, ComponentSelectionListener>>; }	-
workspaceListener	() => any	-
workspaceStore	WorkspaceStore	-

Accessors

initialized

Inherited from

AbstractStore.initialized

---

name

Get Signature

get name(): string;

Returns

string

Inherited from

AbstractStore.name

---

selections

Methods

clearSelectionDirective()

clearSelectionDirective(directive): void;

Parameters

Parameter	Type
directive	SelectIdentifier

Returns

void

---

getControls()

getControls(): AbstractSetting<AbstractSettingOptions>[];

Returns

AbstractSetting<AbstractSettingOptions>[]

Inherited from

AbstractStore.getControls

---

getCurrentGuide()

getCurrentGuide<T>(): T;

Type Parameters

Type Parameter
T extends GuideWorkflow<GuideWorkflowOptions, ReactorComponentSelections, any>

Returns

T

---

init()

init(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractStore.init

---

registerGuideWorkflow()

registerGuideWorkflow(guide): void;

Parameters

Parameter	Type
guide	GuideWorkflow

Returns

void

---

registerVisibleComponent()

registerVisibleComponent(component): void;

Parameters

Parameter	Type
component	VisibleComponentIdentifier

Returns

void

---

select()

select(identifier): void;

Parameters

Parameter	Type
identifier	ComponentSelection

Returns

void

---

setLogger()

setLogger(logger): void;

Parameters

Parameter	Type
logger	Logger

Returns

void

Inherited from

AbstractStore.setLogger

---

unregisterVisibleComponent()

unregisterVisibleComponent(id): boolean;

Parameters

Parameter	Type
id	string

Returns

boolean

---

waitForReady()

waitForReady(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractStore.waitForReady