Class: NavigationHelpButton

NavigationHelpButton

The NavigationHelpButton is a single button widget for displaying instructions for navigating the globe with the mouse.


Parameters:
Name Type Description
options Object Object with the following properties:
Properties
Name Type Attributes Default Description
container Element | String The DOM element or ID that will contain the widget.
instructionsInitiallyVisible Boolean <optional>
 false True if the navigation instructions should initially be visible; otherwise, false.
Source:
Throws:
Element with id "container" does not exist in the document.
Type
DeveloperError
Example
// In HTML head, include a link to the NavigationHelpButton.css stylesheet,
// and in the body, include: <div id="navigationHelpButtonContainer"></div>

var navigationHelpButton = new Cesium.NavigationHelpButton({
    container : 'navigationHelpButtonContainer'
});

Members

container :Element

Gets the parent container.
Type:
  • Element
Source:

viewModel :NavigationHelpButtonViewModel

Gets the view model.
Type:
Source:

Methods

destroy()

Destroys the widget. Should be called if permanently removing the widget from layout.
Source:

isDestroyed() → {Boolean}

Source:
Returns:
true if the object has been destroyed, false otherwise.
Type
Boolean