WorkspaceWindow

Layouts v1 API is deprecated and no longer supported as of OpenFin 16+. Please use Platform API instead.

Stores the state of a single window within a saved workspace.

Hierarchy

Index

Properties

Properties

bounds

bounds: Required<Bounds>

Physical position of the window, corresponds to Window.getBounds().

This object will always contain all fields, even those marked as optional in the getBounds() response.

frame

frame: boolean

If the window is framed or frameless, corresponds to WindowOptions.frame

isShowing

isShowing: boolean

If the window is currently visible, corresponds to Window.isShowing()

isTabbed

isTabbed: boolean

Indicates if the window is part of a tab group.

Tab group information is stored separately in Workspace.tabGroups. This flag indicates that the current window will be a part of that data.

name

name: string

Window identifier

state

state: WindowState

Window state, corresponds to WindowOptions.state

url

url: string

The full URL of the window, corresponds to the url property of Window.getInfo()

uuid

uuid: string

Application identifier

windowGroup

windowGroup: Identity[]

A list of windows currently docked to this one.

These groupings will be restored once all windows in the workspace have been re-created.