Interface BrowserWindowFactory

wrapSync

createWindow

• createWindow(options): Promise<BrowserWindowModule>

• Create a new browser window.

  import * as WorkspacePlatform from '@openfin/workspace-platform';
  
  const workspacePlatform = WorkspacePlatform.getCurrentSync();
  const layout = {
       content: [
           {
               type: 'stack',
               content: [
                   {
                       type: 'component',
                       componentName: 'view',
                       componentState: {
                           name: 'myViewName',
                           url: 'http://google.com'
                       }
                   }
               ]
            }
       ]
  };
  const page = {
       title: 'myPageTitle',
       pageId: 'myPageId',
       layout
  };
  const options: BrowserCreateWindowRequest = {
       workspacePlatform: {
           pages: [page],
           title: 'My Window Title',
           favicon: 'https://google.com/favicon.ico',
           disableMultiplePages: true,  // disable page functionality for the window
           toolbarOptions: {  // configure the set of tray icons for the window
               buttons: [
                   {  // adding a custom tray icon for the window
                       type: BrowserButtonType.Custom,
                       tooltip: 'Sample Tray Icon',
                       disabled: false,
                       iconUrl: 'https://www.openfin.co/favicon.ico',
                       action: {
                           // This action needs to be registed in customActions property in the call WorkspacePlatform.init
                           id: 'sample-trayicon-custom-action',
                           customData: {
                               message: 'Clicked on custom Toolbar button'
                           }
                       }
                   },
                   {
                       type: BrowserButtonType.ShowHideTabs
                   },
                   {
                       type: BrowserButtonType.ColorLinking
                   },
                   {
                       type: BrowserButtonType.PresetLayouts
                   },
                   {
                       type: BrowserButtonType.SaveMenu
                   }
              ]
           }
           windowStateButtonOptions: {
           //configure the set of icons for setting window states
               buttons: [
                    {   // adding a custom window state icon for the window
                        id: 'windowState123',
                        type: BrowserButtonType.Custom,
                        tooltip: 'Sample Window State button',
                        disabled: false,
                        iconUrl: 'https://www.openfin.co/favicon.ico',
                        action: {
                           // This action needs to be registered in customActions property in the call WorkspacePlatform.init
                            id: 'sample-window-state-custom-action',
                            customData: {
                                message: 'Clicked on custom Window State button'
                            }
                        }
                    },
                    {  // override tooltip and icon URL for standard Maximise button
                       type: BrowserButtonType.Maximise,
                       tooltip: overrideWindowStateIcons ? 'Studio Maximise' : undefined,
                       iconUrl: overrideWindowStateIcons ? 'https://www.openfin.co/favicon.ico' : undefined
                    },
                    {
                       type: BrowserButtonType.Minimise
                    },
                    {
                       type: BrowserButtonType.Close
                    }
               ]
           }
       }
  };
  const window = await workspacePlatform.Browser.createWindow(options);
  Copy

  Parameters

  • options: BrowserCreateWindowRequest

    the browser window creation options

  Returns Promise<BrowserWindowModule>

getAllAttachedPages

• getAllAttachedPages(): Promise<AttachedPage[]>

• Get a list of all pages that are attached to any running browser window.

  import * as WorkspacePlatform from '@openfin/workspace-platform';
  
  const workspacePlatform = WorkspacePlatform.getCurrentSync();
  const attachedPages = await workspacePlatform.Browser.getAllAttachedPages();
  Copy

  Returns Promise<AttachedPage[]>

getAllWindows

• getAllWindows(): Promise<BrowserWindowModule[]>

• Get all the Browser Windows that are running in the Workspace Platform.

  import * as WorkspacePlatform from '@openfin/workspace-platform';
  
  const workspacePlatform = WorkspacePlatform.getCurrentSync();
  const windows = await workspacePlatform.Browser.getAllWindows();
  Copy

  Returns Promise<BrowserWindowModule[]>

getLastFocusedWindow

• getLastFocusedWindow(): Promise<Identity_5>

• Get the identity of the last focused Browser window.

  import * as WorkspacePlatform from '@openfin/workspace-platform';
  
  const workspacePlatform = WorkspacePlatform.getCurrentSync();
  const windowIdentity = await workspacePlatform.Browser.getLastFocusedWindow();
  Copy

  Returns Promise<Identity_5>

getUniquePageTitle

• getUniquePageTitle(title?): Promise<string>

• Get a unique title for a page.

  import * as WorkspacePlatform from '@openfin/workspace-platform';
  
  const workspacePlatform = WorkspacePlatform.getCurrentSync();
  const uniqueTitle = await workspacePlatform.Browser.getUniquePageTitle('myTitle');
  Copy

  Parameters

  • Optional title: string

    a prefix for the title.

  Returns Promise<string>