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).

Observação: bbox ou central são parâmetros necessários. Eles são mutuamente exclusivos. A caixa de dados não deve ser usada 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 da propriedade

Coordenadas do ponto central em duplo. Formato: 'lon,lat'. Intervalo de longitude: -180 a 180. Intervalo de latitude: -90 a 90.

Observação: os parâmetros central ou bbox são necessários. Eles são mutuamente exclusivos.

center?: number[]

Valor da propriedade

Altura da imagem resultante em pixels. Variam de 80 a 1500. O padrão é 512. Ele não deve ser usado com a caixa de caracteres.

height?: number

Valor da propriedade

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 de idiomas com suporte para obter detalhes.

language?: string

Valor da propriedade

Estilo e locais de caminho (em duplo). Use esse parâmetro para adicionar opcionalmente 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 valores de URL desse parâmetro, pois ele conterá caracteres reservados, como pipes e pontuação.)

O parâmetro Path tem suporte no SKU da conta do Azure Mapas começando com 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 na latitude 45°N e longitude 122°W usando o estilo padrão, adicione o parâmetro querystring

path=ra100||-122 45

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

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

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

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

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

Um polígono é especificado com um caminho fechado, em que 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 locais de linhas e polígonos pode estar no intervalo de -360 a 360 para permitir a renderização de geometrias que cruzam o anti-meridiano.

Modificadores de estilo

Você pode modificar a aparência do caminho adicionando modificadores de estilo. Eles 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 da URL.

Para alterar a cor da estrutura de tópicos, 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 (não há suporte para a forma de três dígitos). Por exemplo, para usar uma cor rosa profunda que você especificaria como #FF1493 no 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 da propriedade

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

O SKU S0 da conta do Azure Mapas dá suporte apenas a uma única instância do parâmetro de pinos e o número de locais é limitado a 5 por pino. Outros SKUs permitem que até 25 instâncias do parâmetro de pinos especifiquem vários estilos de pino e o número de locais é limitado a 50 por pino.

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

pins=default||-122 45

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

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

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

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

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

O SKU da conta do S0 Azure Mapas permite apenas cinco pushpins. Outros 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. Elas são adicionadas 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 da URL.

Para alterar a cor do pino de push, 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 (não há suporte para a forma de três dígitos). Por exemplo, para usar uma cor rosa profunda que você especificaria como #FF1493 no CSS, use

pins=default|coFF1493||-122 45

Rótulos de pushpin

Para adicionar um rótulo aos pinos, coloque o rótulo entre aspas simples 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 interno chamado 'none' que não exibe uma imagem de pushpin. Você pode usar isso se quiser exibir rótulos sem nenhuma imagem de pino. Por exemplo

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

Para alterar a cor dos rótulos de pushpin, use o modificador de estilo de cor do rótulo 'lc'. Por exemplo, para usar pushpins rosas com rótulos pretos, 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 são centralizados na "âncora de rótulo" do pino. O local da âncora é predefinido para pushpins internos e está no centro superior de pinos personalizados (veja abaixo). Para substituir a âncora de rótulo, use o modificador de estilo 'la' e forneça coordenadas de pixel X e Y para a âncora. Essas coordenadas são relativas ao canto superior esquerdo da imagem de pushpin. Os valores X positivos movem a âncora para a direita e os valores Y positivos movem a âncora para baixo. Por exemplo, para posicionar a âncora de rótulo 10 pixels à direita e 4 pixels acima do canto superior esquerdo da imagem de pushpin, use

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

Pinos de push personalizados

Para usar uma imagem de pushpin personalizada, use a palavra "personalizado" como o nome do estilo de pino e especifique uma URL após as informações de localização e rótulo. O tamanho máximo permitido para uma imagem de rótulo 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 se pareceria com

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

Por padrão, as imagens de pushpin personalizadas são desenhadas centralizada nas coordenadas do pino. Isso geralmente não é ideal, pois obscurece o local que você está tentando realçar. Para substituir o local de âncora da imagem de 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 sua imagem de pino personalizada 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

Observação: se você usar o modificador de cores 'co' com uma imagem de pushpin personalizada, a cor especificada substituirá os canais RGB dos pixels na imagem, mas deixará o canal alfa (opacidade) inalterado. Isso normalmente só seria feito com uma imagem personalizada de cor sólida.

Escala, rotação e opacidade

Você pode fazer pushpins e seus rótulos maiores ou menores usando o modificador de estilo de escala 'sc'. Esse é 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 que o normal, use

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

Você pode girar os pinos e seus rótulos usando o modificador de estilo de rotação 'ro'. Esse é 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 pushpins e seus rótulos parcialmente transparentes especificando o modificador de estilo alfa 'al'. Esse é 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 pushpins e seus rótulos apenas 67% opaco, 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 de pino ou uma margem em torno dela. O tamanho da margem é o mínimo da largura e altura do pino.

pins?: string

Valor da propriedade

Estilo de 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 Renderizar 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 da propriedade

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

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

Valor da 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 geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição dessas regiões e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo atenderá. 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 Exibir no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Mapas. Exemplo: view=IN.

Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis.

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

Valor da propriedade

Largura da imagem resultante em pixels. Variam de 80 a 2000. O padrão é 512. Ele não deve ser usado com a caixa de caracteres.

width?: number

Valor da propriedade

Nível de zoom desejado do mapa. Suporte ao intervalo de valor de zoom de 0 a 20 (inclusive) para tilesetId sendo microsoft.base.road ou microsoft.base.darkgrey. Suporte ao intervalo de valor 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 ede grade de bloco.

zoom?: number

Valor da propriedade