Share via

RenderURL class

  • Referência
Pacote:
azure-maps-rest

Uma RenderURL representa uma URL para as operações de renderização Azure Mapas.

Extends
MapsURL

Construtores

RenderURL(Pipeline, string)

Cria uma instância do RenderURL.

Propriedades herdadas

mapsUrl

Valor da cadeia de caracteres de URL base.

Métodos

getMapImage(Aborter, GetMapImageOptions)

Renderiza uma imagem retangular definida pelo usuário que contém uma seção de mapa usando um nível de zoom de 0 a 20. O serviço de imagem estática renderiza uma imagem retangular definida pelo usuário que contém uma seção de mapa usando um nível de zoom de 0 a 20. O intervalo de resolução com suporte para a imagem de mapa é de 1x1 a 8192x8192. Se você estiver decidindo quando usar o serviço de imagem estática no serviço de bloco do mapa, talvez queira considerar como gostaria de interagir com o mapa renderizado. Se o conteúdo do mapa for relativamente inalterado, um mapa estático será uma boa opção. Se você quiser dar suporte a muito zoom, movimento panorâmico e alteração do conteúdo do mapa, o serviço de bloco do mapa seria uma opção melhor. O serviço também fornece a funcionalidade de Composição de Imagem para obter uma imagem estática de volta com dados adicionais, como; pushpins e sobreposições de geometria com os seguintes recursos S0 e S1.

No S0, você pode:

  • Renderizar até 5 pinos especificados na solicitação
  • Fornecer uma imagem personalizada para os pinos referenciados na solicitação
  • Adicionar rótulos aos pinos

No S1, você pode:

Consulte How-to-Guide para obter exemplos detalhados.

Observação : o parâmetro central ou bbox deve ser fornecido à API.

Os intervalos Lat e Lon com suporte ao usar o parâmetro bbox são os seguintes:

Nível de zoom Intervalo máximo de lon Intervalo Máximo de Lat
0 360.0 170.0
1 360.0 170.0
2 360.0 170.0
3 360.0 170.0
4 360.0 170.0
5 180.0 85,0
6 90.0 42,5
7 45.0 21.25
8 22,5 10.625
9 11,25 5.3125
10 5.625 2.62625
11 2.8125 1.328125
12 1.40625 0.6640625
13 0.703125 0.33203125
14 0.3515625 0.166015625
15 0.17578125 0.0830078125
16 0.087890625 0.0415039063
17 0.0439453125 0.0207519531
18 0.0219726563 0.0103759766
19 0.0109863281 0.0051879883
20 0.0054931641 0.0025939941

Usa a API Obter Imagem do Mapa: https://docs.microsoft.com/rest/api/maps/render/getmapimage
getMapImageryTile(Aborter, number, number, number)

Retorna um bloco de imagem de mapa com tamanho 256x256, considerando as coordenadas x e y e o nível de zoom. Intervalos de nível de zoom de 0 a 18. O valor de estilo disponível atual é "satélite", que fornece apenas imagens de satélite. Usa a API obter bloco de imagens de mapa: https://docs.microsoft.com/rest/api/maps/render/getmapimagerytile
getMapTile(Aborter, TileFormat, MapTileLayer, MapTileStyle, number, number, number, GetMapTileOptions)

Retorna um mapa de blocos no formato vetor ou de varredura normalmente a serem integrados a um novo controle de mapa ou SDK. Por padrão, o Azure usa blocos de mapa de vetor para seu controle de mapa da Web (consulte Níveis de Zoom e Grade de Bloco) Usa a API Obter Bloco de Mapa: https://docs.microsoft.com/rest/api/maps/render/getmaptile

Métodos herdados

newPipeline(Credential, INewPipelineOptions)

Um método estático usado para criar um novo objeto Pipeline com a Credencial fornecida.

Detalhes do construtor

RenderURL(Pipeline, string)

Cria uma instância do RenderURL.

new RenderURL(pipeline: Pipeline, mapsUrl?: string)

Parâmetros

pipeline
Pipeline

Chame MapsURL.newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.

mapsUrl

string

Uma cadeia de caracteres de URL que aponta para Azure Mapas serviço, o padrão é "https://atlas.microsoft.com". Se nenhum protocolo for especificado, por exemplo "atlas.microsoft.com", , será https assumido.

Detalhes das propriedades herdadas

mapsUrl

Valor da cadeia de caracteres de URL base.

mapsUrl: string

Valor da propriedade

string

Herdado deMapsURL.mapsUrl

Detalhes do método

getMapImage(Aborter, GetMapImageOptions)

Renderiza uma imagem retangular definida pelo usuário que contém uma seção de mapa usando um nível de zoom de 0 a 20. O serviço de imagem estática renderiza uma imagem retangular definida pelo usuário que contém uma seção de mapa usando um nível de zoom de 0 a 20. O intervalo de resolução com suporte para a imagem de mapa é de 1x1 a 8192x8192. Se você estiver decidindo quando usar o serviço de imagem estática no serviço de bloco do mapa, talvez queira considerar como gostaria de interagir com o mapa renderizado. Se o conteúdo do mapa for relativamente inalterado, um mapa estático será uma boa opção. Se você quiser dar suporte a muito zoom, movimento panorâmico e alteração do conteúdo do mapa, o serviço de bloco do mapa seria uma opção melhor. O serviço também fornece a funcionalidade de Composição de Imagem para obter uma imagem estática de volta com dados adicionais, como; pushpins e sobreposições de geometria com os seguintes recursos S0 e S1.

No S0, você pode:

  • Renderizar até 5 pinos especificados na solicitação
  • Fornecer uma imagem personalizada para os pinos referenciados na solicitação
  • Adicionar rótulos aos pinos

No S1, você pode:

Consulte How-to-Guide para obter exemplos detalhados.

Observação : o parâmetro central ou bbox deve ser fornecido à API.

Os intervalos Lat e Lon com suporte ao usar o parâmetro bbox são os seguintes:

Nível de zoom Intervalo máximo de lon Intervalo Máximo de Lat
0 360.0 170.0
1 360.0 170.0
2 360.0 170.0
3 360.0 170.0
4 360.0 170.0
5 180.0 85,0
6 90.0 42,5
7 45.0 21.25
8 22,5 10.625
9 11,25 5.3125
10 5.625 2.62625
11 2.8125 1.328125
12 1.40625 0.6640625
13 0.703125 0.33203125
14 0.3515625 0.166015625
15 0.17578125 0.0830078125
16 0.087890625 0.0415039063
17 0.0439453125 0.0207519531
18 0.0219726563 0.0103759766
19 0.0109863281 0.0051879883
20 0.0054931641 0.0025939941

Usa a API Obter Imagem do Mapa: https://docs.microsoft.com/rest/api/maps/render/getmapimage

function getMapImage(aborter: Aborter, options: GetMapImageOptions): Promise<GetMapImageResponse>

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), documentos goto do Aborter para obter mais exemplos sobre cancelamento de solicitação.

options
GetMapImageOptions

Retornos

Promise<GetMapImageResponse>

getMapImageryTile(Aborter, number, number, number)

Retorna um bloco de imagem de mapa com tamanho 256x256, considerando as coordenadas x e y e o nível de zoom. Intervalos de nível de zoom de 0 a 18. O valor de estilo disponível atual é "satélite", que fornece apenas imagens de satélite. Usa a API obter bloco de imagens de mapa: https://docs.microsoft.com/rest/api/maps/render/getmapimagerytile

function getMapImageryTile(aborter: Aborter, zoom: number, xTileIndex: number, yTileIndex: number): Promise<GetMapImageryTileResponse>

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), documentos goto do Aborter para obter mais exemplos sobre cancelamento de solicitação.

zoom

number

Nível de zoom para o bloco desejado. O valor de zoom deve estar no intervalo: 0-18 (inclusivo).

Consulte Níveis de Zoom e Grade de Blocos para obter detalhes.

xTileIndex

number

Coordenada X do bloco na grade de zoom. O valor deve estar no intervalo [0, 2zoom -1].

Consulte Níveis de Zoom e Grade de Blocos para obter detalhes.

yTileIndex

number

Coordenada Y do bloco na grade de zoom. O valor deve estar no intervalo [0, 2zoom -1].

Consulte Níveis de Zoom e Grade de Blocos para obter detalhes.

Retornos

Promise<GetMapImageryTileResponse>

getMapTile(Aborter, TileFormat, MapTileLayer, MapTileStyle, number, number, number, GetMapTileOptions)

Retorna um mapa de blocos no formato vetor ou de varredura normalmente a serem integrados a um novo controle de mapa ou SDK. Por padrão, o Azure usa blocos de mapa de vetor para seu controle de mapa da Web (consulte Níveis de Zoom e Grade de Bloco) Usa a API Obter Bloco de Mapa: https://docs.microsoft.com/rest/api/maps/render/getmaptile

function getMapTile(aborter: Aborter, format: TileFormat, layer: MapTileLayer, style: MapTileStyle, zoom: number, xTileIndex: number, yTileIndex: number, options?: GetMapTileOptions): Promise<GetMapTileResponse>

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), documentos goto do Aborter para obter mais exemplos sobre cancelamento de solicitação.

format
TileFormat

Formato desejado da resposta. Os valores possíveis são png & pbf. Os valores possíveis incluem: 'png', 'pbf'

layer
MapTileLayer

Camada de mapa solicitada. Os valores possíveis são básicos, híbridos, rótulos e terra. Os valores possíveis incluem: 'basic', 'hybrid', 'labels', 'terra'

style
MapTileStyle

Estilo de mapa a ser retornado. Os valores possíveis são main & shaded_relief. Os valores possíveis incluem: 'main', 'shaded_relief'

zoom

number

Nível de zoom para o bloco desejado. Para blocos de varredura , o valor deve estar no intervalo: 0 a 18 (inclusivo). Blocos de varredura terra, os valores devem estar no intervalo de 0 a 6 (inclusivo). Para blocos vetoriais , o valor deve estar no intervalo: 0-22 (inclusivo).

Consulte Níveis de Zoom e Grade de Blocos para obter detalhes.

xTileIndex

number

Coordenada X do bloco na grade de zoom. O valor deve estar no intervalo [0, 2zoom -1].

Consulte Níveis de Zoom e Grade de Blocos para obter detalhes.

yTileIndex

number

Coordenada Y do bloco na grade de zoom. O valor deve estar no intervalo [0, 2zoom -1].

Consulte Níveis de Zoom e Grade de Blocos para obter detalhes.

options
GetMapTileOptions

Retornos

Promise<GetMapTileResponse>

Detalhes do método herdado

newPipeline(Credential, INewPipelineOptions)

Um método estático usado para criar um novo objeto Pipeline com a Credencial fornecida.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline

Parâmetros

credential
Credential

Como SubscriptionKeyCredential, TokenCredential e MapControlCredential.

pipelineOptions
INewPipelineOptions

Retornos

Pipeline

Um novo objeto Pipeline.

Herdado deMapsURL.newPipeline