azure-maps-rest package
Azure Maps Web SDK Service Module service retirement. Azure Maps Web SDK 服务模块现已弃用,将于2026年9月30日退役。 为避免服务中断,建议于2026年9月30日前迁移至Azure Maps JavaScript REST SDK。 请按照 我们的指示 迁移到 Azure Maps JavaScript REST SDK。
类
| Aborter |
中止实例实现了 AbortSignal 接口,可以中止 HTTP 请求。
对于已有的实例中止器:
|
| CarShareGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| ClosestPointGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| Credential |
Credential 是 Azure Maps HTTP 请求签名的一个抽象类。 此类将托管生成 CredentialPolicy 的 credentialPolicyCreator 工厂。 |
| CredentialPolicy |
用于在发送之前对 HTTP(S) 请求进行签名的凭据策略。 这是一个抽象类。 |
| GeofenceGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| LoggingPolicyFactory |
LoggingPolicyFactory 是一个工厂类,帮助生成 LoggingPolicy 对象。 |
| MapControlCredential |
MapControlCredential用于与实例共享认证 |
| MapControlCredentialPolicy |
MapControlCredentialPolicy 是一种用于通过实例签署共享认证 |
| MapsURL |
MapsURL 代表 SearchURL、RouteURL 等的基 URL 类。 |
| MetroAreaGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| NearbyTransitGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| Pipeline |
一个包含HTTP请求策略的管道类。 你可以通过调用 MapsURL.newPipeline() 来创建默认管道。 或者你可以通过管道的构建器创建带有你自己策略的管道。 在实现自定义管道前,请参考 MapsURL.newPipeline() 及提供的策略。 |
| PointInPolygonGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| RealTimeArrivalsGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| RenderURL |
RenderURL 表示 Azure Maps 渲染作的 URL。 |
| RetryPolicyFactory |
RetryPolicyFactory 是一个工厂类,帮助生成 RetryPolicy 对象。 |
| RouteGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| RouteRangeGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| RouteURL |
RouteURL 表示 Azure Maps 路由作的 URL。 |
| SasCredential |
SasCredential 是一种用于生成 SasCredentialPolicy 的凭据。 通过将新的令牌字符串值设置为令牌属性来更新令牌。 示例 const sasCredential = new SasCredential(“token”);const pipeline = MapsURL.newPipeline(sasCredential); const searchURL = new SearchURL(pipeline); 设置一个定时器来刷新令牌 const timerID = setInterval(() => { // 通过访问公共 sasCredential.token sasCredential.token = “updatedToken”来更新令牌;// 警告:定时器必须手动停止! 如果 (shouldStop()) { clearInterval(timerID); } }, 60 * 60 * 1000,则禁止 sasCredential 的 GC);设定一个令牌到期前的间隔时间 |
| SasCredentialPolicy |
SasCredentialPolicy 是一种用于用令牌签署 HTTP 请求的策略。 比如JWT SAS令牌。 |
| SearchGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| SearchPolygonGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| SearchReverseGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| SearchURL |
SearchURL 代表 Azure Maps 搜索作的 URL。 |
| SpatialURL |
空间URL代表Azure地图空间作的URL。 |
| SubscriptionKeyCredential |
SubscriptionKeyCredential for account key authorization of Azure Maps service. |
| SubscriptionKeyCredentialPolicy |
SubscriptionKeyCredentialPolicy 是一种用于用订阅密钥签名 HTTP 请求的策略。 |
| TimezoneURL |
TimezoneURL 代表 Azure Maps 时区作的 URL。 |
| TokenCredential |
TokenCredential 是一种用于生成 TokenCredentialPolicy 的凭证。 通过将新的令牌字符串值设置为令牌属性来更新令牌。 示例 const tokenCredential = new TokenCredential(“clientId”, “token”);const pipeline = MapsURL.newPipeline(tokenCredential); const searchURL = new SearchURL(pipeline); 设置一个定时器来刷新令牌 const timerID = setInterval(() => { // 通过访问公共 tokenCredential.token tokenCredential.token = “updatedToken”来更新令牌;// 警告:定时器必须手动停止! 如果 (shouldStop()) { clearInterval(timerID); } }, 60 * 60 * 1000);设定一个令牌到期前的间隔时间 |
| TokenCredentialPolicy |
TokenCredentialPolicy 是一种用于用令牌签署 HTTP 请求的策略。 比如OAuth持有人代币。 |
| TransitDockGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| TransitItineraryGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| TransitLineGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
| TransitStopGeojson |
一个辅助扩展,提供访问 GeoJSON 格式响应数据的方法。 |
接口
类型别名
枚举
| AbsoluteDirection |
定义了绝对方向的数值。 可能的数值包括:“北”、“东北”、“东”、“东南”、“南”、“西南”、“西”、“西北” |
| AgencyType |
定义了AgencyType的值。 可能的值包括:'agencyId'、'agencyKey'、'agencyName' |
| AlternativeRouteType |
定义了AlternativeRouteType的值。 可能的值包括:'anyRoute', 'betterRoute' |
| Avoid |
定义了“避免”的数值。 可能的数值包括:“收费公路”、“高速公路”、“渡轮”、“未铺装道路”、“拼车”、“已使用道路”、“边界口岸” |
| BikeType |
定义了自行车类型的数值。 可能的值包括:'privateBike', 'dockedBike' |
| ComputeTravelTimeFor |
定义了 ComputeTravelTimeFor 的值。 可能的值包括:“无”、“全部” |
| ConnectorSet |
定义了ConnectorSet的值。 可能的值包括:“StandardHouseholdCountrySpecific”、“IEC62196Type1”、“IEC62196Type1CCS”、“IEC62196Type2CableAttached”、“IEC62196Type2Outlet”、“IEC62196Type2CCS”、“IEC62196Type3”、“Chademo”、“IEC60309AC1PhaseBlue”、“IEC60309DCWhite”、“Tesla” |
| DestinationType |
定义了DestinationType的值。 可能的值包括:'position'、'stopId'、'stopKey' |
| DrivingSide |
定义了 DrivingSide 的数值。 可能的值包括:“左”、“右” |
| EntityType |
定义了EntityType的值。 可能的数值包括:“国家”、“国家分区”、“国家次级分区”、“国家第三级分区”、“市政当局”、“市政分区”、“邻里”、“邮政编码区” |
| GeofenceMode |
定义了GeofenceMode的数值。 可能的值包括:“全部”、“进入并退出” |
| GuidanceInstructionType |
定义了 GuidanceInstructionType 的值。 可能的值包括:“转”、“ROAD_CHANGE”、“LOCATION_DEPARTURE”、“LOCATION_ARRIVAL”、“DIRECTION_INFO”、“LOCATION_WAYPOINT” |
| GuidanceManeuver |
定义了引导机动的数值。 可能的值包括:“到达”、“ARRIVE_LEFT”、“ARRIVE_RIGHT”、“出发”、“直达”、“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”、“跟随”, “SWITCH_PARALLEL_ROAD”、“SWITCH_MAIN_ROAD”、“ENTRANCE_RAMP”、“WAYPOINT_LEFT”、“WAYPOINT_RIGHT”、“WAYPOINT_REACHED” |
| Hilliness |
定义了丘陵地带的价值。 可能的数值包括:“低”、“正常”、“高” |
| LegType |
定义了LegType的值。 可能的数值包括:“步行”、“自行车”、“有轨电车”、“地铁”、“铁路”、“公交”、“渡轮”、“缆索”、“缆车”、“缆车”、“路径步行”、“等待”、“等待车辆” |
| MagnitudeOfDelay |
定义了延迟大小的数值。 可能的值包括:'0'、'1'、'2'、'3'、'4' |
| MapTileLayer |
定义了MapTileLayer的数值。 可能的数值包括:“基本”、“杂交”、“标签”、“地球” |
| MapTileStyle |
定义了MapTileStyle的数值。 可能的值包括:“主”、“shaded_relief” |
| MetroAreaDetailType |
定义MetroAreaDetailType的值。 可能的值包括:“机构”、“警报”、“警报详情”、“transitTypes” |
| MetroAreaQueryType |
定义了MetroAreaQueryType的值。 可能的值包括:“位置”、“国家代码” |
| ModeType |
定义了 ModeType 的值。 可能的数值包括:“步行”、“自行车”、“公共交通” |
| ObjectType |
定义 ObjectType 的值。 可能的数值包括:“stop”、“docklessBike”、“docklessElectricBike”、“docklessElectricScooter”、“docklessScooter”、“docklessMoped”、“carShare”、“docklessVehicle”、“bikeDock” |
| OpeningHours |
定义开放时间的数值。 可能的值包括:“nextSevenDays” |
| OriginType |
定义了OriginType的值。 可能的值包括:'position'、'stopId'、'stopKey' |
| RealTimeArrivalsQueryType |
定义了RealTimeArrivalsQueryType的值。 可能的值包括:“停车”、“线路”、“线路与停车”、“位置” |
| RelativeDirection |
定义了相对方向的数值。 可能的数值包括:“离开”、“硬左”、“左”、“稍微左”、“继续”、“稍微右”、“右”、“硬右”、“顺时针圆圈”、“逆时针圆圈”、“电梯”、“左转”、“右转右转” |
| RouteInstructionsType |
定义了 RouteInstructionsType 的值。 可能的值包括:“编码”、“文本”、“标记” |
| RouteRepresentation |
定义路由表示的值。 可能的值包括:'多线'、'仅摘要'、'无' |
| RouteType |
定义 RouteType 的值。 可能的数值包括:“最快”、“最短”、“节能”、“刺激” |
| ScheduleType |
定义了ScheduleType的值。 可能的值包括:“scheduledTime”、“realTime” |
| SearchIndexSet |
定义了 SearchIndexSet 的值。 可能的数值包括:“Addr”、“Geo”、“PAD”、“POI”、“Str”、“Xstr” |
| SectionType |
定义了SectionType的值。 可能的数值包括:“carTrain”、“country”、“ferry”、“motorway”、“pedestrian”、“toll Road”、“tollVignette”、“traffic”、“travelMode”、“tunnel” |
| StaticMapLayer |
定义了StaticMapLayer的数值。 可能的数值包括:“基本”、“混合”、“标签” |
| StopQueryType |
定义了 StopQueryType 的值。 可能的值包括:'stopId', 'stopKey' |
| Style |
定义风格价值。 可能的值包括:“主” |
| Text |
定义文本值。 可能的数值包括:“是”、“否” |
| Text1 |
定义了文本1的数值。 可能的数值包括:“是”、“否” |
| Text2 |
定义文本2的值。 可能的数值包括:“是”、“否” |
| TileFormat |
定义了TileFormat的值。 可能的值包括:'png', 'pbf' |
| TimeType |
定义了TimeType的值。 可能的值包括:“到达”、“出发”、“最后”。 |
| TimezoneOptions |
定义了TimezoneOptions的数值。 可能的值包括:'无'、'zoneInfo'、'transitions'、'all' |
| TransitItineraryDetailType |
定义了TransitineraryDetailType的值。 可能的值包括:“几何”、“排程” |
| TransitLineDetailType |
定义了TransitLineDetailType的值。 可能的值包括:“警报”、“警报详情”、“线路”、“停车”、“计划”、“模式” |
| TransitRouteType |
定义了TransitRouteType的值。 可能的值包括:“最优”、“最少行走”、“最少转移” |
| TransitStopDetailType |
定义了TransitStopDetailType的值。 可能的值包括:“警报”、“警报详情”、“行”、“行组” |
| TransitStopQueryType |
定义了TransitStopQueryType的值。 可能的值包括:'stopId', 'stopKey' |
| TransitType |
定义了TransitType的值。 可能的数值包括:“公交”、“缆车”、“渡轮”、“缆车”、“贡多拉”、“铁路”、“有轨电车”、“地铁” |
| TransitTypeFilter |
定义了TransitTypeFilter的值。 可能的数值包括:“公交”、“缆车”、“渡轮”、“缆车”、“贡多拉”、“铁路”、“有轨电车”、“地铁” |
| TravelMode |
定义了TravelMode的数值。 可能的数值包括:“汽车”、“卡车”、“出租车”、“公交”、“面包车”、“摩托车”、“自行车”、“行人” |
| Type |
定义 Type 的值。 可能的值包括:“主”、“次要” |
| VehicleEngineType |
定义了VehicleEngineType的数值。 可能的数值包括:“燃烧”、“电力” |
| VehicleLoadType |
定义了VehicleLoadType的值。 可能的值包括:“美国危险品1级”、“美国危险品类别2”、“美国危险品类别3”、“美国危险品类别4”、“美国危险品类别5”、“美国危险品类别6”、“美国危险品类别7”、“美国危险品类别8”、“美国危险品类别9”、“其他危险品爆炸物”、“其他危险品通用”、“其他危险品对水有害” |
| Windingness |
定义绕线度的数值。 可能的数值包括:“低”、“正常”、“高” |
| RetryPolicyType |
RetryPolicy 类型。 |