Class ElevationProfileControl
Implements
- IControl
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
- options: ElevationProfileControlOptions = {}
Returns ElevationProfileControl
Properties
OptionalgetDefaultPosition
getDefaultPosition?: () => ControlPosition
Type Declaration
- (): ControlPosition
Returns ControlPosition
a control position, one of the values valid in addControl.
Methods
getContainer
Returns HTMLDivElement | undefined
hideProfile
Returns void
onAdd
Register a control on the map and give it a chance to register event listeners and resources. This method is called by Map#addControl internally.
Parameters
- map: Map
the Map this control will be added to
Returns HTMLElement
The control's container element. This should be created by the control and returned by onAdd without being attached to the DOM: the map will insert the control's element into the DOM as necessary.
- map: Map
onRemove
Unregister a control on the map and give it a chance to detach event listeners and resources. This method is called by Map#removeControl internally.
Returns void
setData
Parameters
- data: string | GeoJsonObject
Returns Promise<void>
showProfile
Returns void
Optionally provide a default position for this control. If this method is implemented and Map#addControl is called without the
positionparameter, the value returned by getDefaultPosition will be used as the control's position.