Class ColumnOrRow

A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.

Hierarchy

LayoutNode
- ColumnOrRow

Index

Properties

Methods

createAdjacentStack exists getAdjacentStacks getContent getParent isRoot getEntity

Properties

`Readonly` type

type: "row" | "column"

The type of this ColumnOrRow. Either 'row' or 'column'.

Methods

createAdjacentStack

createAdjacentStack(views: Partial<ViewOptions>[], options: {
position?: LayoutPosition;
}): Promise<TabStack>
Parameters
- views: Partial<ViewOptions>[]
- options: {
  position?: LayoutPosition;
  }
  - Optional position?: LayoutPosition
Returns Promise<TabStack>

Inherited from LayoutNode.createAdjacentStack

exists

exists(): Promise<boolean>
Returns Promise<boolean>

Inherited from LayoutNode.exists

getAdjacentStacks

getAdjacentStacks(edge: LayoutPosition): Promise<TabStack[]>
Parameters
- edge: LayoutPosition
Returns Promise<TabStack[]>

Inherited from LayoutNode.getAdjacentStacks

getContent

getContent(): Promise<(ColumnOrRow | TabStack)[]>
Retrieves a list of all content items belonging to this ColumnOrRow in order of appearance.

Returns
Resolves with a list containing ColumnOrRow and TabStack items belonging to this ColumnOrRow.

Tutorial
ColumnOrRow.getContent

Returns Promise<(ColumnOrRow | TabStack)[]>

getParent

getParent(): Promise<undefined | ColumnOrRow | TabStack>
Returns Promise<undefined | ColumnOrRow | TabStack>

Inherited from LayoutNode.getParent

isRoot

isRoot(): Promise<boolean>
Returns Promise<boolean>

Inherited from LayoutNode.isRoot

`Static` getEntity

getEntity(definition: LayoutEntityDefinition<LayoutEntityTypes>, client: LayoutEntitiesClient): ColumnOrRow | TabStack
Parameters
- definition: LayoutEntityDefinition<LayoutEntityTypes>
- client: LayoutEntitiesClient
Returns ColumnOrRow | TabStack

Inherited from LayoutNode.getEntity

Generated using TypeDoc