NavigationHelpButton

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


Name Type Default Description
options.container Element | String The DOM element or ID that will contain the widget.
options.instructionsInitiallyVisible Boolean false optional True if the navigation instructions should initially be visible; otherwise, false.
Throws:
  • DeveloperError : Element with id "container" does not exist in the document.
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'
});
Source: Widgets/NavigationHelpButton/NavigationHelpButton.js, line 42

Members

container :Element

Gets the parent container.
Source: Widgets/NavigationHelpButton/NavigationHelpButton.js, line 127

viewModel :NavigationHelpButtonViewModel

Gets the view model.
Source: Widgets/NavigationHelpButton/NavigationHelpButton.js, line 139

Methods

destroy()

Destroys the widget. Should be called if permanently removing the widget from layout.
Source: Widgets/NavigationHelpButton/NavigationHelpButton.js, line 159

isDestroyed() → Boolean

Returns:
true if the object has been destroyed, false otherwise.
Source: Widgets/NavigationHelpButton/NavigationHelpButton.js, line 150