Class FooterBarApi

API to manage tabs on the footer bar component.

Index

Constructors

Methods

createTab getTabContent removeTab selectTab showTabButton

Constructors

constructor

new FooterBarApi(uiController: UIController): FooterBarApi
Instantiates a FooterBarApi class.
Parameters
- uiController: UIController
  The UI controller this footer bar api belongs to
Returns FooterBarApi
- Defined in packages/geoview-core/src/core/components/footer-bar/footer-bar-api.ts:31

Methods

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
- Defined in packages/geoview-core/src/core/components/footer-bar/footer-bar-api.ts:41

getTabContent

getTabContent(id: string): FooterTabContent | undefined
Gets the content entry for a tab by id.
Parameters
- id: string
  The tab id to look up
Returns FooterTabContent | undefined
The tab content entry, or undefined if not registered
- Defined in packages/geoview-core/src/core/components/footer-bar/footer-bar-api.ts:79

removeTab

removeTab(id: string): void
Removes a tab by id.
Parameters
- id: string
  The id of the tab to be removed
Returns void
- Defined in packages/geoview-core/src/core/components/footer-bar/footer-bar-api.ts:63

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
Deprecated
Legacy support. Should use uiController.setActiveFooterBarTab directly instead.
- Defined in packages/geoview-core/src/core/components/footer-bar/footer-bar-api.ts:100

showTabButton

showTabButton(id: string): void
Shows a tab by id.
Parameters
- id: string
  The id of the tab to be shown
Returns void
Deprecated
Legacy support. Should use uiController.showTabButton directly instead.
- Defined in packages/geoview-core/src/core/components/footer-bar/footer-bar-api.ts:89