Class: LabelPlacesButton

lucid.maps.places. LabelPlacesButton

Manages the button that controls the display of LIMBs.Specifically, this class is responsible for changing the button graphic to reflect the current state.

new LabelPlacesButton(options)

Parameters:
Name Type Description
options lucid.maps.places.LabelPlacesButtonOptions Configuration for the button.
Source:

Methods

getState() → {lucid.maps.places.LabelPlacesState}

Source:
Returns:
The current state of this button.
Type
lucid.maps.places.LabelPlacesState

hide()

Hide the button graphic.
Source:

setActive()

Set this button into the "active" state.
Source:
See:
  • The lucid.maps.places.LabelPlacesState enumeration.

setError()

Set this button into the "error encountered" state.
Source:
See:
  • The lucid.maps.places.LabelPlacesState enumeration.

setIdle()

Set this button into the "idle" state.
Source:
See:
  • The lucid.maps.places.LabelPlacesState enumeration.

setNoResults()

Set this button into the "no results found" state.
Source:
See:
  • The lucid.maps.places.LabelPlacesState enumeration.

setPending()

Set this button into the "pending results" state.
Source:
See:
  • The lucid.maps.places.LabelPlacesState enumeration.

show()

Make the button visible, after a call to hide.
Source:

Events

click

Indicates when the button is clicked.
Type:
  • object
Source: