Class: Navbar

Extends

• PSV.components.AbstractComponent

Members

children Array.<PSV.buttons.AbstractButton> packagereadonly inherited overrides

List of buttons of the navbar

container HTMLElement readonly inherited overrides

parent PSV.Viewer | PSV.components.AbstractComponent readonly inherited overrides

prop Object protected inherited overrides

Internal properties

Properties:

Name	Type	Description
visible	boolean	Visibility of the component

psv PSV.Viewer readonly inherited overrides

Reference to main controller

Methods

destroy () protected inherited overrides

Destroys the component

getButton (id, warnNotFound)PSV.buttons.AbstractButton

Returns a button by its identifier

Name	Type	Default	Description
id	string
warnNotFound	boolean	true	optional

Returns:

Type	Description
PSV.buttons.AbstractButton

hide () overrides

Hides the navbar

isVisible ()boolean inherited overrides

Checks if the component is visible

Returns:

Type	Description
boolean

refreshUi () package inherited overrides

Refresh UI

Must be be a very lightweight operation

setButtons (buttons)

Change the buttons visible on the navbar

Name	Type	Description
buttons	string | Array.<(string|PSV.NavbarCustomButton)>

Throws:

when a button is unknown

Type

PSV.PSVError

setCaption (html)

Sets the bar caption

Name	Type	Description
html	string

show () overrides

Shows the navbar

toggle (visible) inherited overrides

Displays or hides the component

Name	Type	Description
visible	boolean	optional forced state