Rowinterface
An object describing a row type workspace box
Properties (20)
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| allowDrop⚓︎ | boolean | x | x | Indicates if dropping windows inside this box is allowed |
| allowSplitters⚓︎ | boolean | x | x | Indicates if dragging of splitters is allowed in the row |
| children⚓︎ | WorkspaceElement[] | x | A collection containing the immediate children of this box |
|
| frame⚓︎ | Frame | x | An object representing the frame containing this box |
|
| frameId⚓︎ | string | x | The unique string identifier of the frame containing this box |
|
| height⚓︎ | number | x | x | Returns the current height of the box, can be undefined if the API is used with old versions of Enterprise or Core |
| id⚓︎ | string | x | An unique string identifier of this box |
|
| isMaximized⚓︎ | boolean | x | x | Returns whether or not the box is maximized |
| isPinned⚓︎ | boolean | x | x | Indicates whether or not the row is pinned |
| maxHeight⚓︎ | number | x | x | Returns the maximum height of the box, calculated by the size constraints of the elements inside it |
| maximizationBoundary⚓︎ | boolean | x | x | If set to true any child that is maximized will have its width and height constricted to the current element's size |
| maxWidth⚓︎ | number | x | x | Returns the maximum width of the box, calculated by the size constraints of the elements inside it |
| minHeight⚓︎ | number | x | x | Returns the minimum height of the box, calculated by the size constraints of the elements inside it |
| minWidth⚓︎ | number | x | x | Returns the minimum width of the box, calculated by the size constraints of the elements inside it |
| parent⚓︎ | Workspace | WorkspaceBox | x | An object representing this box's parent |
|
| positionIndex⚓︎ | number | x | An number representing the positing of this box relative to it's siblings |
|
| type⚓︎ | "row" | x | x | |
| width⚓︎ | number | x | x | Returns the current width of the box, can be undefined if the API is used with old versions of Enterprise or Core |
| workspace⚓︎ | Workspace | x | An object representing the workspace containing this box |
|
| workspaceId⚓︎ | string | x | The unique string identifier of the workspace containing this box |
12 Methods
addColumn()⚓︎
(definition?: BoxDefinition | BoxBuilder) => Promise<Column>
Adds a new column box to this box.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| definition⚓︎ | BoxDefinition | BoxBuilder | x | An object describing the type of the requested builder, alongside other settings. |
addGroup()⚓︎
(definition?: BoxDefinition | BoxBuilder) => Promise<Group>
Adds a new group box to this box.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| definition⚓︎ | BoxDefinition | BoxBuilder | x | An object describing the type of the requested builder, alongside other settings. |
addRow()⚓︎
(definition?: BoxDefinition | BoxBuilder) => Promise<Row>
Adds a new row box to this box.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| definition⚓︎ | BoxDefinition | BoxBuilder | x | An object describing the type of the requested builder, alongside other settings. |
addWindow()⚓︎
(definition: WorkspaceWindowDefinition) => Promise<WorkspaceWindow>
Opens a new window inside this box and loads it's content.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| definition⚓︎ | WorkspaceWindowDefinition | An object describing the requested window. |
lock()⚓︎
(config?: RowLockConfig | ((config: RowLockConfig) => RowLockConfig)) => Promise<void>
Locks the row using a provided config object, which restricts various modification functionalities of the row
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| config⚓︎ | RowLockConfig | ((config: RowLockConfig) => RowLockConfig) | x | This can be either an object or a function. When the object is provided, it overrides all other lock properties. When a function is provided, it will be called with the current lock settings and it should return a lock config, which will override the current settings. The function is recommended in all cases where overriding of the settings is not desired. |
onLockConfigurationChanged()⚓︎
(callback: (config: RowLockConfig) => void) => Promise<Unsubscribe>
Notifies when the a change in the lock configuration of the row has been made
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| callback⚓︎ | (config: RowLockConfig) => void | Callback function to handle the event. Receives the new lock configuration as a parameter |
removeChild()⚓︎
(predicate: (child: WorkspaceElement) => boolean) => Promise<void>
Removes the first immediate child of this box which satisfies the predicate.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| predicate⚓︎ | (child: WorkspaceElement) => boolean | A filtering function (predicate) called for immediate child of this box. |
setHeight()⚓︎
(height: number) => Promise<void>
Sets a new height for the row
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| height⚓︎ | number | A required number which should be the new height of the row |
setMaximizationBoundary()⚓︎
(config: SetMaximizationBoundaryConfig) => Promise<void>
Changes whether the row is a maximizationBoundary
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| config⚓︎ | SetMaximizationBoundaryConfig | Object which specifies how the maximizationBoundary behavior should be changed |