Constructor
new ColumnOrRow()
Methods
createAdjacentStack(views, options) → {Promise.<TabStack>}
Given a list of view creation options or references and a layout position, creates a TabStack adjacent to the given ColumnOrRow
Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged. This means the views you pass to createAdjacentStack() may not render in the order given by the array. Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
Parameters:
| Name | Type | Description |
|---|---|---|
views |
View~options | List of identities or view creation options of the views to include in the stack |
options |
StackCreationOptions | Creation options. |
- Tutorials:
Returns:
The created TabStack
- Type
- Promise.<TabStack>
exists() → {Promise.<boolean>}
Determines if this ColumnOrRow exists.
- Tutorials:
Returns:
Resolves true if the TabStack exists, or false if it has been destroyed.
- Type
- Promise.<boolean>
getAdjacentStacks(edge) → {Promise.<Array.<TabStack>>}
Returns all the adjacent stacks that share an edge with the given ColumnOrRow.
Parameters:
| Name | Type | Description |
|---|---|---|
edge |
LayoutPosition | Edge to check for any adjacent stacks. |
- Tutorials:
Returns:
- Type
- Promise.<Array.<TabStack>>
getContent() → {Promise.<Array.<(ColumnOrRow|TabStack)>>}
Retrieves a list of all content items belonging to this ColumnOrRow in order of appearance.
- Tutorials:
Returns:
Resolves with a list containing ColumnOrRow and TabStack items belonging to this ColumnOrRow.
- Type
- Promise.<Array.<(ColumnOrRow|TabStack)>>
getParent() → {Promise.<(ColumnOrRow|undefined)>}
Retrieves the parent ColumnOrRow of this ColumnOrRow, if one exists.
- Tutorials:
Returns:
Promise resolving with the ColumnOrRow that contains this item, or undefined if this ColumnOrRow does not exist or is the root content item.
- Type
- Promise.<(ColumnOrRow|undefined)>
isRoot() → {Promise.<boolean>}
Determines if this ColumnOrRow is the top level content item in the current layout.
- Tutorials:
Returns:
Resolves true if this TabStack is the top level content item, or false if it is not.
- Type
- Promise.<boolean>