SearchGetSearchAddressReverseOptionalParams interface

  • Referência
Pacote:
azure-maps-rest

Parâmetros opcionais.

Extends

RequestOptionsBase

Propriedades

allowFreeformNewline

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

Restringe a pesquisa de tipos de entidade geography especificados, por exemplo, retornar apenas município. A resposta resultante conterá a ID de geografia, bem como o tipo de entidade correspondente. Se você fornecer mais de uma entidade como uma lista separada por vírgulas, o ponto de extremidade retornará a "menor entidade disponível". A ID de Geometria retornada pode ser usada para obter a geometria dessa geografia por meio da API Obter Pesquisa Polígono. Os valores possíveis incluem: 'Country', 'CountrySubdivision', 'CountrySecondarySubdivision', 'CountryTertiarySubdivision', 'Municipality', 'MunicipalitySubdivision', 'Neighborhood', 'PostalCodeArea'
heading

O título direcional do veículo em graus, para viajar ao longo de um segmento de estrada. 0 é Norte, 90 é Leste e assim por diante, os valores variam de -360 a 360. A precisão pode incluir até um local decimal
language

Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de linguagem IETF com suporte, que não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado. Consulte Idiomas com suporte para obter detalhes.
number

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

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

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

Booliano. Para habilitar o retorno da matriz de uso de estrada para códigos reversos no nível da rua
returnSpeedLimit

Booliano. Para habilitar o retorno do speedlimit postado
roadUse

Para restringir os reversegeocodes a um determinado tipo de uso de estrada. A matriz de uso de estrada para reversegeocodes pode ser uma ou mais de LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet
view

O parâmetro View especifica qual conjunto de conteúdo geopoliticamente disputado é retornado por meio de serviços de Azure Mapas, incluindo bordas e rótulos exibidos no mapa. O parâmetro View (também conhecido como "parâmetro de região do usuário") mostrará os mapas corretos para esse país/região. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro View no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas. Exemplo: view=IN. Consulte Modos de exibição com suporte para obter detalhes e para ver as Exibições disponíveis.

Propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.
customHeaders

{object} [customHeaders] Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação.
onDownloadProgress

Retorno de chamada que é disparado após o progresso do download.
onUploadProgress

Retorno de chamada que é disparado após o progresso do upload.
timeout

O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente.

Detalhes da propriedade

allowFreeformNewline

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

allowFreeformNewline?: boolean

Valor da propriedade

boolean

entityType

Restringe a pesquisa de tipos de entidade geography especificados, por exemplo, retornar apenas município. A resposta resultante conterá a ID de geografia, bem como o tipo de entidade correspondente. Se você fornecer mais de uma entidade como uma lista separada por vírgulas, o ponto de extremidade retornará a "menor entidade disponível". A ID de Geometria retornada pode ser usada para obter a geometria dessa geografia por meio da API Obter Pesquisa Polígono. Os valores possíveis incluem: 'Country', 'CountrySubdivision', 'CountrySecondarySubdivision', 'CountryTertiarySubdivision', 'Municipality', 'MunicipalitySubdivision', 'Neighborhood', 'PostalCodeArea'

entityType?: EntityType

Valor da propriedade

EntityType

heading

O título direcional do veículo em graus, para viajar ao longo de um segmento de estrada. 0 é Norte, 90 é Leste e assim por diante, os valores variam de -360 a 360. A precisão pode incluir até um local decimal

heading?: number

Valor da propriedade

number

language

Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de linguagem IETF com suporte, que não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado. Consulte Idiomas com suporte para obter detalhes.

language?: string

Valor da propriedade

string

number

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

number?: string

Valor da propriedade

string

radius

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

radius?: number

Valor da propriedade

number

returnMatchType

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

returnMatchType?: boolean

Valor da propriedade

boolean

returnRoadUse

Booliano. Para habilitar o retorno da matriz de uso de estrada para códigos reversos no nível da rua

returnRoadUse?: boolean

Valor da propriedade

boolean

returnSpeedLimit

Booliano. Para habilitar o retorno do speedlimit postado

returnSpeedLimit?: boolean

Valor da propriedade

boolean

roadUse

Para restringir os reversegeocodes a um determinado tipo de uso de estrada. A matriz de uso de estrada para reversegeocodes pode ser uma ou mais de LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet

roadUse?: string

Valor da propriedade

string

view

O parâmetro View especifica qual conjunto de conteúdo geopoliticamente disputado é retornado por meio de serviços de Azure Mapas, incluindo bordas e rótulos exibidos no mapa. O parâmetro View (também conhecido como "parâmetro de região do usuário") mostrará os mapas corretos para esse país/região. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro View no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas. Exemplo: view=IN. Consulte Modos de exibição com suporte para obter detalhes e para ver as Exibições disponíveis.

view?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

Herdado de RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação.

customHeaders?: [key: string]: string

Valor da propriedade

[key: string]: string

Herdado de RequestOptionsBase.customHeaders

onDownloadProgress

Retorno de chamada que é disparado após o progresso do download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onDownloadProgress

onUploadProgress

Retorno de chamada que é disparado após o progresso do upload.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onUploadProgress

timeout

O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente.

timeout?: number

Valor da propriedade

number

Herdado de RequestOptionsBase.timeout