SearchAlongRouteOptions interface
Opções para pesquisar ao longo das rotas
Propriedades
| brand |
Uma lista separada por vírgulas de marcas que podem ser usadas para restringir o resultado a marcas específicas. A ordem do item não importa. Quando várias marcas forem fornecidas, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados. As marcas que contêm um "," em seu nome devem ser colocadas entre aspas. Exemplos de uso: |
| electric |
Uma lista separada por vírgulas de tipos de conector que podem ser usados para restringir o resultado à Estação de Veículos Elétricos que dá suporte a tipos de conectores específicos. A ordem do item não importa. Quando vários tipos de conector são fornecidos, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados. Exemplos de uso: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
Propriedades herdadas
| abort |
O sinal que pode ser usado para anular solicitações. |
| category |
Uma lista separada por vírgulas de IDs de conjunto de categorias que pode ser usada para restringir o resultado a categorias específicas de Pontos de Interesse. A ordem de ID não importa. Quando vários identificadores de categoria forem fornecidos, somente as POIs que pertencem (pelo menos) a uma das categorias da lista fornecida serão retornadas. A lista de categorias suportadas pode ser descoberta usando a API de categorias de POI. Exemplos de uso: |
| localized |
O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopolicamente disputadas. |
| on |
Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes. |
| operating |
Horas de operação para uma POI (pontos de interesse). |
| request |
Opções usadas ao criar e enviar solicitações HTTP para esta operação. |
| serializer |
Opções para substituir o comportamento de serialização/des serialização. |
| top | Número máximo de respostas que serão retornadas. Padrão: 10, mínimo: 1 e máximo: 100 |
| tracing |
Opções usadas quando o rastreamento está habilitado. |
Detalhes da propriedade
brandFilter
Uma lista separada por vírgulas de marcas que podem ser usadas para restringir o resultado a marcas específicas. A ordem do item não importa. Quando várias marcas forem fornecidas, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados. As marcas que contêm um "," em seu nome devem ser colocadas entre aspas.
Exemplos de uso: brandSet=FoobrandSet=Foo,BarbrandSet="A,B,C Comma",Bar
brandFilter?: string[]Valor da propriedade
string[]
electricVehicleConnectorFilter
Uma lista separada por vírgulas de tipos de conector que podem ser usados para restringir o resultado à Estação de Veículos Elétricos que dá suporte a tipos de conectores específicos. A ordem do item não importa. Quando vários tipos de conector são fornecidos, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados.
Exemplos de uso: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
electricVehicleConnectorFilter?: string[]Valor da propriedade
string[]
Detalhes das propriedades herdadas
abortSignal
O sinal que pode ser usado para anular solicitações.
abortSignal?: AbortSignalLikeValor da propriedade
Herdado de OperationOptions.abortSignal
categoryFilter
Uma lista separada por vírgulas de IDs de conjunto de categorias que pode ser usada para restringir o resultado a categorias específicas de Pontos de Interesse. A ordem de ID não importa. Quando vários identificadores de categoria forem fornecidos, somente as POIs que pertencem (pelo menos) a uma das categorias da lista fornecida serão retornadas. A lista de categorias suportadas pode ser descoberta usando a API de categorias de POI.
Exemplos de uso: categorySet=7315(Pesquisar pontos de interesse da categoria Restaurante) categorySet=7315025,7315017(Pesquisar pontos de interesse da categoria Restaurante italiano ou francês)
categoryFilter?: number[]Valor da propriedade
number[]
Herdado deSearchGeometryBaseOptions.categoryFilter
localizedMapView
O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopolicamente disputadas.
localizedMapView?: stringValor da propriedade
string
onResponse
Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
onResponse?: RawResponseCallbackValor da propriedade
Herdado de OperationOptions.onResponse
operatingHours
Horas de operação para uma POI (pontos de interesse).
operatingHours?: stringValor da propriedade
string
Herdado deSearchGeometryBaseOptions.operatingHours
requestOptions
Opções usadas ao criar e enviar solicitações HTTP para esta operação.
requestOptions?: OperationRequestOptionsValor da propriedade
Herdado de OperationOptions.requestOptions
serializerOptions
Opções para substituir o comportamento de serialização/des serialização.
serializerOptions?: SerializerOptionsValor da propriedade
herdado de OperationOptions.serializerOptions
top
Número máximo de respostas que serão retornadas. Padrão: 10, mínimo: 1 e máximo: 100
top?: numberValor da propriedade
number
Herdado deSearchGeometryBaseOptions.top
tracingOptions
Opções usadas quando o rastreamento está habilitado.
tracingOptions?: OperationTracingOptionsValor da propriedade
Herdado de OperationOptions.tracingOptions
