atlas module

Pacote:

azure-maps-control

Classes

EventManager	Um gerente para os eventos do controle de mapa. Exposto por meio da propriedade de eventos do atlas. Classe de mapa. Não é possível criar uma instância pelo usuário.
HtmlMarker	Essa classe encapsula um elemento HTML que pode ser exibido no mapa.
Map	O controle de um mapa da Web visual e interativo.
Pixel	Represente uma coordenada de pixel ou deslocamento. Estende uma matriz de [x, y].
Popup	Uma janela de informações ancorada em uma posição especificada em um mapa.
PopupTemplate	Um modelo de layout para um pop-up.
Shape	Uma classe auxiliar que encapsula um Recurso ou Geometria e facilita a atualização e a manutenção.

Interfaces

AggregateExpression	Uma expressão de agregação define um cálculo que é processado em um conjunto de dados. Esquema: [operador: string, initialValue?: boolean | number, mapExpression: Expression] operator: uma função de expressão que é então aplicada a todos os valores calculados pelo mapExpression para cada ponto no cluster. Operadores com suporte: o Para números: +, *, max, min o For Booleans: all, any initialValue: Optional, um valor inicial no qual o primeiro valor calculado é agregado. mapExpression: uma expressão que é aplicada em cada ponto no conjunto de dados.
AnimationOptions	As opções para animar alterações na câmera do controle de mapa.
AuthenticationManager	Um gerente para a autenticação do controle de mapa. Exposto por meio da propriedade de autenticação do atlas. Classe de mapa. Não é possível criar uma instância pelo usuário.
AuthenticationOptions	Opções para especificar como o controle de mapa deve se autenticar com os serviços do Azure Mapas.
BubbleLayerOptions	Opções usadas ao renderizar objetos Point em um BubbleLayer.
CameraBoundsOptions	As opções para definir os limites da câmera do controle de mapa.
CameraOptions	As opções para definir a câmera do controle de mapa.
ClusteredProperties	As propriedades que existirão para ClusteredProperties
CompassControlOptions	As opções para um objeto CompassControl.
Control	Uma interface para definir um controle do mapa.
ControlManager	Um gerente para os controles do controle de mapa. Exposto por meio da propriedade de controles do atlas. Classe de mapa. Não é possível criar uma instância pelo usuário.
ControlOptions	As opções para adicionar um controle ao mapa.
DataSourceOptions	Uma fonte de dados para gerenciar dados de forma que serão exibidos no mapa. Uma fonte de dados deve ser adicionada a uma camada antes de ficar visível no mapa. Opções para um DataSourceOptions.
ElevationTileSourceOptions
FullscreenControlOptions	As opções para um objeto FullscreenControl.
HeatMapLayerOptions	Opções usadas ao renderizar objetos Point em um HeatMapLayer.
HtmlMarkerEvents
HtmlMarkerManager	Um gerente para os marcadores HTML do controle de mapa. Exposto por meio da propriedade de marcadores do atlas. Classe de mapa. Não é possível criar uma instância pelo usuário.
HtmlMarkerOptions	Opções para renderizar um objeto HtmlMarker
HyperLinkFormatOptions	Opção de formato para cadeias de caracteres de hiperlink.
IconOptions	Opções usadas para personalizar os ícones em um SymbolLayer
ImageLayerOptions	Opções usadas ao renderizar objetos Point em um ImageLayer.
ImageSpriteManager	Um gerente para o sprite de imagem do controle de mapa. Exposto por meio da propriedade imageSprite do atlas. Classe de mapa. Não é possível criar uma instância pelo usuário.
LayerManager	Um gerente para as camadas do controle de mapa. Exposto por meio da propriedade de camadas do atlas. Classe de mapa. Não é possível criar uma instância pelo usuário.
LayerOptions	Uma classe base da qual todas as outras opções de camada herdam.
LightOptions	As opções para a iluminação do mapa.
LineLayerOptions	Opções usadas ao renderizar objetos SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon e MultiPolygon em uma camada de linha.
MapConfiguration	Representa o conteúdo da configuração do mapa que contém uma lista de estilos disponíveis para eles.
MapConfigurationStyle	Representa as informações de um único estilo.
MapDataEvent	Objeto de evento retornado pelos mapas quando ocorre um evento de dados.
MapErrorEvent	Objeto de evento retornado pelos mapas quando ocorre um evento de erro.
MapEvent	Objeto de evento retornado pelos mapas quando ocorre um evento básico.
MapMouseEvent	Objeto de evento retornado pelos mapas quando ocorre um evento do mouse.
MapMouseWheelEvent	Objeto de evento retornado pelos mapas quando ocorre um evento de roda.
MapTouchEvent	Objeto de evento retornado pelos mapas quando ocorre um evento de toque.
MediaLayerOptions	Opções usadas ao renderizar camadas de tela, imagem, bloco de raster e vídeo
Options
Padding	Represente a quantidade de preenchimento em pixels a serem adicionados ao lado de um BoundingBox ao definir a câmera de um mapa.
PitchControlOptions	As opções de um objeto PitchControl.
PolygonExtrusionLayerOptions	Opções usadas ao renderizar objetos Polygon e MultiPolygon em um PolygonExtrusionLayer.
PolygonLayerOptions	Opções usadas ao renderizar objetos Polygon e MultiPolygon em um PolygonLayer.
PopupEvents
PopupManager	Um gerente para pop-ups do controle de mapa. Exposto por meio da propriedade popups da classe atlas.Map. Não é possível criar uma instância pelo usuário.
PopupOptions	As opções para um pop-up.
Properties	Um conjunto de propriedades que podem ser usadas com um PopupTemplate
PropertyInfo	Detalhes da espécie de como uma propriedade deve ser exibida.
RasterTileSourceOptions
RequestParameters	Esse é o tipo de objeto esperado para ser retornado pelo retorno de chamada transformRequest.
ScaleControlOptions	As opções de um objeto ScaleControl.
ServiceOptions	Propriedades globais usadas em todas as solicitações de serviço atlas.
ShapeEvents
SourceManager	Um gerente para as fontes do controle de mapa. Exposto por meio da propriedade de fontes do atlas. Classe de mapa. Não é possível criar uma instância pelo usuário.
StyleChangedEvent	Objeto de evento retornado pelo mapa depois de carregar um novo estilo.
StyleControlOptions	As opções para um objeto StyleControl.
StyleOptions	As opções para o estilo do mapa.
SymbolLayerOptions	Opções usadas ao renderizar geometrias em um SymbolLayer.
TargetedEvent
TextOptions	Opções usadas para personalizar o texto em um SymbolLayer
Tile	Objeto de bloco retornado pelo mapa quando ocorre um evento de dados de origem.
TileId
TileLayerOptions	Opções usadas ao renderizar imagens em bloco de raster em um TileLayer.
TrafficControlOptions
TrafficOptions	As opções para definir o tráfego no mapa.
UserInteractionOptions	As opções para habilitar/desabilitar a interação do usuário com o mapa.
VectorTileSourceOptions	Uma fonte de dados para gerenciar dados de forma que serão exibidos no mapa. Uma fonte de dados deve ser adicionada a uma camada antes de ficar visível no mapa. Opções para um VectorTileSource.
WebGLLayerOptions	Opções usadas para renderizar gráficos em um WebGLLayer.
WebGLRenderer	Interface para renderizar gráficos WebGL em um WebGLLayer.
ZoomControlOptions	As opções para um objeto ZoomControl.

Aliases de tipo

Expression	Pode ser especificado como o valor do filtro ou determinadas opções de camada. Uma expressão define uma fórmula para calcular o valor da propriedade. As expressões são representadas como matrizes JSON. O primeiro elemento de uma expressão é uma cadeia de caracteres nomeando o operador de expressão.
getAuthTokenCallback	A função de retorno de chamada usada para adquirir um token de autenticação no modo de autenticação anônima. Resolva com o token de autenticação ou rejeite com quaisquer erros.
ResourceType
StyleImageMetadata	Assinatura do parâmetro options passado para ImageSpriteManager.add.

Enumerações

AuthenticationType	Uma enumeração usada para especificar o tipo de mecanismo de autenticação a ser usado.
ControlPosition	Posições em que o controle pode ser colocado no mapa.
ControlStyle	Estilos disponíveis para um controle.

Funções

addImageTemplate(string, string, boolean)	Adiciona um modelo de imagem ao namespace atlas.
addProtocol(string, (args: any[]) => Promise<any>)	Adiciona uma função de recurso de carga personalizada que será chamada ao usar uma URL que começa com um esquema de URL personalizado.
clearPrewarmedResources()	Limpa os recursos que foram criados anteriormente pelo atlas.prewarm(). Observe que isso normalmente não é necessário. Você só deverá chamar essa função se espera que o usuário do aplicativo não retorne a uma exibição de mapa em nenhum momento do aplicativo.
getAllImageTemplateNames()	Recupera uma matriz de nomes para todos os modelos de imagem que estão disponíveis no namespace atlas.
getAuthenticationOptions()	Obtém as opções de autenticação padrão fornecidas. Se não for definido anteriormente, todas as propriedades serão indefinidas.
getDomain()	Obtém o domínio padrão fornecido. Se não tiver definido anteriormente, o valor padrão será "atlas.microsoft.com".
getImageTemplate(string, number)	Recupera um modelo SVG por nome.
getLanguage()	Obtém o idioma padrão fornecido. Se não tiver definido anteriormente, o valor padrão será "NGT".
getMaxParallelImageRequests()	Obtém o número máximo de imagens (blocos de raster, sprites, ícones) para carregar em paralelo
getSessionId()	Obtém a ID de sessão padrão fornecida. Se não for definido anteriormente, o valor padrão será uma UUID aleatória.
getSubscriptionKey()	Obtém a chave de assinatura padrão do Azure Mapas fornecida.
getUserRegion()
getVersion()	Número de versão da API atual com base no número de build.
getView()	Obtém a configuração de exibição padrão do controle de mapa. Se não tiver definido anteriormente, o valor padrão será undefined.
getWorkerCount()	Obtém a contagem de trabalho que será criada.
isSupported(boolean)	Verifica se o navegador do usuário tem suporte no controle de mapa.
prewarm()	Inicializa recursos como WebWorkers que podem ser compartilhados entre mapas para reduzir os tempos de carga em algumas situações. atlas.setWorkerCount, se estiver sendo usado, deve ser definido antes que prewarm() seja chamado para ter um efeito. Por padrão, o ciclo de vida desses recursos é gerenciado automaticamente e eles são inicializados lentamente quando um Mapa é criado pela primeira vez. Invocando prewarm(), esses recursos serão criados com antecedência e não serão limpos quando o último Mapa for removido da página. Isso permite que eles sejam reutilizá-los por novas instâncias do Mapa que são criadas posteriormente. Eles podem ser limpos manualmente chamando atlas.clearPrewarmedResources(). Isso só será necessário se sua página da Web permanecer ativa, mas parar de usar mapas completamente. Isso é útil principalmente ao usar mapas de GL-JS em um aplicativo de página única, em que um usuário navegaria entre várias exibições que podem fazer com que as instâncias do Mapa sejam constantemente criadas e destruídas.
removeProtocol(string)	Remove um protocolo adicionado anteriormente no thread principal.
setAuthenticationOptions(AuthenticationOptions)	Define suas opções de autenticação como as opções padrão no namespace atlas que é usado pelo controle de mapa e todos os módulos que fazem solicitações para os serviços de mapas do Azure. Se um mapa for inicializado com as opções de autenticação definidas explicitamente e setAuthenticationOptions não tiver sido chamado anteriormente, ele será automaticamente chamado pelo construtor map.
setDomain(string)	Define o domínio padrão usado pelos módulos de mapa e serviço, a menos que o domínio seja especificado explicitamente ao usar essas partes da API. Se um mapa for inicializado com o domínio definido explicitamente e setDomain não tiver sido chamado anteriormente, ele será automaticamente chamado pelo construtor map. Se o protocolo não for especificado https será assumido.
setLanguage(string)	Define o idioma padrão usado pelos módulos de mapa e serviço, a menos que o idioma seja especificado explicitamente ao usar essas partes da API. Se um mapa for inicializado com o idioma definido explicitamente e setLanguage não tiver sido chamado anteriormente, ele será automaticamente chamado pelo construtor mapa.
setMaxParallelImageRequests(number)	Define o número máximo de imagens (blocos de raster, sprites, ícones) a serem carregadas em paralelo, o que afeta o desempenho em mapas pesados de raster. 16 por padrão.
setSessionId(string)	Define a ID de sessão padrão usada pelos módulos de mapa e serviço, a menos que a ID da sessão seja especificada explicitamente ao usar essas partes da API. Se um mapa for inicializado com a ID da sessão definida explicitamente e setSessionId não tiver sido chamado anteriormente, ele será automaticamente chamado pelo construtor map.
setSubscriptionKey(string)	Define sua chave de assinatura do Azure Mapas como a chave de assinatura padrão no namespace atlas que é usado pelo controle de mapa e por todos os módulos que fazem solicitações para os serviços de mapas do Azure. Se um Mapa for inicializado com a chave de assinatura definida explicitamente e setSubscriptionKey não tiver sido chamado anteriormente, ele será chamado automaticamente pelo construtor map.
setUserRegion(string)
setView(string)	Especifica qual conjunto de bordas e rótulos geopolíticos são exibidos no mapa. O parâmetro View (também conhecido como "parâmetro de região do usuário") é um código de país ISO-3166 de 2 letras que mostrará os mapas corretos para esse país/região. País/regiões que não estão na lista De exibição ou se não for especificado serão padrão para o Modo de Exibição "Unificado". Consulte o suporte [Views]{@link https://aka.ms/AzureMapsLocalizationViews }. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. 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.
setWorkerCount(number)	Define o número de trabalhos web instanciados em uma página. Por padrão, ele é definido como metade do número de núcleos de CPU (limitado a 6).

Detalhes da função

addImageTemplate(string, string, boolean)

Adiciona um modelo de imagem ao namespace atlas.

function addImageTemplate(templateName: string, template: string, override: boolean)

Parâmetros

templateName

string

O nome do modelo.

template

string

O modelo SVG a ser adicionado. Dá suporte a {color}, {secondaryColor}, {scale}, {text}.

override

boolean

Especifica se ele deve substituir os modelos existentes se já existir um com o mesmo nome.

addProtocol(string, (args: any[]) => Promise<any>)

Adiciona uma função de recurso de carga personalizada que será chamada ao usar uma URL que começa com um esquema de URL personalizado.

function addProtocol(customProtocol: string, loadFn: (args: any[]) => Promise<any>)

Parâmetros

customProtocol

string

o protocolo a ser enganchar, por exemplo, 'personalizado'

loadFn

(args: any[]) => Promise<any>

a função a ser usada ao tentar buscar um bloco especificado pelo customProtocol

clearPrewarmedResources()

Limpa os recursos que foram criados anteriormente pelo atlas.prewarm(). Observe que isso normalmente não é necessário. Você só deverá chamar essa função se espera que o usuário do aplicativo não retorne a uma exibição de mapa em nenhum momento do aplicativo.

function clearPrewarmedResources()

getAllImageTemplateNames()

Recupera uma matriz de nomes para todos os modelos de imagem que estão disponíveis no namespace atlas.

function getAllImageTemplateNames(): string[]

Retornos

string[]

getAuthenticationOptions()

Obtém as opções de autenticação padrão fornecidas. Se não for definido anteriormente, todas as propriedades serão indefinidas.

function getAuthenticationOptions(): AuthenticationOptions

Retornos

AuthenticationOptions

getDomain()

Obtém o domínio padrão fornecido. Se não tiver definido anteriormente, o valor padrão será "atlas.microsoft.com".

function getDomain(): string

Retornos

string

getImageTemplate(string, number)

Recupera um modelo SVG por nome.

function getImageTemplate(templateName: string, scale?: number): string

Parâmetros

templateName

string

O nome do modelo a ser recuperado.

scale

number

Especifica o quanto dimensionar o modelo. Para obter melhores resultados, dimensione o ícone para o tamanho máximo que você deseja exibir no mapa e, em seguida, use a opção de tamanho do ícone de camadas de símbolo para reduzir verticalmente, se necessário. Isso reduzirá a desfoque devido ao dimensionamento. Padrão: 1

Retornos

string

getLanguage()

Obtém o idioma padrão fornecido. Se não tiver definido anteriormente, o valor padrão será "NGT".

function getLanguage(): string

Retornos

string

getMaxParallelImageRequests()

Obtém o número máximo de imagens (blocos de raster, sprites, ícones) para carregar em paralelo

function getMaxParallelImageRequests(): number

Retornos

number

getSessionId()

Obtém a ID de sessão padrão fornecida. Se não for definido anteriormente, o valor padrão será uma UUID aleatória.

function getSessionId(): string

Retornos

string

getSubscriptionKey()

Obtém a chave de assinatura padrão do Azure Mapas fornecida.

function getSubscriptionKey(): string

Retornos

string

getUserRegion()

Aviso

Essa API foi preterida.

use atlas.getView() instead

function getUserRegion(): string

Retornos

string

getVersion()

Número de versão da API atual com base no número de build.

function getVersion(): string

Retornos

string

getView()

Obtém a configuração de exibição padrão do controle de mapa. Se não tiver definido anteriormente, o valor padrão será undefined.

function getView(): string

Retornos

string

getWorkerCount()

Obtém a contagem de trabalho que será criada.

function getWorkerCount(): number

Retornos

number

isSupported(boolean)

Verifica se o navegador do usuário tem suporte no controle de mapa.

function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean

Parâmetros

failIfMajorPerformanceCaveat

boolean

Se true, a função retornará false se o desempenho do controle de mapa for dramaticamente pior do que o esperado (por exemplo, um renderizador WebGL de software seria usado).

Retornos

boolean

prewarm()

Inicializa recursos como WebWorkers que podem ser compartilhados entre mapas para reduzir os tempos de carga em algumas situações. atlas.setWorkerCount, se estiver sendo usado, deve ser definido antes que prewarm() seja chamado para ter um efeito. Por padrão, o ciclo de vida desses recursos é gerenciado automaticamente e eles são inicializados lentamente quando um Mapa é criado pela primeira vez. Invocando prewarm(), esses recursos serão criados com antecedência e não serão limpos quando o último Mapa for removido da página. Isso permite que eles sejam reutilizá-los por novas instâncias do Mapa que são criadas posteriormente. Eles podem ser limpos manualmente chamando atlas.clearPrewarmedResources(). Isso só será necessário se sua página da Web permanecer ativa, mas parar de usar mapas completamente.

Isso é útil principalmente ao usar mapas de GL-JS em um aplicativo de página única, em que um usuário navegaria entre várias exibições que podem fazer com que as instâncias do Mapa sejam constantemente criadas e destruídas.

function prewarm()

removeProtocol(string)

Remove um protocolo adicionado anteriormente no thread principal.

function removeProtocol(customProtocol: string)

Parâmetros

customProtocol

string

o protocolo personalizado para o qual remover o registro

setAuthenticationOptions(AuthenticationOptions)

Define suas opções de autenticação como as opções padrão no namespace atlas que é usado pelo controle de mapa e todos os módulos que fazem solicitações para os serviços de mapas do Azure. Se um mapa for inicializado com as opções de autenticação definidas explicitamente e setAuthenticationOptions não tiver sido chamado anteriormente, ele será automaticamente chamado pelo construtor map.

function setAuthenticationOptions(options: AuthenticationOptions)

Parâmetros

options

AuthenticationOptions

As novas opções de autenticação padrão.

setDomain(string)

Define o domínio padrão usado pelos módulos de mapa e serviço, a menos que o domínio seja especificado explicitamente ao usar essas partes da API. Se um mapa for inicializado com o domínio definido explicitamente e setDomain não tiver sido chamado anteriormente, ele será automaticamente chamado pelo construtor map. Se o protocolo não for especificado https será assumido.

function setDomain(domain: string)

Parâmetros

domain

string

O novo domínio padrão.

setLanguage(string)

Define o idioma padrão usado pelos módulos de mapa e serviço, a menos que o idioma seja especificado explicitamente ao usar essas partes da API. Se um mapa for inicializado com o idioma definido explicitamente e setLanguage não tiver sido chamado anteriormente, ele será automaticamente chamado pelo construtor mapa.

function setLanguage(language: string)

Parâmetros

language

string

O novo idioma padrão.

setMaxParallelImageRequests(number)

Define o número máximo de imagens (blocos de raster, sprites, ícones) a serem carregadas em paralelo, o que afeta o desempenho em mapas pesados de raster. 16 por padrão.

function setMaxParallelImageRequests(maxParallelImageRequests: number)

Parâmetros

maxParallelImageRequests

number

Número máximo de imagens a serem carregadas em paralelo.

setSessionId(string)

Define a ID de sessão padrão usada pelos módulos de mapa e serviço, a menos que a ID da sessão seja especificada explicitamente ao usar essas partes da API. Se um mapa for inicializado com a ID da sessão definida explicitamente e setSessionId não tiver sido chamado anteriormente, ele será automaticamente chamado pelo construtor map.

function setSessionId(id: string)

Parâmetros

id

string

A nova ID de sessão padrão.

setSubscriptionKey(string)

Define sua chave de assinatura do Azure Mapas como a chave de assinatura padrão no namespace atlas que é usado pelo controle de mapa e por todos os módulos que fazem solicitações para os serviços de mapas do Azure. Se um Mapa for inicializado com a chave de assinatura definida explicitamente e setSubscriptionKey não tiver sido chamado anteriormente, ele será chamado automaticamente pelo construtor map.

function setSubscriptionKey(key: string)

Parâmetros

key

string

A nova chave de assinatura padrão.

setUserRegion(string)

Aviso

Essa API foi preterida.

use atlas.setView(view: string) instead.

function setUserRegion(userRegion: string)

Parâmetros

userRegion

string

setView(string)

Especifica qual conjunto de bordas e rótulos geopolíticos são exibidos no mapa. O parâmetro View (também conhecido como "parâmetro de região do usuário") é um código de país ISO-3166 de 2 letras que mostrará os mapas corretos para esse país/região. País/regiões que não estão na lista De exibição ou se não for especificado serão padrão para o Modo de Exibição "Unificado". Consulte o suporte [Views]{@link https://aka.ms/AzureMapsLocalizationViews }. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. 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.

function setView(view: string)

Parâmetros

view

string

O novo modo de exibição padrão

setWorkerCount(number)

Define o número de trabalhos web instanciados em uma página. Por padrão, ele é definido como metade do número de núcleos de CPU (limitado a 6).

function setWorkerCount(workerCount: number)

Parâmetros

workerCount

number

contagem de trabalho.