atlas module

Pacote:

azure-maps-control

Classes

EventManager	Um gestor para os eventos do controlo de mapa. Exposto através da propriedade de eventos do atlas. Classe de mapa. Não pode ser instanciado pelo utilizador.
HtmlMarker	Esta classe molda um elemento HTML que pode ser apresentado no mapa.
Map	O controlo de um mapa Web visual e interativo.
Pixel	Representar uma coordenada ou deslocamento de píxeis. Expande uma matriz de [x, y].
Popup	Uma janela de informações ancorada numa posição especificada num mapa.
PopupTemplate	Um modelo de esquema para um pop-up.
Shape	Uma classe auxiliar que encapsula uma Geometria ou Funcionalidade e facilita a atualização e manutenção.

Interfaces

AggregateExpression	Uma expressão de agregação define um cálculo que é processado através de um conjunto de dados. Esquema: operador [operador: cadeia, initialValue?: booleano | number, mapExpression: Expression] operador: uma função de expressão que é aplicada a todos os valores calculados pelo mapExpression para cada ponto no 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 a cada ponto no conjunto de dados.
AnimationOptions	As opções para animar alterações à câmara do controlo de mapa.
AuthenticationManager	Um gestor para a autenticação do controlo de mapa. Exposto através da propriedade de autenticação do atlas. Classe de mapa. Não pode ser instanciado pelo utilizador.
AuthenticationOptions	Opções para especificar como o controlo de mapa deve ser autenticado com os serviços Azure Maps.
BubbleLayerOptions	Opções utilizadas ao compor objetos de Ponto num BubbleLayer.
CameraBoundsOptions	As opções para definir os limites da câmara do controlo de mapa.
CameraOptions	As opções para definir a câmara do controlo de mapa.
ClusteredProperties	As propriedades que existirão para ClusteredProperties
CompassControlOptions	As opções para um objeto CompassControl.
Control	Uma interface para definir um controlo do mapa.
ControlManager	Um gestor para os controlos do controlo de mapa. Exposto através da propriedade controlos do atlas. Classe de mapa. Não pode ser instanciado pelo utilizador.
ControlOptions	As opções para adicionar um controlo ao mapa.
DataSourceOptions	Uma origem de dados para gerir dados de formas que serão apresentados no mapa. Uma origem de dados tem de ser adicionada a uma camada antes de ser visível no mapa. Opções para um DataSourceOptions.
ElevationTileSourceOptions
HeatMapLayerOptions	Opções utilizadas ao compor objetos de Ponto num HeatMapLayer.
HtmlMarkerEvents
HtmlMarkerManager	Um gestor para os marcadores HTML do controlo de mapa. Exposto através da propriedade marcadores do atlas. Classe de mapa. Não pode ser instanciado pelo utilizador.
HtmlMarkerOptions	Opções para compor um objeto HtmlMarker
HyperLinkFormatOptions	Opção formatar para cadeias de hiperligação.
IconOptions	Opções utilizadas para personalizar os ícones num SymbolLayer
ImageLayerOptions	Opções utilizadas ao compor objetos de Ponto num ImageLayer.
ImageSpriteManager	Um gestor para o sprite de imagem do controlo de mapa. Exposto através da propriedade imageSprite do atlas. Classe de mapa. Não pode ser instanciado pelo utilizador.
LayerManager	Um gestor para as camadas do controlo de mapa. Exposto através da propriedade camadas do atlas. Classe de mapa. Não pode ser instanciado pelo utilizador.
LayerOptions	Uma classe base da qual todas as outras opções de camadas herdam.
LightOptions	As opções para a iluminação do mapa.
LineLayerOptions	Opções utilizadas ao compor objetos SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon e MultiPolygon numa camada de linha.
MapConfiguration	Representa o conteúdo da configuração do mapa que contém uma lista de estilos disponíveis para os mesmos.
MapConfigurationStyle	Representa as informações de um único estilo.
MapDataEvent	Objeto de evento devolvido pelos mapas quando ocorre um evento de dados.
MapErrorEvent	Objeto de evento devolvido pelos mapas quando ocorre um evento de erro.
MapEvent	Objeto de evento devolvido pelos mapas quando ocorre um evento básico.
MapMouseEvent	Objeto de evento devolvido pelos mapas quando ocorre um evento do rato.
MapMouseWheelEvent	Objeto de evento devolvido pelos mapas quando ocorre um evento de roda.
MapTouchEvent	Objeto de evento devolvido pelos mapas quando ocorre um evento tátil.
MediaLayerOptions	Opções utilizadas ao compor camadas de tela, imagem, mosaico raster e vídeo
Options
Padding	Represente a quantidade de preenchimento em píxeis a adicionar ao lado de uma BoundingBox ao definir a câmara de um mapa.
PitchControlOptions	As opções para um objeto PitchControl.
PolygonExtrusionLayerOptions	Opções utilizadas ao compor Polygon e MultiPolygon objetos num PolygonExtrusionLayer.
PolygonLayerOptions	Opções utilizadas ao compor objetos Polygon e MultiPolygon num PolygonLayer.
PopupEvents
PopupManager	Um gestor para os pop-ups do controlo de mapa. Exposto através da popups propriedade da atlas.Map classe . Não pode ser instanciado pelo utilizador.
PopupOptions	As opções para um pop-up.
Properties	Um conjunto de propriedades que podem ser utilizadas com um PopupTemplate
PropertyInfo	Detalhes da espécie de como uma propriedade deve ser exibida.
RasterTileSourceOptions
RequestParameters	Este é o tipo de objeto que se espera que seja devolvido pela chamada de retorno transformRequest.
ScaleControlOptions	As opções para um objeto ScaleControl.
ServiceOptions	Propriedades globais utilizadas em todos os pedidos de serviço atlas.
ShapeEvents
SourceManager	Um gestor para as origens do controlo de mapa. Exposto através da propriedade sources do atlas. Classe de mapa. Não pode ser instanciado pelo utilizador.
StyleChangedEvent	Objeto de evento devolvido 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 utilizadas ao compor geometrias num SymbolLayer.
TargetedEvent
TextOptions	Opções utilizadas para personalizar o texto num SymbolLayer
Tile	Objeto de mosaico devolvido pelo mapa quando ocorre um evento de dados de origem.
TileId
TileLayerOptions	Opções utilizadas ao compor imagens em mosaico raster num TileLayer.
TrafficControlOptions
TrafficOptions	As opções para definir o tráfego no mapa.
UserInteractionOptions	As opções para ativar/desativar a interação do utilizador com o mapa.
VectorTileSourceOptions	Uma origem de dados para gerir dados de formas que serão apresentados no mapa. Uma origem de dados tem de ser adicionada a uma camada antes de ser visível no mapa. Opções para um VectorTileSource.
WebGLLayerOptions	Opções utilizadas para compor gráficos num WebGLLayer.
WebGLRenderer	Interface para compor gráficos WebGL num WebGLLayer.
ZoomControlOptions	As opções para um objeto ZoomControl.

Aliases de Tipo

Expression	Pode ser especificado como o valor de 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 que atribui um nome ao operador de expressão.
getAuthTokenCallback	A função de chamada de retorno utilizada 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 options parâmetro transmitido para ImageSpriteManager.add.

Enumerações

AuthenticationType	Uma enumeração utilizada para especificar o tipo de mecanismo de autenticação a utilizar.
ControlPosition	Posições onde o controlo pode ser colocado no mapa.
ControlStyle	Estilos disponíveis para um Controlo.

Funções

addImageTemplate(string, string, boolean)	Adiciona um modelo de imagem ao espaço de nomes atlas.
clearPrewarmedResources()	Limpa os recursos que foram criados anteriormente pelo atlas.prewarm(). Tenha em atenção que, normalmente, isto não é necessário. Só deve chamar esta função se esperar que o utilizador da sua aplicação não regresse a uma vista de Mapa em nenhum momento da sua aplicação.
getAllImageTemplateNames()	Obtém uma matriz de nomes para todos os modelos de imagem que estão disponíveis no espaço de nomes do atlas.
getAuthenticationOptions()	Obtém as opções de autenticação predefinidas fornecidas. Se não tiver definido anteriormente, todas as propriedades serão indefinidas.
getDomain()	Obtém o domínio predefinido fornecido. Se não tiver definido anteriormente, o valor predefinido é "atlas.microsoft.com".
getImageTemplate(string, number)	Obtém um modelo SVG por nome.
getLanguage()	Obtém o idioma predefinido fornecido. Se não tiver definido anteriormente, o valor predefinido é "NGT".
getMaxParallelImageRequests()	Obtém o Número máximo de imagens (mosaicos raster, sprites, ícones) para carregar em paralelo
getSessionId()	Obtém o ID de sessão predefinido fornecido. Se não tiver definido anteriormente, o valor predefinido é um UUID aleatório.
getSubscriptionKey()	Obtém a chave de subscrição de Azure Maps predefinida fornecida.
getUserRegion()
getVersion()	Número da versão da API atual com base no número da compilação.
getView()	Obtém a definição de vista predefinida do controlo de mapa. Se não tiver definido anteriormente, o valor predefinido é undefined.
getWorkerCount()	Obtém a contagem de trabalhos que será criada.
isSupported(boolean)	Verifica se o browser do utilizador é suportado pelo controlo de mapa.
prewarm()	Inicializa recursos como WebWorkers que podem ser partilhados entre mapas para tempos de carregamento mais baixos em algumas situações. atlas.setWorkerCount, se estiver a ser utilizado, tem de ser definido antes prewarm() de ser chamado para ter um efeito. Por predefinição, o ciclo de vida destes recursos é gerido automaticamente e são inicializados preguiçosamente quando um Mapa é criado pela primeira vez. Ao invocar prewarm(), estes recursos serão criados antecipadamente e não serão limpos quando o último Mapa for removido da página. Isto permite que sejam reutilizadas pelas novas instâncias de Mapa que são criadas mais tarde. Podem ser desmarcadas manualmente ao chamar atlas.clearPrewarmedResources(). Isto só é necessário se a sua página Web permanecer ativa, mas deixar de utilizar mapas completamente. Isto é essencialmente útil ao utilizar mapas GL-JS numa única aplicação de página, em que um utilizador navegaria entre várias vistas que podem fazer com que as instâncias do Mapa sejam constantemente criadas e destruídas.
setAuthenticationOptions(AuthenticationOptions)	Define as opções de autenticação como as opções predefinidas no espaço de nomes atlas que é utilizado pelo controlo de mapa e quaisquer módulos que façam pedidos aos serviços do Azure Maps. Se um Mapa for inicializado com as opções de autenticação explicitamente definidas e setAuthenticationOptions não tiver sido chamado anteriormente, será automaticamente chamado pelo construtor Mapa.
setDomain(string)	Define o domínio predefinido utilizado pelos módulos de mapa e serviço, a menos que o domínio seja explicitamente especificado ao utilizar essas partes da API. Se um Mapa for inicializado com o domínio explicitamente definido e setDomain não tiver sido chamado anteriormente, será automaticamente chamado pelo construtor Map. Se o protocolo não for especificado https , é assumido.
setLanguage(string)	Define o idioma predefinido utilizado pelos módulos de mapa e serviço, a menos que o idioma seja explicitamente especificado ao utilizar essas partes da API. Se um Mapa for inicializado com o idioma explicitamente definido e setLanguage não tiver sido chamado anteriormente, será automaticamente chamado pelo construtor Mapa.
setMaxParallelImageRequests(number)	Define o Número máximo de imagens (mosaicos raster, sprites, ícones) para carregar em paralelo, o que afeta o desempenho em mapas raster-heavy. 16 por predefinição.
setSessionId(string)	Define o ID de sessão predefinido utilizado pelos módulos de mapa e serviço, a menos que o ID da sessão seja explicitamente especificado ao utilizar essas partes da API. Se um Mapa for inicializado com o ID de sessão explicitamente definido e setSessionId não tiver sido chamado anteriormente, será automaticamente chamado pelo construtor do Mapa.
setSubscriptionKey(string)	Define a sua Azure Maps chave de subscrição como a chave de subscrição predefinida no espaço de nomes atlas que é utilizado pelo controlo de mapa e quaisquer módulos que façam pedidos aos serviços do Azure Maps. Se um Mapa for inicializado com a chave de subscrição explicitamente definida e setSubscriptionKey não tiver sido chamado anteriormente, será automaticamente chamado pelo construtor Mapa.
setUserRegion(string)
setView(string)	Especifica o conjunto de limites e etiquetas geopolíticos disputados que são apresentados no mapa. O parâmetro Ver (também conhecido como "parâmetro de região do utilizador") é um Código de País ISO-3166 de 2 letras que mostrará os mapas corretos para esse país/região. Os países/regiões que não estão na lista Ver ou se não forem especificados serão predefinidos para a Vista "Unificada". Consulte as [Vistas] suportadas{@link https://aka.ms/AzureMapsLocalizationViews }. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps.
setWorkerCount(number)	Define o número de web workers instanciados numa página. Por predefinição, está definido para 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 espaço de nomes atlas.

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

Parâmetros

templateName

string

O nome do modelo.

template

string

O modelo SVG a adicionar. Suporta {color}, {secondaryColor}, {scale}, {text}.

override

boolean

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

clearPrewarmedResources()

Limpa os recursos que foram criados anteriormente pelo atlas.prewarm(). Tenha em atenção que, normalmente, isto não é necessário. Só deve chamar esta função se esperar que o utilizador da sua aplicação não regresse a uma vista de Mapa em nenhum momento da sua aplicação.

function clearPrewarmedResources()

getAllImageTemplateNames()

Obtém uma matriz de nomes para todos os modelos de imagem que estão disponíveis no espaço de nomes do atlas.

function getAllImageTemplateNames(): string[]

Devoluções

string[]

getAuthenticationOptions()

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

function getAuthenticationOptions(): AuthenticationOptions

Devoluções

AuthenticationOptions

getDomain()

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

function getDomain(): string

Devoluções

string

getImageTemplate(string, number)

Obtém um modelo SVG por nome.

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

Parâmetros

templateName

string

O nome do modelo a obter.

scale

number

Especifica quanto dimensionar o modelo. Para obter os melhores resultados, dimensione o ícone para o tamanho máximo que pretende apresentar no mapa e, em seguida, utilize a opção de tamanho do ícone de camadas de símbolos para reduzir verticalmente, se necessário. Isto reduzirá a desfocagem devido ao dimensionamento. Predefinição: 1

Devoluções

string

getLanguage()

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

function getLanguage(): string

Devoluções

string

getMaxParallelImageRequests()

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

function getMaxParallelImageRequests(): number

Devoluções

number

getSessionId()

Obtém o ID de sessão predefinido fornecido. Se não tiver definido anteriormente, o valor predefinido é um UUID aleatório.

function getSessionId(): string

Devoluções

string

getSubscriptionKey()

Obtém a chave de subscrição de Azure Maps predefinida 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 da API atual com base no número da compilação.

function getVersion(): string

Devoluções

string

getView()

Obtém a definição de vista predefinida do controlo de mapa. Se não tiver definido anteriormente, o valor predefinido é undefined.

function getView(): string

Devoluções

string

getWorkerCount()

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

function getWorkerCount(): number

Devoluções

number

isSupported(boolean)

Verifica se o browser do utilizador é suportado pelo controlo de mapa.

function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean

Parâmetros

failIfMajorPerformanceCaveat

boolean

Se for verdadeira, a função devolverá false se o desempenho do controlo de mapa for significativamente pior do que o esperado (por exemplo, seria utilizado um compositor WebGL de software).

Devoluções

boolean

prewarm()

Inicializa recursos como WebWorkers que podem ser partilhados entre mapas para tempos de carregamento mais baixos em algumas situações. atlas.setWorkerCount, se estiver a ser utilizado, tem de ser definido antes prewarm() de ser chamado para ter um efeito. Por predefinição, o ciclo de vida destes recursos é gerido automaticamente e são inicializados preguiçosamente quando um Mapa é criado pela primeira vez. Ao invocar prewarm(), estes recursos serão criados antecipadamente e não serão limpos quando o último Mapa for removido da página. Isto permite que sejam reutilizadas pelas novas instâncias de Mapa que são criadas mais tarde. Podem ser desmarcadas manualmente ao chamar atlas.clearPrewarmedResources(). Isto só é necessário se a sua página Web permanecer ativa, mas deixar de utilizar mapas completamente.

Isto é essencialmente útil ao utilizar mapas GL-JS numa única aplicação de página, em que um utilizador navegaria entre várias vistas que podem fazer com que as instâncias do Mapa sejam constantemente criadas e destruídas.

function prewarm()

setAuthenticationOptions(AuthenticationOptions)

Define as opções de autenticação como as opções predefinidas no espaço de nomes atlas que é utilizado pelo controlo de mapa e quaisquer módulos que façam pedidos aos serviços do Azure Maps. Se um Mapa for inicializado com as opções de autenticação explicitamente definidas e setAuthenticationOptions não tiver sido chamado anteriormente, será automaticamente chamado pelo construtor Mapa.

function setAuthenticationOptions(options: AuthenticationOptions)

Parâmetros

options

AuthenticationOptions

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

setDomain(string)

Define o domínio predefinido utilizado pelos módulos de mapa e serviço, a menos que o domínio seja explicitamente especificado ao utilizar essas partes da API. Se um Mapa for inicializado com o domínio explicitamente definido e setDomain não tiver sido chamado anteriormente, 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 predefinido.

setLanguage(string)

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

function setLanguage(language: string)

Parâmetros

language

string

O novo idioma predefinido.

setMaxParallelImageRequests(number)

Define o Número máximo de imagens (mosaicos raster, sprites, ícones) para carregar em paralelo, o que afeta o desempenho em mapas raster-heavy. 16 por predefinição.

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 predefinido utilizado pelos módulos de mapa e serviço, a menos que o ID da sessão seja explicitamente especificado ao utilizar essas partes da API. Se um Mapa for inicializado com o ID de sessão explicitamente definido e setSessionId não tiver sido chamado anteriormente, será automaticamente chamado pelo construtor do Mapa.

function setSessionId(id: string)

Parâmetros

id

string

O novo ID de sessão predefinido.

setSubscriptionKey(string)

Define a sua Azure Maps chave de subscrição como a chave de subscrição predefinida no espaço de nomes atlas que é utilizado pelo controlo de mapa e quaisquer módulos que façam pedidos aos serviços do Azure Maps. Se um Mapa for inicializado com a chave de subscrição explicitamente definida e setSubscriptionKey não tiver sido chamado anteriormente, será automaticamente chamado pelo construtor Mapa.

function setSubscriptionKey(key: string)

Parâmetros

key

string

A nova chave de subscrição predefinida.

setUserRegion(string)

Aviso

Esta API foi preterida.

use atlas.setView(view: string) instead.

function setUserRegion(userRegion: string)

Parâmetros

userRegion

string

setView(string)

Especifica o conjunto de limites e etiquetas geopolíticos disputados que são apresentados no mapa. O parâmetro Ver (também conhecido como "parâmetro de região do utilizador") é um Código de País ISO-3166 de 2 letras que mostrará os mapas corretos para esse país/região. Os países/regiões que não estão na lista Ver ou se não forem especificados serão predefinidos para a Vista "Unificada". Consulte as [Vistas] suportadas{@link https://aka.ms/AzureMapsLocalizationViews }. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps.

function setView(view: string)

Parâmetros

view

string

A nova vista predefinida

setWorkerCount(number)

Define o número de web workers instanciados numa página. Por predefinição, está definido para metade do número de núcleos de CPU (limitado a 6).

function setWorkerCount(workerCount: number)

Parâmetros

workerCount

number

contagem de trabalhos.