Map class
O controle para um mapa da Web visual e interativo.
Construtores
Map(string | HTMLElement, Service |
Exibe um mapa no contêiner especificado. |
Propriedades
authentication | |
controls | |
events | |
image |
|
is |
Retornará true se o mapa tiver sido descartado. |
layers | |
markers | |
popups | |
sources |
Métodos
are |
Retorna um booliano que indica se todos os blocos no visor atual para todas as fontes foram carregados ou não. |
clear() | Remove todas as fontes, camadas, marcadores e pop-ups do mapa. As imagens adicionadas pelo usuário são preservadas. |
disable |
Desabilita a malha de terreno 3D. |
dispose() | Limpe os recursos do mapa. O mapa não funcionará corretamente depois de chamar esse método. |
enable |
Carrega uma malha de terreno 3D, com base em uma origem "raster-dem". |
get |
Retorna as propriedades atuais da câmera. |
get |
Retorna o HTMLCanvasElement ao qual o mapa é desenhado. |
get |
Retorna o HTMLElement que contém o HTMLCanvasElement do mapa. Os eventos do mapa (por exemplo, movimento panorâmico e zoom) são anexados a esse elemento. |
get |
Retorna o HTMLElement que contém o mapa. |
get |
Retorna as opções de serviço com as quais o controle de mapa foi inicializado. |
get |
Retorna as configurações de estilo atuais do controle de mapa. |
get |
Retornar as configurações de tráfego atuais do controle de mapa. |
get |
Retornar as configurações atuais do manipulador de interação do usuário do controle de mapa. |
pixels |
Converte uma matriz de objetos Pixel em uma matriz de objetos Positions geográficos no mapa. |
positions |
Converte uma matriz de objetos Positions em uma matriz de objetos Pixel em relação ao contêiner de mapa. |
resize(any) | Redimensione o mapa de acordo com as dimensões de seu elemento de contêiner. |
resize(number | string, number | string, any) | Redimensiona o elemento contêiner do mapa e, em seguida, o próprio mapa. |
set |
Defina a câmera do controle de mapa com uma transição animada. Todas as opções não especificadas serão padrão para seus valores atuais. |
set |
Defina as opções de serviço. |
set |
Defina as opções de estilo do controle de mapa. Todas as opções não especificadas serão padrão para seus valores atuais. |
set |
Defina as opções de tráfego para o mapa. Todas as opções não especificadas serão padrão para seus valores atuais. |
set |
Defina os manipuladores de interação do usuário do controle de mapa. Todas as opções não especificadas serão padrão para seus valores atuais. |
stop() | Interrompe qualquer transição animada que esteja em andamento no momento. |
trigger |
Dispare a renderização de um único quadro. Use esse método com camadas WebGL para repintar o mapa quando as propriedades ou propriedades da camada associadas à alteração de origem da camada forem alteradas. Chamar isso várias vezes antes do próximo quadro ser renderizado ainda resultará na renderização de apenas um único quadro. |
Detalhes do construtor
Map(string | HTMLElement, ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))
Exibe um mapa no contêiner especificado.
new Map(container: string | HTMLElement, options: ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))
Parâmetros
- container
-
string | HTMLElement
A ID do elemento em que o mapa deve ser exibido.
- options
-
ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions)
Opções para a exibição inicial e interatividade com o mapa.
Detalhes da propriedade
authentication
controls
events
imageSprite
isDisposed
Retornará true se o mapa tiver sido descartado.
boolean isDisposed
Valor da propriedade
boolean
layers
markers
popups
sources
Detalhes do método
areTilesLoaded()
Retorna um booliano que indica se todos os blocos no visor atual para todas as fontes foram carregados ou não.
function areTilesLoaded(): boolean
Retornos
boolean
clear()
Remove todas as fontes, camadas, marcadores e pop-ups do mapa. As imagens adicionadas pelo usuário são preservadas.
function clear()
disableElevation()
Desabilita a malha de terreno 3D.
function disableElevation()
dispose()
Limpe os recursos do mapa. O mapa não funcionará corretamente depois de chamar esse método.
function dispose()
enableElevation(string | ElevationTileSource, number)
Carrega uma malha de terreno 3D, com base em uma origem "raster-dem".
function enableElevation(elevationSource: string | ElevationTileSource, exaggeration?: number)
Parâmetros
- elevationSource
-
string | ElevationTileSource
origem do bloco de elevação
- exaggeration
-
number
o fator de exagero de elevação
getCamera()
Retorna as propriedades atuais da câmera.
function getCamera(): CameraOptions & CameraBoundsOptions
Retornos
getCanvas()
Retorna o HTMLCanvasElement ao qual o mapa é desenhado.
function getCanvas(): HTMLCanvasElement
Retornos
HTMLCanvasElement
getCanvasContainer()
Retorna o HTMLElement que contém o HTMLCanvasElement do mapa. Os eventos do mapa (por exemplo, movimento panorâmico e zoom) são anexados a esse elemento.
function getCanvasContainer(): HTMLElement
Retornos
HTMLElement
getMapContainer()
Retorna o HTMLElement que contém o mapa.
function getMapContainer(): HTMLElement
Retornos
HTMLElement
getServiceOptions()
Retorna as opções de serviço com as quais o controle de mapa foi inicializado.
function getServiceOptions(): ServiceOptions
Retornos
getStyle()
Retorna as configurações de estilo atuais do controle de mapa.
function getStyle(): StyleOptions
Retornos
getTraffic()
Retornar as configurações de tráfego atuais do controle de mapa.
function getTraffic(): TrafficOptions
Retornos
getUserInteraction()
Retornar as configurações atuais do manipulador de interação do usuário do controle de mapa.
function getUserInteraction(): UserInteractionOptions
Retornos
pixelsToPositions(Pixel[])
Converte uma matriz de objetos Pixel em uma matriz de objetos Positions geográficos no mapa.
function pixelsToPositions(pixels: Pixel[]): Position[]
Parâmetros
- pixels
-
Pixel[]
Os pixels a serem convertidos.
Retornos
Position[]
positionsToPixels(Position[])
Converte uma matriz de objetos Positions em uma matriz de objetos Pixel em relação ao contêiner de mapa.
function positionsToPixels(positions: Position[]): Pixel[]
Parâmetros
- positions
-
Position[]
As posições a serem convertidas.
Retornos
Pixel[]
resize(any)
Redimensione o mapa de acordo com as dimensões de seu elemento de contêiner.
function resize(eventData?: any)
Parâmetros
- eventData
-
any
Propriedades adicionais opcionais a serem adicionadas a objetos de evento de eventos disparados por esse método.
resize(number | string, number | string, any)
Redimensiona o elemento contêiner 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 seu elemento de contêiner. Supõe-se que uma entrada numérica esteja em pixels.
- width
-
number | string
A largura do mapa e seu elemento de contêiner. Supõe-se que uma entrada numérica esteja em pixels.
- eventData
-
any
Propriedades adicionais opcionais a serem adicionadas a objetos de evento de eventos disparados por esse método.
setCamera((CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)
Defina a câmera do controle de mapa com uma transição animada. Todas as opções não especificadas serão padrão para seus 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âmera do mapa e para a animação de qualquer alteração de exibição.
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 controle de mapa. Todas as opções não especificadas serão padrão para seus valores atuais.
function setStyle(options?: StyleOptions, diff?: boolean)
Parâmetros
- options
- StyleOptions
As opções para definir o estilo do controle de mapa.
- diff
-
boolean
Se for false, forçará uma atualização de estilo "completa", removendo o estilo atual e criando o determinado em vez de tentar uma atualização baseada em dif. O padrão é verdadeiro.
setTraffic(TrafficOptions)
Defina as opções de tráfego para o mapa. Todas as opções não especificadas serão padrão para seus valores atuais.
function setTraffic(options?: TrafficOptions)
Parâmetros
- options
- TrafficOptions
As opções para definir a exibição de tráfego do mapa.
setUserInteraction(UserInteractionOptions)
Defina os manipuladores de interação do usuário do controle de mapa. Todas as opções não especificadas serão padrão para seus valores atuais.
function setUserInteraction(options?: UserInteractionOptions)
Parâmetros
- options
- UserInteractionOptions
As opções para habilitar/desabilitar os manipuladores de interação do usuário.
stop()
Interrompe qualquer transição animada que esteja em andamento no momento.
function stop()
triggerRepaint()
Dispare a renderização de um único quadro. Use esse método com camadas WebGL para repintar o mapa quando as propriedades ou propriedades da camada associadas à alteração de origem da camada forem alteradas. Chamar isso várias vezes antes do próximo quadro ser renderizado ainda resultará na renderização de apenas um único quadro.
function triggerRepaint()