Map class
Kontrolka wizualizacji i interaktywnej mapy internetowej.
Konstruktory
Map(string | HTMLElement, Service |
Wyświetla mapę w określonym kontenerze. |
Właściwości
authentication | |
controls | |
events | |
image |
|
is |
Zwraca wartość true, jeśli mapa została usunięta. |
layers | |
markers | |
popups | |
sources |
Metody
are |
Zwraca wartość logiczną wskazującą, czy wszystkie kafelki w bieżącym porcie widoków dla wszystkich źródeł zostały załadowane lub nie. |
clear() | Usuwa wszystkie źródła, warstwy, znaczniki i wyskakujące okienka z mapy. Obrazy dodane przez użytkownika są zachowywane. |
disable |
Wyłącza siatkę terenową 3D. |
dispose() | Wyczyść zasoby mapy. Mapa nie będzie działać poprawnie po wywołaniu tej metody. |
enable |
Ładuje siatkę terenową 3D na podstawie źródła "raster-dem". |
get |
Zwraca bieżące właściwości aparatu. |
get |
Zwraca element HTMLCanvasElement, do którego jest rysowana mapa. |
get |
Zwraca element HTMLElement zawierający element HTMLCanvasElement mapy. Zdarzenia mapy (np. przesuwanie i powiększanie) są dołączone do tego elementu. |
get |
Zwraca element HTMLElement zawierający mapę. |
get |
Zwraca opcje usługi, za pomocą których zainicjowano kontrolkę mapy. |
get |
Zwraca bieżące ustawienia stylu kontrolki mapy. |
get |
Zwróć bieżące ustawienia ruchu kontrolki mapy. |
get |
Zwróć bieżące ustawienia procedury obsługi interakcji użytkownika kontrolki mapy. |
pixels |
Konwertuje tablicę obiektów Pixel na tablicę obiektów pozycji geograficznych na mapie. |
positions |
Konwertuje tablicę obiektów Pozycji na tablicę obiektów Pixel względem kontenera mapy. |
resize(any) | Zmień rozmiar mapy zgodnie z wymiarami jego elementu kontenera. |
resize(number | string, number | string, any) | Zmienia rozmiar elementu kontenera mapy, a następnie samą mapę. |
set |
Ustaw aparat kontrolki mapy z animowanym przejściem. Wszystkie opcje, które nie zostały określone, będą domyślne dla ich bieżących wartości. |
set |
Ustaw opcje usługi. |
set |
Ustaw opcje stylu kontrolki mapy. Wszystkie opcje, które nie zostały określone, będą domyślne dla ich bieżących wartości. |
set |
Ustaw opcje ruchu dla mapy. Wszystkie opcje, które nie zostały określone, będą domyślne dla ich bieżących wartości. |
set |
Ustaw programy obsługi interakcji użytkownika kontrolki mapy. Wszystkie opcje, które nie zostały określone, będą domyślne dla ich bieżących wartości. |
stop() | Zatrzymuje wszelkie animowane przejście, które jest obecnie w toku. |
trigger |
Wyzwalanie renderowania pojedynczej ramki. Użyj tej metody z warstwami WebGL, aby ponownie zaintować mapę, gdy właściwości lub właściwości warstwy skojarzone ze zmianą źródła warstwy. Wywołanie tej funkcji wiele razy przed renderowaniem następnej ramki spowoduje renderowanie tylko jednej ramki. |
Szczegóły konstruktora
Map(string | HTMLElement, ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))
Wyświetla mapę w określonym kontenerze.
new Map(container: string | HTMLElement, options: ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))
Parametry
- container
-
string | HTMLElement
Identyfikator elementu, w którym powinna być wyświetlana mapa.
- options
-
ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions)
Opcje początkowego wyświetlania i interakcji z mapą.
Szczegóły właściwości
authentication
controls
events
imageSprite
isDisposed
Zwraca wartość true, jeśli mapa została usunięta.
boolean isDisposed
Wartość właściwości
boolean
layers
markers
popups
sources
Szczegóły metody
areTilesLoaded()
Zwraca wartość logiczną wskazującą, czy wszystkie kafelki w bieżącym porcie widoków dla wszystkich źródeł zostały załadowane lub nie.
function areTilesLoaded(): boolean
Zwraca
boolean
clear()
Usuwa wszystkie źródła, warstwy, znaczniki i wyskakujące okienka z mapy. Obrazy dodane przez użytkownika są zachowywane.
function clear()
disableElevation()
Wyłącza siatkę terenową 3D.
function disableElevation()
dispose()
Wyczyść zasoby mapy. Mapa nie będzie działać poprawnie po wywołaniu tej metody.
function dispose()
enableElevation(string | ElevationTileSource, number)
Ładuje siatkę terenową 3D na podstawie źródła "raster-dem".
function enableElevation(elevationSource: string | ElevationTileSource, exaggeration?: number)
Parametry
- elevationSource
-
string | ElevationTileSource
źródło kafelka podniesienia uprawnień
- exaggeration
-
number
współczynnik przesady podniesienia
getCamera()
Zwraca bieżące właściwości aparatu.
function getCamera(): CameraOptions & CameraBoundsOptions
Zwraca
getCanvas()
Zwraca element HTMLCanvasElement, do którego jest rysowana mapa.
function getCanvas(): HTMLCanvasElement
Zwraca
HTMLCanvasElement
getCanvasContainer()
Zwraca element HTMLElement zawierający element HTMLCanvasElement mapy. Zdarzenia mapy (np. przesuwanie i powiększanie) są dołączone do tego elementu.
function getCanvasContainer(): HTMLElement
Zwraca
HTMLElement
getMapContainer()
Zwraca element HTMLElement zawierający mapę.
function getMapContainer(): HTMLElement
Zwraca
HTMLElement
getServiceOptions()
Zwraca opcje usługi, za pomocą których zainicjowano kontrolkę mapy.
function getServiceOptions(): ServiceOptions
Zwraca
getStyle()
Zwraca bieżące ustawienia stylu kontrolki mapy.
function getStyle(): StyleOptions
Zwraca
getTraffic()
Zwróć bieżące ustawienia ruchu kontrolki mapy.
function getTraffic(): TrafficOptions
Zwraca
getUserInteraction()
Zwróć bieżące ustawienia procedury obsługi interakcji użytkownika kontrolki mapy.
function getUserInteraction(): UserInteractionOptions
Zwraca
pixelsToPositions(Pixel[])
Konwertuje tablicę obiektów Pixel na tablicę obiektów pozycji geograficznych na mapie.
function pixelsToPositions(pixels: Pixel[]): Position[]
Parametry
- pixels
-
Pixel[]
Piksele do przekonwertowania.
Zwraca
Position[]
positionsToPixels(Position[])
Konwertuje tablicę obiektów Pozycji na tablicę obiektów Pixel względem kontenera mapy.
function positionsToPixels(positions: Position[]): Pixel[]
Parametry
- positions
-
Position[]
Pozycje do konwersji.
Zwraca
Pixel[]
resize(any)
Zmień rozmiar mapy zgodnie z wymiarami jego elementu kontenera.
function resize(eventData?: any)
Parametry
- eventData
-
any
Opcjonalne dodatkowe właściwości do dodania do obiektów zdarzeń zdarzeń wyzwalanych przez tę metodę.
resize(number | string, number | string, any)
Zmienia rozmiar elementu kontenera mapy, a następnie samą mapę.
function resize(height: number | string, width: number | string, eventData?: any)
Parametry
- height
-
number | string
Wysokość mapy i jej elementu kontenera. Zakłada się, że liczba wejściowa jest wyrażona w pikselach.
- width
-
number | string
Szerokość mapy i jej elementu kontenera. Zakłada się, że liczba wejściowa jest wyrażona w pikselach.
- eventData
-
any
Opcjonalne dodatkowe właściwości do dodania do obiektów zdarzeń zdarzeń wyzwalanych przez tę metodę.
setCamera((CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)
Ustaw aparat kontrolki mapy z animowanym przejściem. Wszystkie opcje, które nie zostały określone, będą domyślne dla ich bieżących wartości.
function setCamera(options?: (CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)
Parametry
- options
-
(CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions
Opcje ustawiania aparatu mapy i animacji dowolnego widoku.
setServiceOptions(ServiceOptions)
Ustaw opcje usługi.
function setServiceOptions(options: ServiceOptions)
Parametry
- options
- ServiceOptions
setStyle(StyleOptions, boolean)
Ustaw opcje stylu kontrolki mapy. Wszystkie opcje, które nie zostały określone, będą domyślne dla ich bieżących wartości.
function setStyle(options?: StyleOptions, diff?: boolean)
Parametry
- options
- StyleOptions
Opcje ustawiania stylu kontrolki mapy.
- diff
-
boolean
Jeśli fałsz, wymusza aktualizację stylu "full", usuwając bieżący styl i tworząc daną zamiast próby aktualizacji opartej na różnicy. Wartość domyślna to true.
setTraffic(TrafficOptions)
Ustaw opcje ruchu dla mapy. Wszystkie opcje, które nie zostały określone, będą domyślne dla ich bieżących wartości.
function setTraffic(options?: TrafficOptions)
Parametry
- options
- TrafficOptions
Opcje definiowania wyświetlania ruchu mapy.
setUserInteraction(UserInteractionOptions)
Ustaw programy obsługi interakcji użytkownika kontrolki mapy. Wszystkie opcje, które nie zostały określone, będą domyślne dla ich bieżących wartości.
function setUserInteraction(options?: UserInteractionOptions)
Parametry
- options
- UserInteractionOptions
Opcje włączania/wyłączania procedur obsługi interakcji użytkownika.
stop()
Zatrzymuje wszelkie animowane przejście, które jest obecnie w toku.
function stop()
triggerRepaint()
Wyzwalanie renderowania pojedynczej ramki. Użyj tej metody z warstwami WebGL, aby ponownie zaintować mapę, gdy właściwości lub właściwości warstwy skojarzone ze zmianą źródła warstwy. Wywołanie tej funkcji wiele razy przed renderowaniem następnej ramki spowoduje renderowanie tylko jednej ramki.
function triggerRepaint()