Map class

O controlo de um mapa Web visual e interativo.

Construtores

Map(string | HTMLElement, ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))

Apresenta um mapa no contentor especificado.

Propriedades

authentication
controls
events
imageSprite
isDisposed

Devolve verdadeiro se o mapa tiver sido eliminado.

layers
markers
popups
sources

Métodos

areTilesLoaded()

Devolve um valor booleano que indica se todos os mosaicos no viewport atual para todas as origens foram carregados ou não.

clear()

Remove todas as origens, camadas, marcadores e pop-ups do mapa. As imagens adicionadas pelo utilizador são preservadas.

disableElevation()

Desativa a malha de terreno 3D.

dispose()

Limpe os recursos do mapa. O mapa não funcionará corretamente depois de chamar este método.

enableElevation(string | ElevationTileSource, number)

Carrega uma malha de terreno 3D, com base numa origem "raster-dem".

getCamera()

Devolve as propriedades atuais da câmara.

getCanvas()

Devolve o HTMLCanvasElement para o qual o mapa é desenhado.

getCanvasContainer()

Devolve o HTMLElement que contém o HTMLCanvasElement do mapa. Os eventos do mapa (por exemplo, panning e zoom) estão anexados a este elemento.

getMapContainer()

Devolve o HTMLElement que contém o mapa.

getServiceOptions()

Devolve as opções de serviço com as quais o controlo de mapa foi inicializado.

getStyle()

Devolve as definições de estilo atual do controlo de mapa.

getTraffic()

Devolva as definições de tráfego atuais do controlo de mapa.

getUserInteraction()

Devolva as definições atuais do processador de interação de utilizadores do controlo de mapa.

pixelsToPositions(Pixel[])

Converte uma matriz de objetos Pixel numa matriz de objetos de Posições geográficas no mapa.

positionsToPixels(Position[])

Converte uma matriz de objetos Posições numa matriz de objetos Pixel relativamente ao contentor de mapa.

resize(any)

Redimensione o mapa de acordo com as dimensões do respetivo elemento de contentor.

resize(number | string, number | string, any)

Redimensiona o elemento de contentor do mapa e, em seguida, o próprio mapa.

setCamera((CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)

Defina a câmara do controlo de mapa com uma transição animada. Todas as opções não especificadas serão predefinidas para os valores atuais.

setServiceOptions(ServiceOptions)

Defina as opções de serviço.

setStyle(StyleOptions, boolean)

Defina as opções de estilo do controlo de mapa. Todas as opções não especificadas serão predefinidas para os valores atuais.

setTraffic(TrafficOptions)

Defina as opções de tráfego para o mapa. Todas as opções não especificadas serão predefinidas para os valores atuais.

setUserInteraction(UserInteractionOptions)

Defina os processadores de interação do utilizador do controlo de mapa. Todas as opções não especificadas serão predefinidas para os valores atuais.

stop()

Para qualquer transição animada que esteja em curso.

triggerRepaint()

Acione a composição de uma única moldura. Utilize este método com camadas WebGL para repintar o mapa quando as propriedades ou propriedades da camada associadas à origem da camada forem alteradas. Chamar esta opção várias vezes antes da composição da moldura seguinte resultará na composição de apenas uma moldura.

Detalhes do Construtor

Map(string | HTMLElement, ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))

Apresenta um mapa no contentor especificado.

new Map(container: string | HTMLElement, options: ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))

Parâmetros

container

string | HTMLElement

O ID do elemento onde o mapa deve ser apresentado.

options

ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions)

Opções para o ecrã inicial e a capacidade de interação com o mapa.

Detalhes de Propriedade

authentication

authentication: AuthenticationManager

Valor de Propriedade

controls

controls: ControlManager

Valor de Propriedade

events

events: EventManager

Valor de Propriedade

imageSprite

imageSprite: ImageSpriteManager

Valor de Propriedade

isDisposed

Devolve verdadeiro se o mapa tiver sido eliminado.

boolean isDisposed

Valor de Propriedade

boolean

layers

layers: LayerManager

Valor de Propriedade

markers

markers: HtmlMarkerManager

Valor de Propriedade

popups

popups: PopupManager

Valor de Propriedade

sources

sources: SourceManager

Valor de Propriedade

Detalhes de Método

areTilesLoaded()

Devolve um valor booleano que indica se todos os mosaicos no viewport atual para todas as origens foram carregados ou não.

function areTilesLoaded(): boolean

Devoluções

boolean

clear()

Remove todas as origens, camadas, marcadores e pop-ups do mapa. As imagens adicionadas pelo utilizador são preservadas.

function clear()

disableElevation()

Desativa a malha de terreno 3D.

function disableElevation()

dispose()

Limpe os recursos do mapa. O mapa não funcionará corretamente depois de chamar este método.

function dispose()

enableElevation(string | ElevationTileSource, number)

Carrega uma malha de terreno 3D, com base numa origem "raster-dem".

function enableElevation(elevationSource: string | ElevationTileSource, exaggeration?: number)

Parâmetros

elevationSource

string | ElevationTileSource

origem do mosaico de elevação

exaggeration

number

o fator de exagero de elevação

getCamera()

Devolve as propriedades atuais da câmara.

function getCamera(): CameraOptions & CameraBoundsOptions

Devoluções

getCanvas()

Devolve o HTMLCanvasElement para o qual o mapa é desenhado.

function getCanvas(): HTMLCanvasElement

Devoluções

HTMLCanvasElement

getCanvasContainer()

Devolve o HTMLElement que contém o HTMLCanvasElement do mapa. Os eventos do mapa (por exemplo, panning e zoom) estão anexados a este elemento.

function getCanvasContainer(): HTMLElement

Devoluções

HTMLElement

getMapContainer()

Devolve o HTMLElement que contém o mapa.

function getMapContainer(): HTMLElement

Devoluções

HTMLElement

getServiceOptions()

Devolve as opções de serviço com as quais o controlo de mapa foi inicializado.

function getServiceOptions(): ServiceOptions

Devoluções

getStyle()

Devolve as definições de estilo atual do controlo de mapa.

function getStyle(): StyleOptions

Devoluções

getTraffic()

Devolva as definições de tráfego atuais do controlo de mapa.

function getTraffic(): TrafficOptions

Devoluções

getUserInteraction()

Devolva as definições atuais do processador de interação de utilizadores do controlo de mapa.

function getUserInteraction(): UserInteractionOptions

Devoluções

pixelsToPositions(Pixel[])

Converte uma matriz de objetos Pixel numa matriz de objetos de Posições geográficas no mapa.

function pixelsToPositions(pixels: Pixel[]): Position[]

Parâmetros

pixels

Pixel[]

Os píxeis a converter.

Devoluções

positionsToPixels(Position[])

Converte uma matriz de objetos Posições numa matriz de objetos Pixel relativamente ao contentor de mapa.

function positionsToPixels(positions: Position[]): Pixel[]

Parâmetros

positions

Position[]

As posições a converter.

Devoluções

Pixel[]

resize(any)

Redimensione o mapa de acordo com as dimensões do respetivo elemento de contentor.

function resize(eventData?: any)

Parâmetros

eventData

any

Propriedades adicionais opcionais a adicionar a objetos de eventos de eventos acionados por este método.

resize(number | string, number | string, any)

Redimensiona o elemento de contentor do mapa e, em seguida, o próprio mapa.

function resize(height: number | string, width: number | string, eventData?: any)

Parâmetros

height

number | string

A altura do mapa e o respetivo elemento de contentor. Presume-se que uma entrada de número está em píxeis.

width

number | string

A largura do mapa e o respetivo elemento de contentor. Presume-se que uma entrada de número está em píxeis.

eventData

any

Propriedades adicionais opcionais a adicionar a objetos de eventos de eventos acionados por este método.

setCamera((CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)

Defina a câmara do controlo de mapa com uma transição animada. Todas as opções não especificadas serão predefinidas para os valores atuais.

function setCamera(options?: (CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)

Parâmetros

options

(CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions

As opções para definir a câmara do mapa e para a animação de qualquer alteração de vista.

setServiceOptions(ServiceOptions)

Defina as opções de serviço.

function setServiceOptions(options: ServiceOptions)

Parâmetros

options
ServiceOptions

setStyle(StyleOptions, boolean)

Defina as opções de estilo do controlo de mapa. Todas as opções não especificadas serão predefinidas para os valores atuais.

function setStyle(options?: StyleOptions, diff?: boolean)

Parâmetros

options
StyleOptions

As opções para definir o estilo do controlo de mapa.

diff

boolean

Se for falso, força uma atualização de estilo "completa", removendo o estilo atual e construindo o especificado em vez de tentar uma atualização baseada em difusão. As predefinições são verdadeiras.

setTraffic(TrafficOptions)

Defina as opções de tráfego para o mapa. Todas as opções não especificadas serão predefinidas para os valores atuais.

function setTraffic(options?: TrafficOptions)

Parâmetros

options
TrafficOptions

As opções para definir o ecrã de tráfego do mapa.

setUserInteraction(UserInteractionOptions)

Defina os processadores de interação do utilizador do controlo de mapa. Todas as opções não especificadas serão predefinidas para os valores atuais.

function setUserInteraction(options?: UserInteractionOptions)

Parâmetros

options
UserInteractionOptions

As opções para ativar/desativar os processadores de interação do utilizador.

stop()

Para qualquer transição animada que esteja em curso.

function stop()

triggerRepaint()

Acione a composição de uma única moldura. Utilize este método com camadas WebGL para repintar o mapa quando as propriedades ou propriedades da camada associadas à origem da camada forem alteradas. Chamar esta opção várias vezes antes da composição da moldura seguinte resultará na composição de apenas uma moldura.

function triggerRepaint()