new PSVNavBarButton( navbar )

Description

Navigation bar button class

Parameters
Name Type Description
navbar module:components.PSVNavBar

Members


<static, readonly> icon :string

SVG icon name injected in the button

Details
string

<static, readonly> iconActive :string

SVG icon name injected in the button when it is active

Details
string

<static, readonly> id :string

Unique identifier of the button

Details
string

<readonly> container :HTMLElement

Details
HTMLElement

<readonly> enabled :boolean

State of the button

Details
boolean

<readonly> id :string

Unique identifier of the button

Details
string

<readonly> parent :PhotoSphereViewer|module:components.PSVComponent


<readonly> psv :PhotoSphereViewer


<readonly> visible :boolean

Visibility of the component

Methods


<protected> create()

Creates the button


<protected> destroy()

Destroys the button


disable()

Disables the button


enable()

Enables the button


<protected> hide()

Hides the component


<protected> show()

Displays the component


supported() → {boolean|Promise.<boolean>}

Checks if the button can be displayed

Returns

toggleActive( [ active ] )

Changes the active state of the button

Parameters
Name Type Attributes Description
active boolean <optional>

forced state