Class AppBarApi

constructor

• new AppBarApi(mapId: string): AppBarApi

  Instantiates an AppBarApi class.

  Parameters

  • mapId: string

    The map id this AppBarApi belongs to

  Returns AppBarApi

buttons

mapId

createAppbarPanel

• createAppbarPanel(
      buttonProps: IconButtonPropsExtend,
      panelProps: TypePanelProps,
  ): TypeButtonPanel | null

  Creates a button on the app-bar that will open a panel

  Parameters

  • buttonProps: IconButtonPropsExtend

    Button properties (icon, tooltip)

  • panelProps: TypePanelProps

    Panel properties (icon, title, content)

  Returns TypeButtonPanel | null

  The created panel

getActiveAppBarTab

• getActiveAppBarTab(): ActiveAppBarTabType

  Selects a tab by id and tab group

  Returns ActiveAppBarTabType

  The active app bar tab info.

getAppBarButtonPanelById

• getAppBarButtonPanelById(buttonPanelId: string): TypeButtonPanel | null

  Gets a button panel from the app-bar by using it's id

  Parameters

  • buttonPanelId: string

    The id of the button panel to get

  Returns TypeButtonPanel | null

  The button panel

offAppBarCreated

• offAppBarCreated(callback: AppBarCreatedDelegate): void

  Unregisters an event handler for AppBar created events.

  Parameters

  • callback: AppBarCreatedDelegate

    The callback to stop being called whenever the event is emitted.

  Returns void

offAppBarRemoved

• offAppBarRemoved(callback: AppBarRemovedDelegate): void

  Unregisters an event handler for AppBar removed events.

  Parameters

  • callback: AppBarRemovedDelegate

    The callback to stop being called whenever the event is emitted.

  Returns void

onAppBarCreated

• onAppBarCreated(callback: AppBarCreatedDelegate): void

  Registers an event handler for AppBar created events.

  Parameters

  • callback: AppBarCreatedDelegate

    The callback to be executed whenever the event is emitted.

  Returns void

onAppBarRemoved

• onAppBarRemoved(callback: AppBarRemovedDelegate): void

  Registers an event handler for AppBar removed events.

  Parameters

  • callback: AppBarRemovedDelegate

    The callback to be executed whenever the event is emitted.

  Returns void

removeAppbarPanel

• removeAppbarPanel(buttonPanelId: string): void

  Removes an app-bar panel using an id

  Parameters

  • buttonPanelId: string

    The id of the panel to remove

  Returns void

selectTab

• selectTab(tabId: string, open?: boolean, isFocusTrapped?: boolean): void

  Selects a tab by id

  Parameters

  • tabId: string

    The id of the tab to be selected

  • open: boolean = true

    Open (true) or closed (false) panel: default = true

  • isFocusTrapped: boolean = true

  Returns void