ElevationElement class
google.maps.elevation
. ElevationElement
class
An HTML element that visually displays elevation data. Set the element's path
property to show a graph of elevation along the path. To use the Elevation Element, enable the Places UI Kit API
for your project in the Google Cloud console.
Custom element: <gmp-elevation unit-system="imperial"></gmp-elevation>
This class extends HTMLElement
.
This class implements ElevationElementOptions
.
Access by calling const {ElevationElement} = await google.maps.importLibrary("elevation")
.See Libraries in the Maps JavaScript API
.
Constructor
ElevationElement([options])
Parameters:
-
options:ElevationElementOptions optional
Properties
Type:
Array
< LatLng
| LatLngLiteral
| LatLngAltitude
> optional
The path along which to show elevation data. Line segments will be interpolated in between the points of the array; even a small number of points will still produce a detailed elevation graph.
If only one point is provided, the widget will show the elevation number for that point.
If only one point is provided, the widget will show the elevation number for that point.
Type:
UnitSystem
optional
Determines if elevation will be shown in feet/miles or meters/km. If undefined, the widget will default to the preferred unit system for the region specified in the API loader.
HTML attribute:
-
<gmp-elevation unit-system="imperial"></gmp-elevation> -
<gmp-elevation unit-system="metric"></gmp-elevation>
Methods
addEventListener(type, listener[, options])
Parameters:
-
type:stringA case-sensitive string representing the event type to listen for. -
listener:EventListener | EventListenerObjectThe object that receives a notification. This must be a function or an object with the handleEvent method -
options:boolean| AddEventListenerOptions optionalSee options . Custom events only supportcaptureandpassive.
Return Value:
void
Sets up a function that will be called whenever the specified event is delivered to the target. See addEventListener
.
removeEventListener(type, listener[, options])
Parameters:
-
type:stringA string which specifies the type of event for which to remove an event listener. -
listener:EventListener | EventListenerObjectThe event listener of the event handler to remove from the event target. -
options:boolean| EventListenerOptions optionalSee options .
Return Value:
void
Removes an event listener previously registered with addEventListener from the target. See removeEventListener
.
ElevationElementOptions interface
google.maps.elevation
. ElevationElementOptions
interface
Options for ElevationElement
.
Properties |
|
|---|---|
path
optional
|
Type:
Array
< LatLng
| LatLngLiteral
> optional
|
unitSystem
optional
|
Type:
UnitSystem
optional
|
