Class Layout

Lends

Platform#Layout

Hierarchy

Base
- Layout

Index

Constructors

Properties

identity init wire

Accessors

Methods

applyPreset getConfig getRootItem replace replaceView

Constructors

constructor

new Layout(identity: Identity, wire: Transport<EntityType>): OpenFin.Layout
Parameters
- identity: Identity
- wire: Transport<EntityType>
Returns OpenFin.Layout

Overrides Base.constructor

Properties

identity

identity: Identity

init

init: ((options?: InitLayoutOptions) => Promise<OpenFin.Layout>)

Type declaration

- (options?: InitLayoutOptions): Promise<OpenFin.Layout>
- Parameters
  - Optional options: InitLayoutOptions
  Returns Promise<OpenFin.Layout>

wire

wire: Transport<EntityType>

Accessors

me

get me(): Identity
Returns Identity

Inherited from Base.me

Methods

applyPreset

applyPreset(options: PresetLayoutOptions): Promise<void>
Replaces a Platform window's layout with a preset layout arrangement using the existing Views attached to the window. The preset options are columns, grid, rows, and tabs.

Returns

Tutorial
Layout.applyPreset
Parameters
- options: PresetLayoutOptions
  
  Mandatory object with presetType property that sets which preset layout arrangement to use. The preset options are columns, grid, rows, and tabs.
Returns Promise<void>

getConfig

getConfig(): Promise<any>
Returns the configuration of the window's layout. Returns the same information that is returned for all windows in getSnapshot.

Returns

Tutorial
Layout.getConfig

Returns Promise<any>

getRootItem

getRootItem(): Promise<ColumnOrRow | TabStack>
Retrieves the top level content item of the layout.

Returns

Returns Promise<ColumnOrRow | TabStack>

replace

replace(layout: LayoutOptions): Promise<void>
Replaces a Platform window's layout with a new layout. Any views that were in the old layout but not the new layout will be destroyed.

Returns

Tutorial
Layout.replace
Parameters
- layout: LayoutOptions
  
  New layout to implement in the target window. Please see explanation of a layout here.
Returns Promise<void>

replaceView

replaceView(viewToReplace: Identity, newView: Partial<ViewOptions>): Promise<void>
Replaces the specified view with a view with the provided configuration. The old view is stripped of its listeners and either closed or attached to the provider window depending on detachOnClose view option.

Returns

Tutorial
Layout.replaceView
Parameters
- viewToReplace: Identity
  
  Identity of the view to be replaced
- newView: Partial<ViewOptions>
  
  Creation options of the new view.
Returns Promise<void>

Generated using TypeDoc