Class ElevationService

Defines a service class that talks directly to Google servers for requesting elevation data.

Access by calling const {ElevationService} = await google.maps.importLibrary("elevation"). See https://developers.google.com/maps/documentation/javascript/libraries.

Hierarchy

ElevationService

Index

Constructors

constructor

Methods

Constructors

constructor

new ElevationService(): ElevationService

Returns ElevationService

Methods

getElevationAlongPath

getElevationAlongPath(request: PathElevationRequest, callback?: ((a: null | ElevationResult[], b: ElevationStatus) => void)): Promise<PathElevationResponse>

Makes an elevation request along a path, where the elevation data are returned as distance-based samples along that path.

Parameters
- request: PathElevationRequest
- Optional callback: ((a: null | ElevationResult[], b: ElevationStatus) => void)
  - - (a: null | ElevationResult[], b: ElevationStatus): void
    - Parameters
      - a: null | ElevationResult[]
      - b: ElevationStatus
      Returns void
Returns Promise<PathElevationResponse>

getElevationForLocations

getElevationForLocations(request: LocationElevationRequest, callback?: ((a: null | ElevationResult[], b: ElevationStatus) => void)): Promise<LocationElevationResponse>

Makes an elevation request for a list of discrete locations.

Parameters
- request: LocationElevationRequest
- Optional callback: ((a: null | ElevationResult[], b: ElevationStatus) => void)
  - - (a: null | ElevationResult[], b: ElevationStatus): void
    - Parameters
      - a: null | ElevationResult[]
      - b: ElevationStatus
      Returns void
Returns Promise<LocationElevationResponse>

Generated using TypeDoc