Interface Navbar

Navigation bar component

interface Navbar {
    container: HTMLElement;
    parent: Viewer | AbstractComponent;
    viewer: Viewer;
    destroy(): void;
    focusButton(id: string): void;
    getButton(id: string, warnNotFound?: boolean): AbstractButton;
    hide(): void;
    isVisible(): boolean;
    setButtons(buttons: (string | NavbarCustomButton)[]): void;
    setCaption(html: string): void;
    show(): void;
    toggle(visible?: boolean): void;
}

Hierarchy (View Summary)

AbstractComponent
- Navbar

Index

Properties

container parent viewer

Methods

destroy focusButton getButton hide isVisible setButtons setCaption show toggle

Properties

`Readonly`container

container: HTMLElement

Container element

`Protected` `Readonly`parent

parent: Viewer | AbstractComponent

`Protected` `Readonly`viewer

viewer: Viewer

Reference to main controller

Methods

destroy

destroy(): void
Destroys the component

Returns void
Inherited from AbstractComponent.destroy
- Defined in packages/core/src/components/AbstractComponent.ts:47

focusButton

focusButton(id: string): void
Try to focus a button, will focus the first button if the requested button does not exist.
Parameters
- id: string
Returns void
- Defined in packages/core/src/components/Navbar.ts:199

getButton

getButton(id: string, warnNotFound?: boolean): AbstractButton
Returns a button by its identifier
Parameters
- id: string
- warnNotFound: boolean = true
Returns AbstractButton
- Defined in packages/core/src/components/Navbar.ts:184

hide

hide(): void
Hides the navbar

Returns void
Overrides AbstractComponent.hide
- Defined in packages/core/src/components/Navbar.ts:122

isVisible

isVisible(): boolean
Checks if the component is visible

Returns boolean
Inherited from AbstractComponent.isVisible
- Defined in packages/core/src/components/AbstractComponent.ts:93

setButtons

setButtons(buttons: (string | NavbarCustomButton)[]): void
Change the buttons visible on the navbar
Parameters
- buttons: (string | NavbarCustomButton)[]
Returns void
- Defined in packages/core/src/components/Navbar.ts:131

setCaption

setCaption(html: string): void
Changes the navbar caption
Parameters
- html: string
Returns void
- Defined in packages/core/src/components/Navbar.ts:170

show

show(): void
Shows the navbar

Returns void
Overrides AbstractComponent.show
- Defined in packages/core/src/components/Navbar.ts:113

toggle

toggle(visible?: boolean): void
Displays or hides the component
Parameters
- visible: boolean = ...
Returns void
Inherited from AbstractComponent.toggle
- Defined in packages/core/src/components/AbstractComponent.ts:62