atlas module

Pacote:

azure-maps-control

Classes

EventManager	Um gerente para os eventos do controle de mapa. Exposto através da propriedade events do atlas. Classe do mapa. Não pode ser instanciado pelo usuário.
HtmlMarker	Essa classe encapsula um elemento HTML que pode ser exibido no mapa.
Map	O controle para um mapa da web visual e interativo.
Pixel	Representar uma coordenada ou deslocamento de pixel. 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 envolve uma Geometria ou Recurso e facilita a atualização e a manutenção.

Interfaces

AggregateExpression	Uma expressão agregada define um cálculo que é processado sobre um conjunto de dados. Schema: [operator: 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 do cluster. Operadores suportados: o Para números: +, *, max, min o Para Booleanos: all, any initialValue: Opcional, um valor inicial no qual o primeiro valor calculado é agregado. mapExpression: uma expressão que é aplicada em relação a cada ponto do conjunto de dados.
AnimationOptions	As opções para animar alterações na câmera do controle de mapa.
AuthenticationManager	Um gerenciador para a autenticação do controle de mapa. Exposto através da propriedade authentication do atlas. Classe do mapa. Não pode ser instanciado pelo usuário.
AuthenticationOptions	Opções para especificar como o controle de mapa deve ser autenticado com os serviços do Azure Maps.
BubbleLayerOptions	Opções usadas ao renderizar objetos Point em uma 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 gerenciador para os controles do controle de mapa. Exposto através da propriedade controls do atlas. Classe do mapa. Não pode ser instanciado 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 ser 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 gerenciador para os marcadores HTML do controle de mapa. Exposto através da propriedade markers do atlas. Classe do mapa. Não pode ser instanciado 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 através da propriedade imageSprite do atlas. Classe do mapa. Não pode ser instanciado pelo usuário.
LayerManager	Um gerenciador para as camadas do controle de mapa. Exposto através da propriedade layers do atlas. Classe do mapa. Não pode ser instanciado 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 contendo uma lista de estilos disponíveis para eles.
MapConfigurationStyle	Representa as informações para 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 tela, imagem, bloco raster e camadas de vídeo
Options
Padding	Represente a quantidade de preenchimento em pixels para adicionar ao lado de uma BoundingBox ao definir a câmera de um mapa.
PitchControlOptions	As opções para um objeto PitchControl.
PolygonExtrusionLayerOptions	Opções usadas ao renderizar Polygon e MultiPolygon objetos em um PolygonExtrusionLayer.
PolygonLayerOptions	Opções usadas ao renderizar objetos Polygon e MultiPolygon em um PolygonLayer.
PopupEvents
PopupManager	Um gerenciador para os pop-ups do controle de mapa. Exposto através da propriedade popups da classe atlas.Map. Não pode ser instanciado 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	Este é o tipo de objeto esperado para ser retornado pelo retorno de chamada transformRequest.
ScaleControlOptions	As opções para um objeto ScaleControl.
ServiceOptions	Propriedades globais usadas em todas as solicitações de serviço do atlas.
ShapeEvents
SourceManager	Um gerente para as fontes do controle de mapa. Exposto através da propriedade sources do atlas. Classe do mapa. Não pode ser instanciado 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 raster lado a lado em um TileLayer.
TrafficControlOptions
TrafficOptions	As opções para definir o tráfego no mapa.
UserInteractionOptions	As opções para ativar/desativar 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 ser 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 que nomeia 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 erros.
ResourceType
StyleImageMetadata	Assinatura para o 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 onde o controle pode ser colocado no mapa.
ControlStyle	Estilos disponíveis para um Control.

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 recursos que foram criados anteriormente por atlas.prewarm(). Observe que isso normalmente não é necessário. Você só deve chamar essa função se esperar que o usuário do seu aplicativo não retorne a uma visualização de Mapa em nenhum ponto do seu aplicativo.
getAllImageTemplateNames()	Recupera uma matriz de nomes para todos os modelos de imagem disponíveis no namespace atlas.
getAuthenticationOptions()	Obtém as opções de autenticação padrão que foram fornecidas. Se não tiver sido definido anteriormente, todas as propriedades serão indefinidas.
getDomain()	Obtém o domínio padrão que foi fornecido. Se não tiver sido definido anteriormente, o valor padrão será "atlas.microsoft.com".
getImageTemplate(string, number)	Recupera um modelo SVG pelo nome.
getLanguage()	Obtém o idioma padrão que foi fornecido. Se não tiver sido definido anteriormente, o valor padrão será "NGT".
getMaxParallelImageRequests()	Obtém o número máximo de imagens (blocos rasterizados, sprites, ícones) para carregar em paralelo
getSessionId()	Obtém a ID de sessão padrão que foi fornecida. Se não tiver sido definido anteriormente, o valor padrão será um UUID aleatório.
getSubscriptionKey()	Obtém a chave de assinatura padrão do Azure Maps que foi fornecida.
getUserRegion()
getVersion()	Número da versão atual da API com base no número da compilação.
getView()	Obtém a configuração de exibição padrão do controle de mapa. Se não tiver sido definido anteriormente, o valor padrão será undefined.
getWorkerCount()	Obtém a contagem de trabalhadores que será criada.
isSupported(boolean)	Verifica se o navegador do usuário é suportado pelo controle de mapa.
prewarm()	Inicializa recursos como WebWorkers que podem ser compartilhados entre mapas para reduzir os tempos de carregamento em algumas situações. atlas.setWorkerCount, se for utilizado, deve ser definido antes de prewarm() ser chamado a produzir efeitos. Por padrão, o ciclo de vida desses recursos é gerenciado automaticamente e eles são inicializados com preguiça quando um Mapa é criado pela primeira vez. Ao invocar 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 reutilizados por novas instâncias do Map que são criadas posteriormente. Eles podem ser limpos manualmente chamando atlas.clearPrewarmedResources(). Isso só é necessário se sua página da Web permanecer ativa, mas parar de usar mapas. 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 visualizações que podem fazer com que as instâncias do Map 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 quaisquer módulos que façam solicitações aos serviços de mapas do Azure. Se um Map for inicializado com as opções de autenticação explicitamente definidas 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 explicitamente especificado ao usar essas partes da API. Se um Map for inicializado com o domínio explicitamente definido e setDomain não tiver sido chamado anteriormente, ele será automaticamente chamado pelo construtor Map. Se o protocolo não for especificado, https é assumido.
setLanguage(string)	Define o idioma padrão usado pelos módulos de mapa e serviço, a menos que o idioma seja explicitamente especificado ao usar essas partes da API. Se um Map for inicializado com o idioma explicitamente definido e setLanguage não tiver sido chamado anteriormente, ele será automaticamente chamado pelo construtor Map.
setMaxParallelImageRequests(number)	Define o número máximo de imagens (blocos rasterizados, sprites, ícones) para carregar em paralelo, o que afeta o desempenho em mapas pesados com raster. 16 por defeito.
setSessionId(string)	Define o id de sessão padrão usado pelos módulos de mapa e serviço, a menos que o id de sessão seja explicitamente especificado ao usar essas partes da API. Se um Map for inicializado com o ID de sessão explicitamente definido e setSessionId não tiver sido chamado anteriormente, ele será automaticamente chamado pelo construtor Map.
setSubscriptionKey(string)	Define sua chave de assinatura do Azure Maps como a chave de assinatura padrão no namespace atlas que é usado pelo controle de mapa e quaisquer módulos que fazem solicitações aos serviços de mapas do Azure. Se um Map for inicializado com a chave de assinatura explicitamente definida e setSubscriptionKey não tiver sido chamado anteriormente, ele será chamado automaticamente pelo construtor Map.
setUserRegion(string)
setView(string)	Especifica qual conjunto de fronteiras e rótulos geopoliticamente disputados 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 Exibir ou, se não especificados, terão como padrão a Exibição "Unificada". Consulte as [Visualizações]{@link https://aka.ms/AzureMapsLocalizationViews } suportadas. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localizaçã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.
setWorkerCount(number)	Define o número de Web workers instanciados em uma página. Por padrão, ele é definido como metade do número de núcleos de CPU (limitado a 6).

Detalhes de 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. Suporta {color}, {secondaryColor}, {scale}, {text}.

override

boolean

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

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 para fisgar, por exemplo "personalizado"

loadFn

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

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

clearPrewarmedResources()

Limpa recursos que foram criados anteriormente por atlas.prewarm(). Observe que isso normalmente não é necessário. Você só deve chamar essa função se esperar que o usuário do seu aplicativo não retorne a uma visualização de Mapa em nenhum ponto do seu aplicativo.

function clearPrewarmedResources()

getAllImageTemplateNames()

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

function getAllImageTemplateNames(): string[]

Devoluções

string[]

getAuthenticationOptions()

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

function getAuthenticationOptions(): AuthenticationOptions

Devoluções

AuthenticationOptions

getDomain()

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

function getDomain(): string

Devoluções

string

getImageTemplate(string, number)

Recupera um modelo SVG pelo nome.

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

Parâmetros

templateName

string

O nome do modelo a ser recuperado.

scale

number

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

Devoluções

string

getLanguage()

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

function getLanguage(): string

Devoluções

string

getMaxParallelImageRequests()

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

function getMaxParallelImageRequests(): number

Devoluções

number

getSessionId()

Obtém a ID de sessão padrão que foi fornecida. Se não tiver sido definido anteriormente, o valor padrão será um UUID aleatório.

function getSessionId(): string

Devoluções

string

getSubscriptionKey()

Obtém a chave de assinatura padrão do Azure Maps que foi fornecida.

function getSubscriptionKey(): string

Devoluções

string

getUserRegion()

Aviso

Esta API foi preterida.

use atlas.getView() instead

function getUserRegion(): string

Devoluções

string

getVersion()

Número da versão atual da API com base no número da compilação.

function getVersion(): string

Devoluções

string

getView()

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

function getView(): string

Devoluções

string

getWorkerCount()

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

function getWorkerCount(): number

Devoluções

number

isSupported(boolean)

Verifica se o navegador do usuário é suportado pelo controle de mapa.

function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean

Parâmetros

failIfMajorPerformanceCaveat

boolean

Se verdadeiro, 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).

Devoluções

boolean

prewarm()

Inicializa recursos como WebWorkers que podem ser compartilhados entre mapas para reduzir os tempos de carregamento em algumas situações. atlas.setWorkerCount, se for utilizado, deve ser definido antes de prewarm() ser chamado a produzir efeitos. Por padrão, o ciclo de vida desses recursos é gerenciado automaticamente e eles são inicializados com preguiça quando um Mapa é criado pela primeira vez. Ao invocar 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 reutilizados por novas instâncias do Map que são criadas posteriormente. Eles podem ser limpos manualmente chamando atlas.clearPrewarmedResources(). Isso só é necessário se sua página da Web permanecer ativa, mas parar de usar mapas.

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 visualizações que podem fazer com que as instâncias do Map 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 remover o registro para

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 quaisquer módulos que façam solicitações aos serviços de mapas do Azure. Se um Map for inicializado com as opções de autenticação explicitamente definidas 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 explicitamente especificado ao usar essas partes da API. Se um Map for inicializado com o domínio explicitamente definido e setDomain não tiver sido chamado anteriormente, ele será automaticamente chamado pelo construtor Map. Se o protocolo não for especificado, https é 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 explicitamente especificado ao usar essas partes da API. Se um Map for inicializado com o idioma explicitamente definido e setLanguage não tiver sido chamado anteriormente, ele será automaticamente chamado pelo construtor Map.

function setLanguage(language: string)

Parâmetros

language

string

O novo idioma padrão.

setMaxParallelImageRequests(number)

Define o número máximo de imagens (blocos rasterizados, sprites, ícones) para carregar em paralelo, o que afeta o desempenho em mapas pesados com raster. 16 por defeito.

function setMaxParallelImageRequests(maxParallelImageRequests: number)

Parâmetros

maxParallelImageRequests

number

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

setSessionId(string)

Define o id de sessão padrão usado pelos módulos de mapa e serviço, a menos que o id de sessão seja explicitamente especificado ao usar essas partes da API. Se um Map for inicializado com o ID de sessão explicitamente definido 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 Maps como a chave de assinatura padrão no namespace atlas que é usado pelo controle de mapa e quaisquer módulos que fazem solicitações aos serviços de mapas do Azure. Se um Map for inicializado com a chave de assinatura explicitamente definida 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

Esta API foi preterida.

use atlas.setView(view: string) instead.

function setUserRegion(userRegion: string)

Parâmetros

userRegion

string

setView(string)

Especifica qual conjunto de fronteiras e rótulos geopoliticamente disputados 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 Exibir ou, se não especificados, terão como padrão a Exibição "Unificada". Consulte as [Visualizações]{@link https://aka.ms/AzureMapsLocalizationViews } suportadas. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localizaçã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.

function setView(view: string)

Parâmetros

view

string

O novo modo de exibição padrão

setWorkerCount(number)

Define o número de Web workers 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 trabalhadores.