RenderGetMapStaticImageQueryParamProperties interface

Uma caixa delimitadora é definida por duas latitudes e duas longitudes que representam os quatro lados de uma área retangular na Terra. Formato: 'minLon, minLat, maxLon, maxLat' (em duplo).

Nota: Bbox ou center são parâmetros obrigatórios. Excluem-se mutuamente. bbox não deve ser usado com altura ou largura.

Os intervalos máximo e mínimo permitidos para Lat e Lon são definidos para cada nível de zoom na tabela na parte superior desta página.

bbox?: number[]

Valor de Propriedade

Coordenadas do ponto central em duplo. Formato: 'lon,lat'. Longitude: -180 a 180. Latitude: -90 a 90.

Nota: O centro ou o bbox são parâmetros obrigatórios. Excluem-se mutuamente.

center?: number[]

Valor de Propriedade

Altura da imagem resultante em pixels. Variam de 80 a 1500. O padrão é 512. Não deve ser usado com bbox.

height?: number

Valor de Propriedade

Idioma em que os resultados da pesquisa devem ser retornados. Deve ser uma das tags de idioma IETF suportadas, sem distinção entre maiúsculas e 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 de idiomas suportados para obter detalhes.

language?: string

Valor de Propriedade

Estilo e locais do caminho (em duplo). Use este parâmetro para, opcionalmente, adicionar linhas, polígonos ou círculos à imagem. O estilo de caminho descreve a aparência da linha e do preenchimento. (Certifique-se de codificar corretamente os valores de URL desse parâmetro, pois ele conterá caracteres reservados, como pipes e pontuação.)

O parâmetro Path é suportado na SKU da conta do Azure Maps a partir de S1. Várias instâncias do parâmetro path permitem especificar várias geometrias com seus estilos. O número de parâmetros por solicitação é limitado a 10 e o número de locais é limitado a 100 por caminho.

Para renderizar um círculo com raio de 100 metros e ponto central em latitude 45°N e longitude 122°W usando o estilo padrão, adicione o parâmetro querystring

path=ra100||-122 45

Note que a longitude vem antes da latitude. Após a codificação de URL, isso será parecido com

path=ra100%7C%7C-122+45

Todos os exemplos aqui mostram o parâmetro path sem codificação de URL, para maior clareza.

Para renderizar uma linha, separe cada local com um caractere de tubo. Por exemplo, use

path=||-122 45|-119.5 43.2|-121.67 47.12

Um polígono é especificado com um caminho fechado, onde o primeiro e o último pontos são iguais. Por exemplo, use

path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45

O valor de longitude para localizações de linhas e polígonos pode estar na faixa de -360 a 360 para permitir a renderização de geometrias cruzando o antimeridiano.

Modificadores de estilo

Você pode modificar a aparência do caminho adicionando modificadores de estilo. Estes são adicionados antes dos locais. Cada um dos modificadores de estilo tem um nome de duas letras. Esses nomes abreviados são usados para ajudar a reduzir o comprimento do URL.

Para alterar a cor do contorno, use o modificador de estilo 'lc' e especifique a cor usando o formato de cor HTML/CSS RGB, que é um número hexadecimal de seis dígitos (o formulário de três dígitos não é suportado). Por exemplo, para usar uma cor rosa profunda que você especificaria como #FF1493 em CSS, use

path=lcFF1493||-122 45|-119.5 43.2

Vários modificadores de estilo podem ser combinados para criar um estilo visual mais complexo.

lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6

Resumo do modificador de estilo

path?: string

Valor de Propriedade

Estilo e ocorrências de pinos. Use este parâmetro para, opcionalmente, adicionar pinos à imagem. O estilo de pino descreve a aparência dos pinos, e as ocorrências especificam as coordenadas dos pinos (em duplo) e rótulos opcionais para cada pino. (Certifique-se de codificar corretamente os valores de URL desse parâmetro, pois ele conterá caracteres reservados, como pipes e pontuação.)

A conta S0 SKU do Azure Maps suporta apenas uma única instância do parâmetro pins e o número de localizações está limitado a 5 por pino. Outros SKUs permitem até 25 instâncias do parâmetro pins para especificar vários estilos de pinos, e o número de locais é limitado a 50 por pino.

Para renderizar um pino de pino em latitude 45°N e longitude 122°W usando o estilo de pino interno padrão, adicione o parâmetro querystring

pins=default||-122 45

Note que a longitude vem antes da latitude. Após a codificação de URL, isso será parecido com

pins=default%7C%7C-122+45

Todos os exemplos aqui mostram o parâmetro pins sem codificação de URL, para maior clareza.

Para renderizar um pino em vários locais, separe cada local com um caractere de tubo. Por exemplo, use

pins=default||-122 45|-119.5 43.2|-121.67 47.12

O SKU da conta do Azure Maps S0 permite apenas cinco pinos. Outras SKUs de conta não têm essa limitação.

Modificadores de estilo

Você pode modificar a aparência dos pinos adicionando modificadores de estilo. Estes são adicionados após o estilo, mas antes dos locais e rótulos. Cada um dos modificadores de estilo tem um nome de duas letras. Esses nomes abreviados são usados para ajudar a reduzir o comprimento do URL.

Para alterar a cor do pino, use o modificador de estilo 'co' e especifique a cor usando o formato de cor HTML/CSS RGB, que é um número hexadecimal de seis dígitos (o formulário de três dígitos não é suportado). Por exemplo, para usar uma cor rosa profunda que você especificaria como #FF1493 em CSS, use

pins=default|coFF1493||-122 45

Etiquetas de pinos

Para adicionar um rótulo aos pinos, coloque-o entre aspas simples imediatamente antes das coordenadas. Evite usar caracteres especiais, como | ou || no rótulo. Por exemplo, para rotular três pinos com os valores '1', '2' e '3', use

pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12

Há um estilo de pino embutido chamado 'nenhum' que não exibe uma imagem de pino. Você pode usar isso se quiser exibir rótulos sem qualquer imagem de pino. Por exemplo

pins=none||'A'-122 45|'B'-119.5 43.2

Para alterar a cor dos rótulos de pino, use o modificador de estilo de cor do rótulo 'lc'. Por exemplo, para usar pinos rosa com etiquetas pretas, use

pins=default|coFF1493|lc000000||-122 45

Para alterar o tamanho dos rótulos, use o modificador de estilo de tamanho de rótulo 'ls'. O tamanho do rótulo representa a altura aproximada do texto do rótulo em pixels. Por exemplo, para aumentar o tamanho do rótulo para 12, use

pins=default|ls12||'A'-122 45|'B'-119 43

Os rótulos estão centrados no pino "âncora do rótulo". O local da âncora é predefinido para pinos embutidos e está no centro superior dos pinos personalizados (veja abaixo). Para substituir a âncora do rótulo, use o modificador de estilo 'la' e forneça as coordenadas de pixel X e Y para a âncora. Essas coordenadas são relativas ao canto superior esquerdo da imagem do pino. Os valores X positivos movem a âncora para a direita e os valores positivos Y movem a âncora para baixo. Por exemplo, para posicionar a âncora do rótulo 10 pixels à direita e 4 pixels acima do canto superior esquerdo da imagem de pino, use

pins=default|la10 -4||'A'-122 45|'B'-119 43

Pinos personalizados

Para usar uma imagem de pino personalizada, use a palavra 'personalizada' como o nome do estilo de pino e especifique uma URL após as informações de local e rótulo. O tamanho máximo permitido para uma imagem de etiqueta personalizada é de 65.536 pixels. Use dois caracteres de pipe para indicar que você terminou de especificar locais e está iniciando a URL. Por exemplo

pins=custom||-122 45||http://contoso.com/pushpins/red.png

Após a codificação de URL, isso seria parecido com

pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png

Por padrão, as imagens de pino personalizadas são desenhadas centralizadas nas coordenadas do pino. Isso geralmente não é o ideal, pois obscurece o local que você está tentando destacar. Para substituir o local da âncora da imagem do pino, use o modificador de estilo 'an'. Isso usa o mesmo formato que o modificador de estilo de âncora de rótulo 'la'. Por exemplo, se a imagem do pino personalizado tiver a ponta do pino no canto superior esquerdo da imagem, você poderá definir a âncora para esse ponto usando

pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png

Nota: Se você usar o modificador de cor 'co' com uma imagem de pino personalizada, a cor especificada substituirá os canais RGB dos pixels na imagem, mas deixará o canal alfa (opacidade) inalterado. Isso geralmente só seria feito com uma imagem personalizada de cor sólida.

Escala, rotação e opacidade

Você pode fazer pinos e seus rótulos maiores ou menores usando o modificador de estilo de escala 'sc'. Este é um valor maior que zero. Um valor de 1 é a escala padrão. Valores maiores que 1 tornarão os pinos maiores e valores menores que 1 os tornarão menores. Por exemplo, para desenhar os pinos 50% maiores do que o normal, use

pins=default|sc1.5||-122 45

Você pode girar pinos e seus rótulos usando o modificador de estilo de rotação 'ro'. Este é um número de graus de rotação no sentido horário. Use um número negativo para girar no sentido anti-horário. Por exemplo, para girar os pinos 90 graus no sentido horário e dobrar seu tamanho, use

pins=default|ro90|sc2||-122 45

Você pode tornar os pinos e seus rótulos parcialmente transparentes especificando o modificador de estilo alfa 'al'. Este é um número entre 0 e 1 que indica a opacidade dos pinos. Zero torna-os completamente transparentes (e não visíveis) e 1 torna-os completamente opacos (que é o padrão). Por exemplo, para fazer pinos e suas etiquetas apenas 67% opacos, use

pins=default|al.67||-122 45

Resumo do modificador de estilo

• As coordenadas X e Y podem estar em qualquer lugar dentro da imagem do pino ou uma margem ao redor dela. O tamanho da margem é o mínimo da largura e altura do pino.

pins?: string

Valor de Propriedade

Estilo do mapa a ser retornado. Os valores possíveis são microsoft.base.road, microsoft.base.darkgrey e microsoft.imagery. O valor padrão é definido como microsoft.base.road. Para obter mais informações, consulte Render TilesetId.

tilesetId?: "microsoft.base" | "microsoft.base.labels" | "microsoft.base.hybrid" | "microsoft.terra.main" | "microsoft.base.road" | "microsoft.base.darkgrey" | "microsoft.base.labels.road" | "microsoft.base.labels.darkgrey" | "microsoft.base.hybrid.road" | "microsoft.base.hybrid.darkgrey" | "microsoft.imagery" | "microsoft.weather.radar.main" | "microsoft.weather.infrared.main" | "microsoft.traffic.absolute" | "microsoft.traffic.absolute.main" | "microsoft.traffic.relative" | "microsoft.traffic.relative.main" | "microsoft.traffic.relative.dark" | "microsoft.traffic.delay" | "microsoft.traffic.delay.main" | "microsoft.traffic.reduced.main" | "microsoft.traffic.incident"

Valor de Propriedade

Valor opcional, indicando que nenhum fluxo de tráfego sobreposto no resultado da imagem. Os valores possíveis são microsoft.traffic.relative.main e none. O valor padrão é none, indicando que nenhum fluxo de tráfego retornado. Se tilesetId relacionado ao tráfego for fornecido, retornará a imagem do mapa com a camada de tráfego correspondente. Para obter mais informações, consulte Render TilesetId.

trafficLayer?: "microsoft.traffic.relative.main" | "none"

Valor de Propriedade

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 geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. 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 Exibir no Azure Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN.

Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.

view?: "AE" | "AR" | "BH" | "IN" | "IQ" | "JO" | "KW" | "LB" | "MA" | "OM" | "PK" | "PS" | "QA" | "SA" | "SY" | "YE" | "Auto" | "Unified"

Valor de Propriedade

Largura da imagem resultante em pixels. Intervalo de 80 a 2000. O padrão é 512. Não deve ser utilizado com bbox.

width?: number

Valor de Propriedade

Nível de zoom desejado do mapa. O valor de zoom de suporte varia de 0 a 20 (inclusive) para tilesetId sendo microsoft.base.road ou microsoft.base.darkgrey. Suporte a intervalo de valores de zoom de 0 a 19 (inclusive) para tilesetId sendo microsoft.imagery. O valor padrão é 12.

Para obter mais informações, consulte Níveis de zoom e Grade de blocos.

zoom?: number

Valor de Propriedade