Skip to content

store/workspaceLayout#

buildWorkspaceLayout()#

function buildWorkspaceLayout(startPage): IJsonModel;

Build a workspace layout with the given start page as the initial tab.

Parameters#

Parameter Type
startPage string

Returns#

IJsonModel


getPageDisplayName()#

function getPageDisplayName(label): string;

Get display name for a page label

Parameters#

Parameter Type
label any

Returns#

string


isSingletonPage()#

function isSingletonPage(pageLabel): boolean;

Check if a page type is singleton (only one tab allowed)

Parameters#

Parameter Type
pageLabel string

Returns#

boolean


DEFAULT_WORKSPACE_LAYOUT#

const DEFAULT_WORKSPACE_LAYOUT: IJsonModel;

Default workspace layout — single tabset with Home tab (matches legacy single-page behavior)


PAGE_DISPLAY_NAMES#

const PAGE_DISPLAY_NAMES: Record<string, string>;

Page labels to human-readable names (used as tab titles before i18n)


resetWorkspaceLayout#

const resetWorkspaceLayout: any;

selectWorkspaceLayout#

const selectWorkspaceLayout: (state) => IJsonModel;

Selector to get the workspace layout model

Parameters#

Parameter Type
state { workspaceLayout: WorkspaceLayoutState; }
state.workspaceLayout WorkspaceLayoutState

Returns#

IJsonModel


setWorkspaceLayout#

const setWorkspaceLayout: any;

SINGLETON_PAGES#

const SINGLETON_PAGES: Set<string>;

Pages that can only exist once in the workspace. Multi-instance pages (not in this set) can be opened in multiple tabs.


workspaceLayout#

const workspaceLayout: any;

WorkspaceLayoutState#

Properties#

model#

model: IJsonModel;

Serialized FlexLayout JSON model