Class FooterBarApi

constructor

• new FooterBarApi(mapId: string): FooterBarApi

  Instantiates a FooterBarApi class.

  Parameters

  • mapId: string

    The map id this footer bar api belongs to

  Returns FooterBarApi

mapId

tabs

createTab

• createTab(tabProps: TypeTabs): void

  Creates a tab on the footer bar

  Parameters

  • tabProps: TypeTabs

    The properties of the tab to be created

  Returns void

offFooterTabCreated

• offFooterTabCreated(callback: FooterTabCreatedDelegate): void

  Unregisters an event handler for footerbar tab created events.

  Parameters

  • callback: FooterTabCreatedDelegate

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

  Returns void

offFooterTabRemoved

• offFooterTabRemoved(callback: FooterTabRemovedDelegate): void

  Unregisters an event handler for footerbar removed events.

  Parameters

  • callback: FooterTabRemovedDelegate

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

  Returns void

onFooterTabCreated

• onFooterTabCreated(callback: FooterTabCreatedDelegate): void

  Registers an event handler for footerbar tab created events.

  Parameters

  • callback: FooterTabCreatedDelegate

    The callback to be executed whenever the event is emitted.

  Returns void

onFooterTabRemoved

• onFooterTabRemoved(callback: FooterTabRemovedDelegate): void

  Registers an event handler for footerbar tab removed events.

  Parameters

  • callback: FooterTabRemovedDelegate

    The callback to be executed whenever the event is emitted.

  Returns void

removeTab

• removeTab(id: string): void

  Removes a tab by id.

  Parameters

  • id: string

    The id of the tab to be removed

  Returns void

selectTab

• selectTab(id: string): void

  Selects a tab by id, if the id is not a tab, the footer bar will close

  Parameters

  • id: string

    The id of the tab to be selected

  Returns void

showTab

• showTab(id: string): void

  Shows a tab by id.

  Parameters

  • id: string

    The id of the tab to be shown

  Returns void