Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Page

Provides configuration options for a set of Workspace Views. An array of Page objects is a required option of the workspacePlatform property of the {@link BrowserCreateWindowRequest} interface.

 const page: Page = {
     title: 'myPageTitle',
     pageId: 'myPageID',
     layout: {
         content: [
             {
                 type: 'stack',
                 content: [
                     {
                         type: 'component',
                         componentName: 'view',
                         componentState: {
                             name: 'myViewName',
                             url: 'http://google.com'
                         }
                     }
                 ]
             }
         ]
     }
};

Hierarchy

  • Page

Index

Properties

Properties

Optional closeButton

closeButton?: { disabled?: boolean; hidden?: boolean }

Used to manipulate behaviour of a close button on a page tab. If undefined, then close button is visible and actionable. If either property true, this page tab's context menu will disable its 'Close Page' option.

Type declaration

  • Optional disabled?: boolean
  • Optional hidden?: boolean

Optional customData

customData?: any

Optional property to attach custom metadata to the page object, such as version or timestamp. Must be serializable.

Optional description

description?: string

An optional UI friendly description of the page.

Optional iconUrl

iconUrl?: string

Icon that appears on a page tab if there are no unsaved changes. If 'undefined', default icon will appear.

Optional isLocked

isLocked?: boolean

True if the page is locked.

Optional isReadOnly

isReadOnly?: boolean

True if the page is read only. In this state, the page is locked and cannot be unlocked.

layout

layout: PageLayout

The layout of the page.

pageId

pageId: string

The unique ID of the page.

Optional panels

panels?: PanelConfig[]

Used to configure fixed views on the edges of the browser window. Only one panel per side is supported.

title

title: string

A UI friendly title for the page.

Optional tooltip

tooltip?: string

A optional UI friendly tooltip for the page.

Optional unsavedIconUrl

unsavedIconUrl?: string

Icon that appears on a page tab if there are unsaved changes (dirty state). If 'undefined', default icon will appear.

Generated using TypeDoc