Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LayoutApp

Stores the state of a single application within a saved workspace.

Hierarchy

  • LayoutApp

Index

Properties

childWindows

childWindows: LayoutWindow[]

State of any child windows belonging to the application.

This will only be populated if the application integrates with the Layouts Service API. See generateLayout for details.

Optional customData

customData: CustomData

Applications can add their own custom data to a layout, to assist with correctly restoring the application when a saved layout is loaded.

To set customData, register a 'save' callback using onApplicationSave. The provided function will be called whenever a layout is generated, and any value returned by that function will be added to the layout here. This data will then be available within the restore callback registered via onAppRestore.

Optional initialOptions

initialOptions: undefined | object

Stores key information from the Application constructor parameters that were passed when this application was started.

This is only present if the application was started programatically. For applications started from a manifest, manifestUrl will be present instead.

mainWindow

mainWindow: LayoutWindow

State of the main window of the application.

Optional manifestUrl

manifestUrl: undefined | string

The URL of the manifest from which this application was started.

This is only present if the application was started from a manifest. For applications started programatically (using the OpenFin API), initialOptions will be present instead.

uuid

uuid: string

Application identifier