SearchAlongRouteOptions interface

包:

@azure/maps-search

沿路由搜索的选项

扩展

SearchGeometryBaseOptions,OperationOptions

属性

brandFilter	一个逗号分隔的品牌名称列表，可用于将结果限制为特定品牌。 项顺序无关紧要。 当提供多个品牌时，将仅返回属于（至少）其中一个列表的结果。 名称中包含 “，”的品牌应放入引号中。 使用示例： brandSet=FoobrandSet=Foo,BarbrandSet="A,B,C Comma",Bar
electricVehicleConnectorFilter	连接器类型的逗号分隔列表，可用于将结果限制为支持特定连接器类型的电动汽车站。 项顺序无关紧要。 当提供多个连接器类型时，将仅返回属于其中一个列表（至少）的结果。 用法示例：connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet，IEC62196Type2CableAttached

继承属性

abortSignal	可用于中止请求的信号。
categoryFilter	类别集 ID 的逗号分隔列表，可用于将结果限制为特定的兴趣点类别。 ID 顺序无关紧要。 提供多个类别标识符时，将仅返回属于提供的列表中的一个类别（至少）的 PO。 可以使用 POI 类别 API 发现支持的类别列表。 使用示例： categorySet=7315（从类别餐厅搜索兴趣点）（ categorySet=7315025,7315017搜索类别意大利或法国餐厅的兴趣点）
localizedMapView	View 参数（也称为“用户区域”参数）允许为地缘政治争议区域显示特定国家/地区的正确地图。
onResponse	在执行请求的操作时，每次从服务器接收响应时调用的函数。 可以多次调用。
operatingHours	POI（兴趣点）的小时操作时间。
requestOptions	为此操作创建和发送 HTTP 请求时使用的选项。
serializerOptions	用于替代序列化/取消序列化行为的选项。
top	将返回的最大响应数。 默认值：10，最小值：1，最大值：100
tracingOptions	启用跟踪时使用的选项。

属性详细信息

brandFilter

一个逗号分隔的品牌名称列表，可用于将结果限制为特定品牌。 项顺序无关紧要。 当提供多个品牌时，将仅返回属于（至少）其中一个列表的结果。 名称中包含 “，”的品牌应放入引号中。

使用示例： brandSet=FoobrandSet=Foo,BarbrandSet="A,B,C Comma",Bar

brandFilter?: string[]

属性值

string[]

electricVehicleConnectorFilter

连接器类型的逗号分隔列表，可用于将结果限制为支持特定连接器类型的电动汽车站。 项顺序无关紧要。 当提供多个连接器类型时，将仅返回属于其中一个列表（至少）的结果。

用法示例：connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet，IEC62196Type2CableAttached

electricVehicleConnectorFilter?: string[]

属性值

string[]

继承属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

继承自 OperationOptions.abortSignal 的

categoryFilter

类别集 ID 的逗号分隔列表，可用于将结果限制为特定的兴趣点类别。 ID 顺序无关紧要。 提供多个类别标识符时，将仅返回属于提供的列表中的一个类别（至少）的 PO。 可以使用 POI 类别 API 发现支持的类别列表。

使用示例： categorySet=7315（从类别餐厅搜索兴趣点）（ categorySet=7315025,7315017搜索类别意大利或法国餐厅的兴趣点）

categoryFilter?: number[]

属性值

number[]

继承自SearchGeometryBaseOptions.categoryFilter

localizedMapView

View 参数（也称为“用户区域”参数）允许为地缘政治争议区域显示特定国家/地区的正确地图。

localizedMapView?: string

属性值

string

继承自SearchGeometryBaseOptions.localizedMapView

onResponse

在执行请求的操作时，每次从服务器接收响应时调用的函数。 可以多次调用。

onResponse?: RawResponseCallback

属性值

RawResponseCallback

继承自 OperationOptions.onResponse

operatingHours

POI（兴趣点）的小时操作时间。

operatingHours?: string

属性值

string

继承自SearchGeometryBaseOptions.operatingHours

requestOptions

为此操作创建和发送 HTTP 请求时使用的选项。

requestOptions?: OperationRequestOptions

属性值

OperationRequestOptions

继承自 OperationOptions.requestOptions

serializerOptions

用于替代序列化/取消序列化行为的选项。

serializerOptions?: SerializerOptions

属性值

SerializerOptions

继承自 OperationOptions.serializerOptions

top

将返回的最大响应数。 默认值：10，最小值：1，最大值：100

top?: number

属性值

number

继承自 SearchGeometryBaseOptions.top

tracingOptions

启用跟踪时使用的选项。

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

继承自 OperationOptions.tracingOptions