azure-maps-rest package
Azure Maps Web SDK Service Module service retirement. The Azure Maps Web SDK Service Module is now deprecated and will be retired on 9/30/26. To avoid service disruptions, we recommend migrating to use Azure Maps JavaScript REST SDK by 9/30/26. Please follow our instructions to migrate to Azure Maps JavaScript REST SDK.
Classes
| Aborter |
An aborter instance implements AbortSignal interface, can abort HTTP requests.
For an existing instance aborter:
|
| CarShareGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| ClosestPointGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| Credential |
Credential is an abstract class for Azure Maps HTTP requests signing. This class will host an credentialPolicyCreator factory which generates CredentialPolicy. |
| CredentialPolicy |
Credential policy used to sign HTTP(S) requests before sending. This is an abstract class. |
| GeofenceGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| LoggingPolicyFactory |
LoggingPolicyFactory is a factory class helping generating LoggingPolicy objects. |
| MapControlCredential |
MapControlCredential for sharing authentication with an |
| MapControlCredentialPolicy |
MapControlCredentialPolicy is a policy used to sign HTTP requests
with shared authentication from an |
| MapsURL |
A MapsURL represents a base URL class for SearchURL, RouteURL and etc. |
| MetroAreaGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| NearbyTransitGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| Pipeline |
A Pipeline class containing HTTP request policies. You can create a default Pipeline by calling MapsURL.newPipeline(). Or you can create a Pipeline with your own policies by the constructor of Pipeline. Refer to MapsURL.newPipeline() and provided policies as reference before implementing your customized Pipeline. |
| PointInPolygonGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| RealTimeArrivalsGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| RenderURL |
A RenderURL represents a URL to the Azure Maps render operations. |
| RetryPolicyFactory |
RetryPolicyFactory is a factory class helping generating RetryPolicy objects. |
| RouteGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| RouteRangeGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| RouteURL |
A RouteURL represents a URL to the Azure Maps route operations. |
| SasCredential |
SasCredential is a Credential used to generate a SasCredentialPolicy. Renew token by setting a new token string value to token property. Example const sasCredential = new SasCredential("token"); const pipeline = MapsURL.newPipeline(sasCredential); const searchURL = new SearchURL(pipeline); // Set up a timer to refresh the token const timerID = setInterval(() => { // Update token by accessing to public sasCredential.token sasCredential.token = "updatedToken"; // WARNING: Timer must be manually stopped! It will forbid GC of sasCredential if (shouldStop()) { clearInterval(timerID); } }, 60 * 60 * 1000); // Set an interval time before your token expired |
| SasCredentialPolicy |
SasCredentialPolicy is a policy used to sign HTTP request with a token. Such as an JWT SAS token. |
| SearchGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| SearchPolygonGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| SearchReverseGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| SearchURL |
A SearchURL represents a URL to the Azure Maps search operations. |
| SpatialURL |
A SpatialURL represents a URL to the Azure Maps spatial operations. |
| SubscriptionKeyCredential |
SubscriptionKeyCredential for account key authorization of Azure Maps service. |
| SubscriptionKeyCredentialPolicy |
SubscriptionKeyCredentialPolicy is a policy used to sign HTTP requests with a subscription key. |
| TimezoneURL |
A TimezoneURL represents a URL to the Azure Maps timezone operations. |
| TokenCredential |
TokenCredential is a Credential used to generate a TokenCredentialPolicy. Renew token by setting a new token string value to token property. Example const tokenCredential = new TokenCredential("clientId", "token"); const pipeline = MapsURL.newPipeline(tokenCredential); const searchURL = new SearchURL(pipeline); // Set up a timer to refresh the token const timerID = setInterval(() => { // Update token by accessing to public tokenCredential.token tokenCredential.token = "updatedToken"; // WARNING: Timer must be manually stopped! It will forbid GC of tokenCredential if (shouldStop()) { clearInterval(timerID); } }, 60 * 60 * 1000); // Set an interval time before your token expired |
| TokenCredentialPolicy |
TokenCredentialPolicy is a policy used to sign HTTP request with a token. Such as an OAuth bearer token. |
| TransitDockGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| TransitItineraryGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| TransitLineGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
| TransitStopGeojson |
A helper extension providing methods for accessing the response data in GeoJSON format. |
Interfaces
| AuthenticationManager | |
| Map |
This interface partially defines the Azure Map's web control. Web control version 2.0 or later must be used. For a full definition see https://docs.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.map?view=azure-iot-typescript-latest |
| RequestParameters | |
| IBaseGeojson |
The base interface for a geojson helper extension. |
| INewPipelineOptions |
Option interface for MapsURL.newPipeline method. |
| IPipelineOptions |
Option interface for Pipeline constructor. |
| IRequestLogOptions |
IRequestLogOptions configures the retry policy's behavior. |
| IRetryOptions |
Retry options interface. |
| Agency |
Details of the agency. |
| Alert |
Basic information associated with the active alert. |
| AlertDescription |
An interface representing AlertDescription. |
| AlertDetail |
A list of alert details. |
| BatchRequestBody |
This type represents the request body for the Batch service. |
| BatchRequestBodyBatchItemsItem |
Batch Query object |
| BatchResponse |
This object is returned from a successful Batch service call |
| BatchResponseSummary |
Summary for the batch request |
| BufferRequestBody |
An object with a FeatureCollection and a list of distances. All the feature's properties should
contain |
| BufferResponse |
This object is returned from a successful Spatial Buffer call. |
| BufferResponseSummary |
Summary of the call. |
| CarShareResponse |
Details of the car share vehicle. Name is always returned. Level of other returned details depends on car share operator. |
| ClosestPointResultEntry |
Closest Point Result Entry Object |
| Coordinate |
A location represented as a latitude and longitude. |
| CoordinateAbbreviated |
A location represented as a latitude and longitude. |
| CopyrightBoundingResult |
This object is returned from a successful Copyright Bounding call |
| CopyrightCaptionResult |
This object is returned from a successful Copyright Caption call |
| CopyrightTileResult |
This object is returned from a successful Copyright Tile call |
| CopyrightWorldResult |
This object is returned from a successful Copyright World call |
| Country |
A country record. |
| DataSources |
Optional section. Reference ids for use with the Get Search Polygon API. |
| DataSourcesGeometry |
Information about the geometric shape of the result. Only present if type == Geography. |
| Direction |
The walking directions guidance. |
| ErrorModel |
This object is returned when an error occurs in the Maps API |
| ErrorResponse |
This response object is returned when an error occurs in the Maps API |
| GeofenceGeometry |
The geofencing geometry. |
| GeofenceResponse |
This object is returned from a geofence proximity call. |
| GeoJSONFeatureCollection |
A valid |
| GeoJSONFeatureCollectionFeaturesItem |
A valid |
| GeoJSONGeometry |
A valid |
| GeoJSONGeometryCollection |
A valid |
| GetClosestPointResponse |
This object is returned from a successful Get Spatial Closest Point call |
| GetClosestPointSummary |
Get Closest Point Summary object |
| GetPointInPolygonResponse |
Returns true if point is within the polygon, false otherwise |
| GetPointInPolygonSummary |
Point In Polygon Summary object |
| GreatCircleDistanceResponse |
This object is returned from a successful Great Circle Distance call |
| GreatCircleDistanceResponseResult |
Result Object |
| GreatCircleDistanceResponseSummary |
Summary object |
| IanaId |
An interface representing IanaId. |
| ItineraryResult |
An interface representing ItineraryResult. |
| Leg |
An interface representing Leg. |
| LegPoint |
An interface representing LegPoint. |
| Line |
A stop line |
| LineArrival |
An interface representing LineArrival. |
| LineGroup |
A line group |
| LineString |
A valid |
| MapsClientOptions |
An interface representing MapsClientOptions. |
| MetroAreaInfoResponse |
This object is returned from a successful Metro Area call. |
| MetroAreaResponse |
This object is returned from a successful Get Metro Area call |
| MetroAreaResult |
Details of the metro area. |
| MobilityGetCarShareInfoPreviewOptionalParams |
Optional Parameters. |
| MobilityGetMetroAreaInfoPreviewOptionalParams |
Optional Parameters. |
| MobilityGetMetroAreaPreviewOptionalParams |
Optional Parameters. |
| MobilityGetNearbyTransitPreviewOptionalParams |
Optional Parameters. |
| MobilityGetRealTimeArrivalsPreviewOptionalParams |
Optional Parameters. |
| MobilityGetTransitDockInfoPreviewOptionalParams |
Optional Parameters. |
| MobilityGetTransitItineraryPreviewOptionalParams |
Optional Parameters. |
| MobilityGetTransitLineInfoPreviewOptionalParams |
Optional Parameters. |
| MobilityGetTransitRoutePreviewOptionalParams |
Optional Parameters. |
| MobilityGetTransitStopInfoPreviewOptionalParams |
Optional Parameters. |
| MultiLineString |
A valid |
| MultiPoint |
A valid |
| MultiPolygon |
A valid |
| Names |
Timezone names object. |
| NearbyTransitResponse |
This object is returned from a successful Get Nearby Transit call |
| OperatorInfo |
Contains information about the operator. Apart form Id and name, all other fields are optional and nor always returned. |
| Pattern |
Stop-shape-segments of the trip pattern, which are an ordered list of the stops and the shapes connecting them. |
| Point |
A valid |
| PointInPolygonResult |
Point In Polygon Result Object |
| Polygon |
A valid |
| PostClosestPointResponse |
This object is returned from a successful Post Spatial Closest Point call |
| PostClosestPointSummary |
Post Closest Point Summary object |
| PostPointInPolygonResponse |
Returns true if point is within the polygon, false otherwise |
| PostPointInPolygonSummary |
Point In Polygon Summary object |
| Pricing |
Pricing details including currency, reservation price and usage price. |
| RealTimeArrivalResult |
Contains real-time arrival related details. |
| RealTimeArrivalsResponse |
This object is returned from a successful Get Real Time Arrival Info call. |
| ReferenceTimeByCoordinates |
Details in effect at the local time. |
| ReferenceTimeById |
Details in effect at the local time. |
| Region |
An interface representing Region. |
| RegionCountry |
Country property |
| RenderGetCopyrightForTileOptionalParams |
Optional Parameters. |
| RenderGetCopyrightForWorldOptionalParams |
Optional Parameters. |
| RenderGetCopyrightFromBoundingBoxOptionalParams |
Optional Parameters. |
| RenderGetMapImageOptionalParams |
Optional Parameters. |
| RenderGetMapTileOptionalParams |
Optional Parameters. |
| RepresentativePoint |
Representative point property |
| ResultViewport |
The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. |
| RouteBeginPostRouteMatrixPreviewOptionalParams |
Optional Parameters. |
| RouteDirectionsRequestBody |
Post body parameters for Route directions. |
| RouteDirectionsRequestBodySupportingPoints |
A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction |
| RouteDirectionsResponse |
This object is returned from a successful Route Directions call |
| RouteDirectionsResult |
An interface representing RouteDirectionsResult. |
| RouteDirectionsSummary |
Summary object |
| RouteGetRouteDirectionsOptionalParams |
Optional Parameters. |
| RouteGetRouteRangeOptionalParams |
Optional Parameters. |
| RouteItineraryLeg |
An interface representing RouteItineraryLeg. |
| RouteMatrixRequestBody |
An object with a matrix of coordinates. |
| RouteMatrixResponse |
This object is returned from a successful Route Matrix call. For ex, if 2 origins and 3 destinations are provided, there are going to 2 arrays with 3 elements in each. Each element's content depends on the options provided in the query. |
| RouteMatrixResult |
Matrix result object |
| RouteMatrixResultResponse |
Response object of the current cell in the input matrix. |
| RouteMatrixSummary |
Summary object |
| RouteOptimizedWaypoint |
Optimized way point object. |
| RoutePostRouteDirectionsBatchPreviewHeaders |
Defines headers for PostRouteDirectionsBatchPreview operation. |
| RoutePostRouteDirectionsOptionalParams |
Optional Parameters. |
| RoutePostRouteMatrixPreviewHeaders |
Defines headers for PostRouteMatrixPreview operation. |
| RoutePostRouteMatrixPreviewOptionalParams |
Optional Parameters. |
| RouteRange |
Reachable Range |
| RouteRangeResponse |
This object is returned from a successful Route Reachable Range call |
| RouteResponseReport |
Reports the effective settings used in the current call. |
| RouteResponseReportEffectiveSetting |
Effective parameter or data used when calling this Route API. |
| RouteResultGuidance |
Contains guidance related elements. This field is present only when guidance was requested and is available. |
| RouteResultInstruction |
A set of attributes describing a maneuver, e.g. 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'. |
| RouteResultInstructionGroup |
Groups a sequence of instruction elements which are related to each other. The sequence range is constrained with firstInstructionIndex and lastInstructionIndex. When human-readable text messages are requested for guidance (instructionType=text or tagged), then the instructionGroup has a summary message returned when available. |
| RouteResultLeg |
An interface representing RouteResultLeg. |
| RouteResultLegSummary |
Summary object for route section. |
| RouteResultSection |
An interface representing RouteResultSection. |
| RouteResultSectionTec |
Details of the traffic event, using definitions in the TPEG2-TEC standard. Can contain and elements. |
| RouteResultSectionTecCause |
The cause of the traffic event. Can contain and elements. Can be used to define iconography and descriptions. |
| SearchAddressResponse |
This object is returned from a successful Search Address call |
| SearchAddressResult |
An interface representing SearchAddressResult. |
| SearchAddressReverseCrossStreetResponse |
This object is returned from a successful Search Address Reverse CrossStreet call |
| SearchAddressReverseCrossStreetResult |
An interface representing SearchAddressReverseCrossStreetResult. |
| SearchAddressReverseCrossStreetSummary |
Summary object for a Search Address Reverse Cross Street response |
| SearchAddressReverseResponse |
This object is returned from a successful Search Address Reverse call |
| SearchAddressReverseResult |
An interface representing SearchAddressReverseResult. |
| SearchAddressReverseSummary |
Summary object for a Search Address Reverse response |
| SearchAddressStructuredResponse |
This object is returned from a successful Search Address Structured call |
| SearchAddressStructuredResult |
An interface representing SearchAddressStructuredResult. |
| SearchAddressStructuredSummary |
Summary object for a Search Address Structured response |
| SearchAddressSummary |
Summary object for a Search Address response |
| SearchAlongRouteRequestBody |
This type represents the request body for the Search Along Route service. |
| SearchAlongRouteResponse |
This object is returned from a successful Search Along Route call. |
| SearchAlongRouteResult |
This type represents the Search Along Route result object. |
| SearchAlongRouteSummary |
Summary object for a Search Along Route response |
| SearchFuzzyResponse |
This object is returned from a successful Search Fuzzy call |
| SearchFuzzyResult |
An interface representing SearchFuzzyResult. |
| SearchFuzzySummary |
Summary object for a Search Fuzzy response |
| SearchGeometryResponse |
This object is returned from a successful Search By Geometry call |
| SearchGeometryResult |
This type represents the Search Inside Geometry result object. |
| SearchGeometrySummary |
Summary object for a Search Geometry response |
| SearchGetSearchAddressOptionalParams |
Optional Parameters. |
| SearchGetSearchAddressReverseCrossStreetOptionalParams |
Optional Parameters. |
| SearchGetSearchAddressReverseOptionalParams |
Optional Parameters. |
| SearchGetSearchAddressStructuredOptionalParams |
Optional Parameters. |
| SearchGetSearchFuzzyOptionalParams |
Optional Parameters. |
| SearchGetSearchNearbyOptionalParams |
Optional Parameters. |
| SearchGetSearchPOICategoryOptionalParams |
Optional Parameters. |
| SearchGetSearchPOIOptionalParams |
Optional Parameters. |
| SearchInsideGeometryRequestBody |
This type represents the request body for the Search Inside Geometry service. |
| SearchNearbyResponse |
This object is returned from a successful Search Nearby call |
| SearchNearbyResult |
An interface representing SearchNearbyResult. |
| SearchNearbySummary |
Summary object for a Search Nearby response |
| SearchPoiCategoryResponse |
This object is returned from a successful Search POI Category call |
| SearchPoiCategoryResult |
An interface representing SearchPoiCategoryResult. |
| SearchPoiCategorySummary |
Summary object for a Search POI Category response |
| SearchPoiResponse |
This object is returned from a successful Search POI call |
| SearchPoiResult |
An interface representing SearchPoiResult. |
| SearchPoiSummary |
Summary object for a Search POI response |
| SearchPolygonResponse |
This object is returned from a successful Search Polygon call |
| SearchPolygonResult |
An interface representing SearchPolygonResult. |
| SearchPostSearchAddressBatchPreviewHeaders |
Defines headers for PostSearchAddressBatchPreview operation. |
| SearchPostSearchAddressReverseBatchPreviewHeaders |
Defines headers for PostSearchAddressReverseBatchPreview operation. |
| SearchPostSearchAlongRouteOptionalParams |
Optional Parameters. |
| SearchPostSearchFuzzyBatchPreviewHeaders |
Defines headers for PostSearchFuzzyBatchPreview operation. |
| SearchPostSearchInsideGeometryOptionalParams |
Optional Parameters. |
| SearchResultAddress |
The address of the result |
| SearchResultAddressRanges |
Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included. |
| SearchResultEntryPoint |
The entry point for the POI being returned. |
| SearchResultPoi |
Details of the poi including the name, phone, url, and categories. |
| SearchResultPoiBrand |
The name of the brand for the POI being returned |
| SearchResultPoiClassification |
The classification for the POI being returned |
| SearchResultPoiClassificationName |
Name for the classification |
| SearchResultViewport |
The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. |
| SearchSummaryGeoBias |
Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal. |
| SpatialCoordinate |
A location represented as a latitude and longitude |
| SpatialGetClosestPointOptionalParams |
Optional Parameters. |
| SpatialGetGeofenceHeaders |
Defines headers for GetGeofence operation. |
| SpatialGetGeofenceOptionalParams |
Optional Parameters. |
| SpatialPostClosestPointOptionalParams |
Optional Parameters. |
| SpatialPostGeofenceHeaders |
Defines headers for PostGeofence operation. |
| SpatialPostGeofenceOptionalParams |
Optional Parameters. |
| Step |
An interface representing Step. |
| Stop |
The stop's basic info |
| TimeTransition |
An interface representing TimeTransition. |
| TimeZoneByCoordinates |
An interface representing TimeZoneByCoordinates. |
| TimezoneByCoordinatesResult |
This object is returned from a successful Timezone By Coordinates call |
| TimezoneById |
An interface representing TimezoneById. |
| TimezoneByIdResult |
This object is returned from a successful Timezone By ID call |
| TimezoneEnumWindow |
An interface representing TimezoneEnumWindow. |
| TimezoneGetTimezoneByCoordinatesOptionalParams |
Optional Parameters. |
| TimezoneGetTimezoneByIDOptionalParams |
Optional Parameters. |
| TimezoneGetTimezoneWindowsToIANAOptionalParams |
Optional Parameters. |
| TimezoneIanaVersionResult |
This object is returned from a successful Timezone IANA Version call |
| TransitDockInfoResponse |
This object is returned from a successful Transit Dock Info call. |
| TransitItineraryResponse |
This object is returned from a successful Get Transit Itinerary call |
| TransitLineInfoResponse |
This object is returned from a successful Transit Line Info call. |
| TransitObjectResult |
An interface representing TransitObjectResult. |
| TransitRouteResponse |
This object is returned from a successful Get Transit Stop Info call |
| TransitStopInfoResponse |
This object is returned from a successful Get Transit Stop Info call |
| TransitTypeResult |
An interface representing TransitTypeResult. |
| UploadDataAcceptedResponse |
The response model for the spatial data upload API. Returns the current status and a status URI. |
| UploadDataResponse |
The response model for the spatial data upload API. Returns a unique data id (udid) for the uploaded content. |
Type Aliases
| BaseRequestPolicy | |
| CalculateRouteDirectionsOptions | |
| CalculateRouteDirectionsResponse | |
| CalculateRouteMatrixOptions | |
| CalculateRouteMatrixRequestBody | |
| CalculateRouteMatrixResponse | |
| CalculateRouteRangeOptions | |
| CalculateRouteRangeResponse | |
| CredentialPolicyCreator |
A factory function that creates a new CredentialPolicy that uses the provided nextPolicy. |
| GetBufferResponse | |
| GetCarShareInfoOptions | |
| GetCarShareInfoResponse | |
| GetClosesPointResponse | |
| GetClosestPointOptions | |
| GetGeofenceOptions | |
| GetGeofenceResponse | |
| GetGreatCircleDistance | |
| GetMapImageOptions | |
| GetMapImageResponse | |
| GetMapImageryTileResponse | |
| GetMapTileOptions | |
| GetMapTileResponse | |
| GetMetroAreaInfoOptions | |
| GetMetroAreaInfoResponse | |
| GetMetroAreaOptions | |
| GetMetroAreaResponse | |
| GetNearbyTransitOptions | |
| GetNearbyTransitResponse | |
| GetPointInPolygonResponse | |
| GetRealTimeArrivalsOptions | |
| GetRealTimeArrivalsResponse | |
| GetTimezoneByCoordinatesOptions | |
| GetTimezoneByCoordinatesResponse | |
| GetTimezoneByIdOptions | |
| GetTimezoneByIdResponse | |
| GetTransitDockInfoOptions | |
| GetTransitDockInfoResponse | |
| GetTransitItineraryOptions | |
| GetTransitItineraryResponse | |
| GetTransitLineInfoOptions | |
| GetTransitLineInfoResponse | |
| GetTransitRouteOptions | |
| GetTransitRouteResponse | |
| GetTransitStopInfoOptions | |
| GetTransitStopInfoResponse | |
| HttpHeaders | |
| HttpOperationResponse | |
| HttpPipelineLogLevel | |
| IHttpClient | |
| IHttpPipelineLogger | |
| Merge | |
| GeoJSONGeometryUnion |
Contains the possible cases for GeoJSONGeometry. |
| MobilityGetCarShareInfoPreviewResponse |
Contains response data for the getCarShareInfoPreview operation. |
| MobilityGetMetroAreaInfoPreviewResponse |
Contains response data for the getMetroAreaInfoPreview operation. |
| MobilityGetMetroAreaPreviewResponse |
Contains response data for the getMetroAreaPreview operation. |
| MobilityGetNearbyTransitPreviewResponse |
Contains response data for the getNearbyTransitPreview operation. |
| MobilityGetRealTimeArrivalsPreviewResponse |
Contains response data for the getRealTimeArrivalsPreview operation. |
| MobilityGetTransitDockInfoPreviewResponse |
Contains response data for the getTransitDockInfoPreview operation. |
| MobilityGetTransitItineraryPreviewResponse |
Contains response data for the getTransitItineraryPreview operation. |
| MobilityGetTransitLineInfoPreviewResponse |
Contains response data for the getTransitLineInfoPreview operation. |
| MobilityGetTransitRoutePreviewResponse |
Contains response data for the getTransitRoutePreview operation. |
| MobilityGetTransitStopInfoPreviewResponse |
Contains response data for the getTransitStopInfoPreview operation. |
| RenderGetCopyrightCaptionResponse |
Contains response data for the getCopyrightCaption operation. |
| RenderGetCopyrightForTileResponse |
Contains response data for the getCopyrightForTile operation. |
| RenderGetCopyrightForWorldResponse |
Contains response data for the getCopyrightForWorld operation. |
| RenderGetCopyrightFromBoundingBoxResponse |
Contains response data for the getCopyrightFromBoundingBox operation. |
| RenderGetMapImageResponse |
Contains response data for the getMapImage operation. |
| RenderGetMapImageryTileResponse |
Contains response data for the getMapImageryTile operation. |
| RenderGetMapTileResponse |
Contains response data for the getMapTile operation. |
| RouteGetRouteDirectionsResponse |
Contains response data for the getRouteDirections operation. |
| RouteGetRouteRangeResponse |
Contains response data for the getRouteRange operation. |
| RoutePostRouteDirectionsBatchPreviewResponse |
Contains response data for the postRouteDirectionsBatchPreview operation. |
| RoutePostRouteDirectionsResponse |
Contains response data for the postRouteDirections operation. |
| RoutePostRouteMatrixPreviewResponse |
Contains response data for the postRouteMatrixPreview operation. |
| SearchGetSearchAddressResponse |
Contains response data for the getSearchAddress operation. |
| SearchGetSearchAddressReverseCrossStreetResponse |
Contains response data for the getSearchAddressReverseCrossStreet operation. |
| SearchGetSearchAddressReverseResponse |
Contains response data for the getSearchAddressReverse operation. |
| SearchGetSearchAddressStructuredResponse |
Contains response data for the getSearchAddressStructured operation. |
| SearchGetSearchFuzzyResponse |
Contains response data for the getSearchFuzzy operation. |
| SearchGetSearchNearbyResponse |
Contains response data for the getSearchNearby operation. |
| SearchGetSearchPOICategoryResponse |
Contains response data for the getSearchPOICategory operation. |
| SearchGetSearchPOIResponse |
Contains response data for the getSearchPOI operation. |
| SearchGetSearchPolygonResponse |
Contains response data for the getSearchPolygon operation. |
| SearchPostSearchAddressBatchPreviewResponse |
Contains response data for the postSearchAddressBatchPreview operation. |
| SearchPostSearchAddressReverseBatchPreviewResponse |
Contains response data for the postSearchAddressReverseBatchPreview operation. |
| SearchPostSearchAlongRouteResponse |
Contains response data for the postSearchAlongRoute operation. |
| SearchPostSearchFuzzyBatchPreviewResponse |
Contains response data for the postSearchFuzzyBatchPreview operation. |
| SearchPostSearchInsideGeometryResponse |
Contains response data for the postSearchInsideGeometry operation. |
| SpatialGetBufferResponse |
Contains response data for the getBuffer operation. |
| SpatialGetClosestPointResponse |
Contains response data for the getClosestPoint operation. |
| SpatialGetGeofenceResponse |
Contains response data for the getGeofence operation. |
| SpatialGetGreatCircleDistanceResponse |
Contains response data for the getGreatCircleDistance operation. |
| SpatialGetPointInPolygonResponse |
Contains response data for the getPointInPolygon operation. |
| SpatialPostBufferResponse |
Contains response data for the postBuffer operation. |
| SpatialPostClosestPointResponse |
Contains response data for the postClosestPoint operation. |
| SpatialPostGeofenceResponse |
Contains response data for the postGeofence operation. |
| SpatialPostPointInPolygonResponse |
Contains response data for the postPointInPolygon operation. |
| TimezoneGetTimezoneByCoordinatesResponse |
Contains response data for the getTimezoneByCoordinates operation. |
| TimezoneGetTimezoneByIDResponse |
Contains response data for the getTimezoneByID operation. |
| TimezoneGetTimezoneEnumIANAResponse |
Contains response data for the getTimezoneEnumIANA operation. |
| TimezoneGetTimezoneEnumWindowsResponse |
Contains response data for the getTimezoneEnumWindows operation. |
| TimezoneGetTimezoneIANAVersionResponse |
Contains response data for the getTimezoneIANAVersion operation. |
| TimezoneGetTimezoneWindowsToIANAResponse |
Contains response data for the getTimezoneWindowsToIANA operation. |
| RequestPolicy | |
| RequestPolicyFactory | |
| RequestPolicyOptions | |
| Response |
A type alias for easily representing a response interface with or without a geojson helper. Also provides the raw response data in the response object. |
| RestError | |
| SearchAddressOptions | |
| SearchAddressResponse | |
| SearchAddressReverseCrossStreetOptions | |
| SearchAddressReverseCrossStreetResponse | |
| SearchAddressReverseOptions | |
| SearchAddressReverseResponse | |
| SearchAddressStructuredOptions | |
| SearchAddressStructuredResponse | |
| SearchAlongRouteOptions | |
| SearchAlongRouteRequestBody | |
| SearchAlongRouteResponse | |
| SearchFuzzyOptions | |
| SearchFuzzyResponse | |
| SearchInsideGeometryOptions | |
| SearchInsideGeometryRequestBody | |
| SearchInsideGeometryResponse | |
| SearchNearbyOptions | |
| SearchNearbyResponse | |
| SearchPOICategoryOptions | |
| SearchPOICategoryResponse | |
| SearchPOIOptions | |
| SearchPOIResponse | |
| SearchPolygonResponse | |
| SpatialFeatureCollection |
A GeoJSON |
| UndefinedGeojson | |
| WebResource | |
Enums
| AbsoluteDirection |
Defines values for AbsoluteDirection. Possible values include: 'north', 'northeast', 'east', 'southeast', 'south', 'southwest', 'west', 'northwest' |
| AgencyType |
Defines values for AgencyType. Possible values include: 'agencyId', 'agencyKey', 'agencyName' |
| AlternativeRouteType |
Defines values for AlternativeRouteType. Possible values include: 'anyRoute', 'betterRoute' |
| Avoid |
Defines values for Avoid. Possible values include: 'tollRoads', 'motorways', 'ferries', 'unpavedRoads', 'carpools', 'alreadyUsedRoads', 'borderCrossings' |
| BikeType |
Defines values for BikeType. Possible values include: 'privateBike', 'dockedBike' |
| ComputeTravelTimeFor |
Defines values for ComputeTravelTimeFor. Possible values include: 'none', 'all' |
| ConnectorSet |
Defines values for ConnectorSet. Possible values include: 'StandardHouseholdCountrySpecific', 'IEC62196Type1', 'IEC62196Type1CCS', 'IEC62196Type2CableAttached', 'IEC62196Type2Outlet', 'IEC62196Type2CCS', 'IEC62196Type3', 'Chademo', 'IEC60309AC1PhaseBlue', 'IEC60309DCWhite', 'Tesla' |
| DestinationType |
Defines values for DestinationType. Possible values include: 'position', 'stopId', 'stopKey' |
| DrivingSide |
Defines values for DrivingSide. Possible values include: 'LEFT', 'RIGHT' |
| EntityType |
Defines values for EntityType. Possible values include: 'Country', 'CountrySubdivision', 'CountrySecondarySubdivision', 'CountryTertiarySubdivision', 'Municipality', 'MunicipalitySubdivision', 'Neighbourhood', 'PostalCodeArea' |
| GeofenceMode |
Defines values for GeofenceMode. Possible values include: 'All', 'EnterAndExit' |
| GuidanceInstructionType |
Defines values for GuidanceInstructionType. Possible values include: 'TURN', 'ROAD_CHANGE', 'LOCATION_DEPARTURE', 'LOCATION_ARRIVAL', 'DIRECTION_INFO', 'LOCATION_WAYPOINT' |
| GuidanceManeuver |
Defines values for GuidanceManeuver. Possible values include: 'ARRIVE', 'ARRIVE_LEFT', 'ARRIVE_RIGHT', 'DEPART', 'STRAIGHT', 'KEEP_RIGHT', 'BEAR_RIGHT', 'TURN_RIGHT', 'SHARP_RIGHT', 'KEEP_LEFT', 'BEAR_LEFT', 'TURN_LEFT', 'SHARP_LEFT', 'MAKE_UTURN', 'ENTER_MOTORWAY', 'ENTER_FREEWAY', 'ENTER_HIGHWAY', 'TAKE_EXIT', 'MOTORWAY_EXIT_LEFT', 'MOTORWAY_EXIT_RIGHT', 'TAKE_FERRY', 'ROUNDABOUT_CROSS', 'ROUNDABOUT_RIGHT', 'ROUNDABOUT_LEFT', 'ROUNDABOUT_BACK', 'TRY_MAKE_UTURN', 'FOLLOW', 'SWITCH_PARALLEL_ROAD', 'SWITCH_MAIN_ROAD', 'ENTRANCE_RAMP', 'WAYPOINT_LEFT', 'WAYPOINT_RIGHT', 'WAYPOINT_REACHED' |
| Hilliness |
Defines values for Hilliness. Possible values include: 'low', 'normal', 'high' |
| LegType |
Defines values for LegType. Possible values include: 'Walk', 'Bicycle', 'Tram', 'Subway', 'Rail', 'Bus', 'Ferry', 'Cable', 'Gondola', 'Funicular', 'PathWayWalk', 'Wait', 'WaitOnVehicle' |
| MagnitudeOfDelay |
Defines values for MagnitudeOfDelay. Possible values include: '0', '1', '2', '3', '4' |
| MapTileLayer |
Defines values for MapTileLayer. Possible values include: 'basic', 'hybrid', 'labels', 'terra' |
| MapTileStyle |
Defines values for MapTileStyle. Possible values include: 'main', 'shaded_relief' |
| MetroAreaDetailType |
Defines values for MetroAreaDetailType. Possible values include: 'agencies', 'alerts', 'alertDetails', 'transitTypes' |
| MetroAreaQueryType |
Defines values for MetroAreaQueryType. Possible values include: 'position', 'countryCode' |
| ModeType |
Defines values for ModeType. Possible values include: 'walk', 'bike', 'publicTransit' |
| ObjectType |
Defines values for ObjectType. Possible values include: 'stop', 'docklessBike', 'docklessElectricBike', 'docklessElectricScooter', 'docklessScooter', 'docklessMoped', 'carShare', 'docklessVehicle', 'bikeDock' |
| OpeningHours |
Defines values for OpeningHours. Possible values include: 'nextSevenDays' |
| OriginType |
Defines values for OriginType. Possible values include: 'position', 'stopId', 'stopKey' |
| RealTimeArrivalsQueryType |
Defines values for RealTimeArrivalsQueryType. Possible values include: 'stops', 'line', 'lineAndStop', 'position' |
| RelativeDirection |
Defines values for RelativeDirection. Possible values include: 'depart', 'hardLeft', 'left', 'slightlyLeft', 'continue', 'slightlyRight', 'right', 'hardRight', 'circleClockwise', 'circleCounterclockwise', 'elevator', 'uturnLeft', 'uturnRight' |
| RouteInstructionsType |
Defines values for RouteInstructionsType. Possible values include: 'coded', 'text', 'tagged' |
| RouteRepresentation |
Defines values for RouteRepresentation. Possible values include: 'polyline', 'summaryOnly', 'none' |
| RouteType |
Defines values for RouteType. Possible values include: 'fastest', 'shortest', 'eco', 'thrilling' |
| ScheduleType |
Defines values for ScheduleType. Possible values include: 'scheduledTime', 'realTime' |
| SearchIndexSet |
Defines values for SearchIndexSet. Possible values include: 'Addr', 'Geo', 'PAD', 'POI', 'Str', 'Xstr' |
| SectionType |
Defines values for SectionType. Possible values include: 'carTrain', 'country', 'ferry', 'motorway', 'pedestrian', 'tollRoad', 'tollVignette', 'traffic', 'travelMode', 'tunnel' |
| StaticMapLayer |
Defines values for StaticMapLayer. Possible values include: 'basic', 'hybrid', 'labels' |
| StopQueryType |
Defines values for StopQueryType. Possible values include: 'stopId', 'stopKey' |
| Style |
Defines values for Style. Possible values include: 'main' |
| Text |
Defines values for Text. Possible values include: 'yes', 'no' |
| Text1 |
Defines values for Text1. Possible values include: 'yes', 'no' |
| Text2 |
Defines values for Text2. Possible values include: 'yes', 'no' |
| TileFormat |
Defines values for TileFormat. Possible values include: 'png', 'pbf' |
| TimeType |
Defines values for TimeType. Possible values include: 'arrival', 'departure', 'last' |
| TimezoneOptions |
Defines values for TimezoneOptions. Possible values include: 'none', 'zoneInfo', 'transitions', 'all' |
| TransitItineraryDetailType |
Defines values for TransitItineraryDetailType. Possible values include: 'geometry', 'schedule' |
| TransitLineDetailType |
Defines values for TransitLineDetailType. Possible values include: 'alerts', 'alertDetails', 'lines', 'stops', 'schedule', 'patterns' |
| TransitRouteType |
Defines values for TransitRouteType. Possible values include: 'optimal', 'leastWalk', 'leastTransfers' |
| TransitStopDetailType |
Defines values for TransitStopDetailType. Possible values include: 'alerts', 'alertDetails', 'lines', 'lineGroups' |
| TransitStopQueryType |
Defines values for TransitStopQueryType. Possible values include: 'stopId', 'stopKey' |
| TransitType |
Defines values for TransitType. Possible values include: 'Bus', 'CableCar', 'Ferry', 'Funicular', 'Gondola', 'Rail', 'Tram', 'Subway' |
| TransitTypeFilter |
Defines values for TransitTypeFilter. Possible values include: 'bus', 'cableCar', 'ferry', 'funicular', 'gondola', 'rail', 'tram', 'subway' |
| TravelMode |
Defines values for TravelMode. Possible values include: 'car', 'truck', 'taxi', 'bus', 'van', 'motorcycle', 'bicycle', 'pedestrian' |
| Type |
Defines values for Type. Possible values include: 'main', 'minor' |
| VehicleEngineType |
Defines values for VehicleEngineType. Possible values include: 'combustion', 'electric' |
| VehicleLoadType |
Defines values for VehicleLoadType. Possible values include: 'USHazmatClass1', 'USHazmatClass2', 'USHazmatClass3', 'USHazmatClass4', 'USHazmatClass5', 'USHazmatClass6', 'USHazmatClass7', 'USHazmatClass8', 'USHazmatClass9', 'otherHazmatExplosive', 'otherHazmatGeneral', 'otherHazmatHarmfulToWater' |
| Windingness |
Defines values for Windingness. Possible values include: 'low', 'normal', 'high' |
| RetryPolicyType |
RetryPolicy types. |