@interopio/browser API Reference

Workspace-specific options.

Properties (26)

Property Type Default Required Description
allowDrop⚓︎ boolean true x

Controls the users ability to drop outside windows in the workspace
allowDropBottom⚓︎ boolean true x

Controls the users ability to drop windows in the bottom-most zone of the workspace
allowDropLeft⚓︎ boolean true x

Controls the users ability to drop windows in the left-most zone of the workspace
allowDropRight⚓︎ boolean true x

Controls the users ability to drop windows in the right-most zone of the workspace
allowDropTop⚓︎ boolean true x

Controls the users ability to drop windows in the top-most zone of the workspace
allowExtract⚓︎ boolean true x

Controls the users ability to extract windows from the workspace
allowSplitters⚓︎ boolean true x

Prevents the splitters for being draggable, so the windows cannot be resized
allowSystemHibernation⚓︎ boolean true x

If true, will allow the Workspace to be hibernated via the platform configuration. This setting doesn't apply to programmatic hibernation via the hibernate() method of a Workspace instance.
allowWindowReorder⚓︎ boolean true x

Control the users ability to reorder windows in the workspace
allowWorkspaceTabExtract⚓︎ boolean true x

Controls whether a workspace tab can be extracted from the frame. Available only in io.Connect Desktop.
allowWorkspaceTabReorder⚓︎ boolean true x

Controls whether a workspace tab can be reordered in the frame
icon⚓︎ string x x

Sets the icon related for the workspace. The icon will be used for example for pinned workspaces.
isPinned⚓︎ boolean false x

Controls whether the workspace will be opened in a pinned or in a normal state
isSelected⚓︎ boolean true x

Controls whether the workspace will be focused or not in the frame when opened
loadStrategy⚓︎ LoadingStrategy x x

Controls when the windows inside this workspace should load when the workspace is created or restored
noTabHeader⚓︎ boolean false x

Provides the opportunity to open a workspace with no tab header
position⚓︎ number x x

Position of the workspace in relation to it's siblings in the frame.
positionIndex⚓︎ number x x

Specifies the position of the Workspace within the Frame instance. This index is ignored by the init() method for initializing an empty Frame.
reuseWorkspaceId⚓︎ string x x

Used for replacing the specified workspace instead of creating a new one
showAddWindowButtons⚓︎ boolean true x

Controls the visibility of all the add window buttons (the ones with the plus icon) located in the group headers
showCloseButton⚓︎ boolean true x

Controls the visibility of the close button located in the workspaces tab
showEjectButtons⚓︎ boolean true x

Controls the visibility of all eject buttons located in the groups' headers
showSaveButton⚓︎ boolean true x

Controls the visibility of the save workspace button located in the workspace tab
showWindowCloseButtons⚓︎ boolean true x

Controls the visibility of all close button located in the windows' tab elements
title⚓︎ string x x

A title of the workspace.
windowDragMode⚓︎ "keepInside" | "autoEject" x x

Mode for dragging the windows that are part of the Workspace. If set to "autoEject" (available only in io.Connect Desktop), when the user drags a Workspace window, it will be ejected from the Workspace during the dragging operation and the user will be able to drop it back inside the Workspace, or out of the Workspace. If set to "keepInside", the window won't be ejected from the Workspace when being dragged and the user will be able to drop it only inside the Workspace.