Map class
Элемент управления для визуальной и интерактивной веб-карты.
Конструкторы
Map(string | HTMLElement, Service |
Отображает карту в указанном контейнере. |
Свойства
authentication | |
controls | |
events | |
image |
|
is |
Возвращает значение true, если карта была удалена. |
layers | |
markers | |
popups | |
sources |
Методы
are |
Возвращает логическое значение, указывающее, загружены ли все плитки в текущем окне просмотра для всех источников. |
clear() | Удаляет из карты все источники, слои, маркеры и всплывающие окна. Изображения, добавленные пользователем, сохраняются. |
disable |
Отключает трехмерную сетку ландшафта. |
dispose() | Очистите ресурсы карты. Map не будет работать правильно после вызова этого метода. |
enable |
Загружает трехмерную сетку ландшафта на основе источника raster-dem. |
get |
Возвращает текущие свойства камеры. |
get |
Возвращает объект HTMLCanvasElement, к которому отрисовывается карта. |
get |
Возвращает элемент HTMLElement, содержащий htmlCanvasElement карты. События карты (например, сдвиг и масштабирование) присоединяются к этому элементу. |
get |
Возвращает элемент HTMLElement, содержащий карту. |
get |
Возвращает параметры службы, с помощью которых был инициализирован элемент управления картой. |
get |
Возвращает текущие параметры стиля элемента управления картой. |
get |
Возвращает текущие параметры трафика элемента управления картой. |
get |
Возвращает текущие параметры обработчика взаимодействия с пользователем элемента управления картой. |
pixels |
Преобразует массив объектов Pixel в массив объектов географических позиций на карте. |
positions |
Преобразует массив объектов Positions в массив объектов Pixel относительно контейнера карты. |
resize(any) | Измените размер карты в соответствии с размерами ее элемента контейнера. |
resize(number | string, number | string, any) | Изменяет размер элемента контейнера карты, а затем саму карту. |
set |
Задайте камеру элемента управления картой с анимированным переходом. Для всех параметров, не указанных, по умолчанию будут заданы текущие значения. |
set |
Задайте параметры службы. |
set |
Задайте параметры стиля элемента управления картой. Для всех параметров, не указанных, по умолчанию будут заданы текущие значения. |
set |
Задайте параметры трафика для карты. Для всех параметров, не указанных, по умолчанию будут заданы текущие значения. |
set |
Задайте обработчики взаимодействия с пользователем элемента управления картой. Для всех параметров, не указанных, по умолчанию будут заданы текущие значения. |
stop() | Останавливает любой анимированный переход, который в настоящее время выполняется. |
trigger |
Активация отрисовки одного кадра. Используйте этот метод со слоями WebGL для перекраски карты при изменении свойств слоя или свойств, связанных с источником слоя. Вызов этого метода несколько раз до отрисовки следующего кадра по-прежнему приведет к отображению только одного кадра. |
Сведения о конструкторе
Map(string | HTMLElement, ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))
Отображает карту в указанном контейнере.
new Map(container: string | HTMLElement, options: ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))
Параметры
- container
-
string | HTMLElement
Идентификатор элемента, в котором должна отображаться карта.
- options
-
ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions)
Параметры для начального отображения и взаимодействия с картой.
Сведения о свойстве
authentication
controls
events
imageSprite
isDisposed
Возвращает значение true, если карта была удалена.
boolean isDisposed
Значение свойства
boolean
layers
markers
popups
sources
Сведения о методе
areTilesLoaded()
Возвращает логическое значение, указывающее, загружены ли все плитки в текущем окне просмотра для всех источников.
function areTilesLoaded(): boolean
Возвращаемое значение
boolean
clear()
Удаляет из карты все источники, слои, маркеры и всплывающие окна. Изображения, добавленные пользователем, сохраняются.
function clear()
disableElevation()
Отключает трехмерную сетку ландшафта.
function disableElevation()
dispose()
Очистите ресурсы карты. Map не будет работать правильно после вызова этого метода.
function dispose()
enableElevation(string | ElevationTileSource, number)
Загружает трехмерную сетку ландшафта на основе источника raster-dem.
function enableElevation(elevationSource: string | ElevationTileSource, exaggeration?: number)
Параметры
- elevationSource
-
string | ElevationTileSource
Источник плитки с повышенными правами
- exaggeration
-
number
коэффициент преувеличения высоты
getCamera()
Возвращает текущие свойства камеры.
function getCamera(): CameraOptions & CameraBoundsOptions
Возвращаемое значение
getCanvas()
Возвращает объект HTMLCanvasElement, к которому отрисовывается карта.
function getCanvas(): HTMLCanvasElement
Возвращаемое значение
HTMLCanvasElement
getCanvasContainer()
Возвращает элемент HTMLElement, содержащий htmlCanvasElement карты. События карты (например, сдвиг и масштабирование) присоединяются к этому элементу.
function getCanvasContainer(): HTMLElement
Возвращаемое значение
HTMLElement
getMapContainer()
Возвращает элемент HTMLElement, содержащий карту.
function getMapContainer(): HTMLElement
Возвращаемое значение
HTMLElement
getServiceOptions()
Возвращает параметры службы, с помощью которых был инициализирован элемент управления картой.
function getServiceOptions(): ServiceOptions
Возвращаемое значение
getStyle()
Возвращает текущие параметры стиля элемента управления картой.
function getStyle(): StyleOptions
Возвращаемое значение
getTraffic()
Возвращает текущие параметры трафика элемента управления картой.
function getTraffic(): TrafficOptions
Возвращаемое значение
getUserInteraction()
Возвращает текущие параметры обработчика взаимодействия с пользователем элемента управления картой.
function getUserInteraction(): UserInteractionOptions
Возвращаемое значение
pixelsToPositions(Pixel[])
Преобразует массив объектов Pixel в массив объектов географических позиций на карте.
function pixelsToPositions(pixels: Pixel[]): Position[]
Параметры
- pixels
-
Pixel[]
Преобразуемые пиксели.
Возвращаемое значение
Position[]
positionsToPixels(Position[])
Преобразует массив объектов Positions в массив объектов Pixel относительно контейнера карты.
function positionsToPixels(positions: Position[]): Pixel[]
Параметры
- positions
-
Position[]
Преобразуемые позиции.
Возвращаемое значение
Pixel[]
resize(any)
Измените размер карты в соответствии с размерами ее элемента контейнера.
function resize(eventData?: any)
Параметры
- eventData
-
any
Необязательные дополнительные свойства, добавляемые к объектам событий событий, активируемых этим методом.
resize(number | string, number | string, any)
Изменяет размер элемента контейнера карты, а затем саму карту.
function resize(height: number | string, width: number | string, eventData?: any)
Параметры
- height
-
number | string
Высота карты и ее элемента контейнера. Предполагается, что входные данные числа в пикселях.
- width
-
number | string
Ширина карты и ее элемента контейнера. Предполагается, что входные данные числа в пикселях.
- eventData
-
any
Необязательные дополнительные свойства, добавляемые к объектам событий событий, активируемых этим методом.
setCamera((CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)
Задайте камеру элемента управления картой с анимированным переходом. Для всех параметров, не указанных, по умолчанию будут заданы текущие значения.
function setCamera(options?: (CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)
Параметры
- options
-
(CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions
Параметры настройки камеры карты и анимации любого изменения представления.
setServiceOptions(ServiceOptions)
Задайте параметры службы.
function setServiceOptions(options: ServiceOptions)
Параметры
- options
- ServiceOptions
setStyle(StyleOptions, boolean)
Задайте параметры стиля элемента управления картой. Для всех параметров, не указанных, по умолчанию будут заданы текущие значения.
function setStyle(options?: StyleOptions, diff?: boolean)
Параметры
- options
- StyleOptions
Параметры для настройки стиля элемента управления картой.
- diff
-
boolean
Если задано значение false, выполняется принудительное обновление "полного" стиля, удаление текущего стиля и создание заданного стиля вместо попытки обновления на основе diff. По умолчанию используется значение «true».
setTraffic(TrafficOptions)
Задайте параметры трафика для карты. Для всех параметров, не указанных, по умолчанию будут заданы текущие значения.
function setTraffic(options?: TrafficOptions)
Параметры
- options
- TrafficOptions
Параметры для определения отображения трафика карты.
setUserInteraction(UserInteractionOptions)
Задайте обработчики взаимодействия с пользователем элемента управления картой. Для всех параметров, не указанных, по умолчанию будут заданы текущие значения.
function setUserInteraction(options?: UserInteractionOptions)
Параметры
- options
- UserInteractionOptions
Параметры для включения и отключения обработчиков взаимодействия с пользователем.
stop()
Останавливает любой анимированный переход, который в настоящее время выполняется.
function stop()
triggerRepaint()
Активация отрисовки одного кадра. Используйте этот метод со слоями WebGL для перекраски карты при изменении свойств слоя или свойств, связанных с источником слоя. Вызов этого метода несколько раз до отрисовки следующего кадра по-прежнему приведет к отображению только одного кадра.
function triggerRepaint()