Share via

SearchGetSearchAddressReverseOptionalParams interface

  • Referência
Pacote:
azure-maps-rest

Parâmetros Opcionais.

Extends

RequestOptionsBase

Propriedades

allowFreeformNewline

Formato de novas linhas no endereço formatado. Se for verdadeiro, o endereço conterá novas linhas. Se for falso, as novas linhas serão convertidas em vírgulas.
entityType

Limita a pesquisa de tipos de entidades geográficas especificados, por exemplo, devolver apenas o município. A resposta resultante conterá o ID geográfico, bem como o tipo de entidade correspondente. Se fornecer mais do que uma entidade como uma lista separada por vírgulas, o ponto final devolverá a "entidade mais pequena disponível". O ID de Geometria devolvido pode ser utilizado para obter a geometria dessa geografia através da API Get Pesquisa Polygon. Os valores possíveis incluem: "Country", "CountrySubdivision", "CountrySecondarySubdivision", "CountryTertiarySubdivision", "Municipality", "MunicipalitySubdivision", "Neighborhood", "PostalCodeArea"
heading

O cabeçalho direcional do veículo em graus, para viajar ao longo de um segmento de estrada. 0 é Norte, 90 é Leste e assim sucessivamente, os valores variam entre -360 e 360. A precisão pode incluir até uma casa decimal
language

Idioma no qual os resultados da pesquisa devem ser devolvidos. Deve ser uma das etiquetas de linguagem IETF suportadas, não sensível a maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, é utilizado o idioma predefinido. Consulte idiomas suportados para obter detalhes.
number

Se um número for enviado juntamente com o pedido, a resposta pode incluir o lado da rua (Esquerda/Direita) e também uma posição de deslocamento para esse número
radius

O raio em metros para para que os resultados sejam restritos à área definida
returnMatchType

Inclua informações sobre o tipo de correspondência do geocódigo obtido na resposta.
returnRoadUse

Booleano. Para ativar o retorno da matriz de utilização da estrada para reversegeocodes ao nível da rua
returnSpeedLimit

Booleano. Para ativar a devolução do speedlimit publicado
roadUse

Para restringir os códigos inversos a um determinado tipo de roaduse. A matriz de utilização de estradas para códigos inversos pode ser uma ou mais de LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet
view

O parâmetro View especifica que conjunto de conteúdos geopolíticos contestados é devolvido através de serviços Azure Maps, incluindo limites e etiquetas apresentados no mapa. O parâmetro Ver (também conhecido como "parâmetro de região do utilizador") mostrará os mapas corretos para esse país/região. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que irá devolver os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN. Consulte As Vistas Suportadas para obter detalhes e ver as Vistas disponíveis.

Propriedades Herdadas

abortSignal

O sinal que pode ser utilizado para abortar pedidos.
customHeaders

{object} [customHeaders] Cabeçalhos de pedido personalizados definidos pelo utilizador que serão aplicados antes do pedido ser enviado.
onDownloadProgress

Chamada de retorno que é acionada após o progresso da transferência.
onUploadProgress

Chamada de retorno que é acionada após o progresso do carregamento.
timeout

O número de milissegundos que um pedido pode tomar antes de ser terminado automaticamente.

Detalhes de Propriedade

allowFreeformNewline

Formato de novas linhas no endereço formatado. Se for verdadeiro, o endereço conterá novas linhas. Se for falso, as novas linhas serão convertidas em vírgulas.

allowFreeformNewline?: boolean

Valor de Propriedade

boolean

entityType

Limita a pesquisa de tipos de entidades geográficas especificados, por exemplo, devolver apenas o município. A resposta resultante conterá o ID geográfico, bem como o tipo de entidade correspondente. Se fornecer mais do que uma entidade como uma lista separada por vírgulas, o ponto final devolverá a "entidade mais pequena disponível". O ID de Geometria devolvido pode ser utilizado para obter a geometria dessa geografia através da API Get Pesquisa Polygon. Os valores possíveis incluem: "Country", "CountrySubdivision", "CountrySecondarySubdivision", "CountryTertiarySubdivision", "Municipality", "MunicipalitySubdivision", "Neighborhood", "PostalCodeArea"

entityType?: EntityType

Valor de Propriedade

EntityType

heading

O cabeçalho direcional do veículo em graus, para viajar ao longo de um segmento de estrada. 0 é Norte, 90 é Leste e assim sucessivamente, os valores variam entre -360 e 360. A precisão pode incluir até uma casa decimal

heading?: number

Valor de Propriedade

number

language

Idioma no qual os resultados da pesquisa devem ser devolvidos. Deve ser uma das etiquetas de linguagem IETF suportadas, não sensível a maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, é utilizado o idioma predefinido. Consulte idiomas suportados para obter detalhes.

language?: string

Valor de Propriedade

string

number

Se um número for enviado juntamente com o pedido, a resposta pode incluir o lado da rua (Esquerda/Direita) e também uma posição de deslocamento para esse número

number?: string

Valor de Propriedade

string

radius

O raio em metros para para que os resultados sejam restritos à área definida

radius?: number

Valor de Propriedade

number

returnMatchType

Inclua informações sobre o tipo de correspondência do geocódigo obtido na resposta.

returnMatchType?: boolean

Valor de Propriedade

boolean

returnRoadUse

Booleano. Para ativar o retorno da matriz de utilização da estrada para reversegeocodes ao nível da rua

returnRoadUse?: boolean

Valor de Propriedade

boolean

returnSpeedLimit

Booleano. Para ativar a devolução do speedlimit publicado

returnSpeedLimit?: boolean

Valor de Propriedade

boolean

roadUse

Para restringir os códigos inversos a um determinado tipo de roaduse. A matriz de utilização de estradas para códigos inversos pode ser uma ou mais de LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet

roadUse?: string

Valor de Propriedade

string

view

O parâmetro View especifica que conjunto de conteúdos geopolíticos contestados é devolvido através de serviços Azure Maps, incluindo limites e etiquetas apresentados no mapa. O parâmetro Ver (também conhecido como "parâmetro de região do utilizador") mostrará os mapas corretos para esse país/região. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que irá devolver os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN. Consulte As Vistas Suportadas para obter detalhes e ver as Vistas disponíveis.

view?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser utilizado para abortar pedidos.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

Herdado de RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Cabeçalhos de pedido personalizados definidos pelo utilizador que serão aplicados antes do pedido ser enviado.

customHeaders?: [key: string]: string

Valor de Propriedade

[key: string]: string

Herdado de RequestOptionsBase.customHeaders

onDownloadProgress

Chamada de retorno que é acionada após o progresso da transferência.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onDownloadProgress

onUploadProgress

Chamada de retorno que é acionada após o progresso do carregamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onUploadProgress

timeout

O número de milissegundos que um pedido pode tomar antes de ser terminado automaticamente.

timeout?: number

Valor de Propriedade

number

Herdado de RequestOptionsBase.timeout