Energy Client (web) 2D/3D Cartography API ver.1.10.64

Class: Map

Map

Класс Map предназначен для создания плоских, самых обыкновенных карт

new Map(params)

Создает объект карты в соответствии с переданными параметрами (params)

Parameters:
Name Type Description
params object

начальные параметры для создания экземпляра карты

Properties
Name Type Description
name string

имя карты
target string

идентификатор DOM элемента
layers array

массив слоев, включаемых в карту при начале работы
loadTilesWhileAnimating boolean

загружать тайлы при анимации
loadTilesWhileInteracting boolean

загружать тайлы при вызове взаимодействий
longitude number

стартовая долгота
latitude number

стартовая долгота
zoom number

уровень приближения
projection string

код проекции
renderer string

код рендерера - webgl, canvas (по умолчанию - webgl)
baseMap string

код базовой карты
snapDefault boolean

включать привязку к объектам слоев при их добавлении на карту
Source:

Extends

Methods

add(data)

Добавляет слои на карту

.

Добавляет слои на карту

Parameters:
Name Type Description
data array | object

массив слоев любого допустимого типа
Source:
Returns:
Type
Map

center(params)

Выполняет центрирование карты по заданным координатам

.

Выполняет центрирование карты по заданным координатам

Parameters:
Name Type Description
params
Properties
Name Type Description
coordinates array

координаты центра
transform object

необязательный параметр трансформации

Properties
Name Type Description
source string

исходная проекция
destination string

целевая проекция
Overrides:
Source:

clearGraphics()

Очистка графики на карте

.

Очистка графики на карте

Source:

click(func)

Подписка на событие клика по карте

.

Подписка на событие клика по карте

Parameters:
Name Type Description
func function

функция обратного вызова
Source:
Returns:
Type
Promise

destroy()

Уничтожить объект карты и ссылки на слои

.

Уничтожить объект карты и ссылки на слои

Inherited From:
Source:

emit(eventName)

Создание события

.

Создание события

Parameters:
Name Type Description
eventName
Inherited From:
Overrides:
Source:

extent(func)

Получение экстента

.

Получение экстента

Parameters:
Name Type Description
func

функция обратного вызова
Source:
Returns:

extent - Экстент карты, приведенный к типу ExtentResult

Type
Promise

geocode(params)

Parameters:
Name Type Description
params object

опции геокодирования

Properties
Name Type Description
location string

поисковый запрос
Source:
Returns:
Type
* | Promise

getBaseMap()

Получение текущей базовой карты

.

Получение текущей базовой карты

Inherited From:
Source:

getBaseMapId()

возвращает идентификатор текущей базовой карты

.

возвращает идентификатор текущей базовой карты

Source:
Returns:
Type
null

getBaseMapList()

возвращает массив встроенных базовых карт

.

возвращает массив встроенных базовых карт

Source:
Returns:
Type
*

getDescription()

Получение описания карты

.

Получение описания карты

Inherited From:
Source:

getDescriptor()

Возвращает дескрипорт карты (ol.Map)

.

Возвращает дескрипорт карты (ol.Map)

Source:
Returns:
Type
Map

getExtent()

Возвращает экстент карты

.

Возвращает экстент карты

Source:
Returns:
  • экстент карты
Type
ol.Extent

getHistory()

Получение истории карты

.

Получение истории карты

Inherited From:
Source:

getLayerByClassName(className)

Возвращает слой по имени класса

.

Возвращает слой по имени класса

Parameters:
Name Type Description
className
Source:
Returns:
Type
*

getLayerById(id)

Parameters:
Name Type Description
id

идентификатор слоя
Source:
Returns:
Type
*

getLayerByIds(ids)

Parameters:
Name Type Description
ids

идентификаторы слоя
Source:
Returns:
Type
*

getLayers()

Overrides:
Source:
Returns:
  • массив объектов типа opengis.api.layers.vector
Type
array

getMousePosition()

Получение текущей координаты курсора мыши

.

Получение текущей координаты курсора мыши

Inherited From:
Source:

getName()

Получение имени карты

.

Получение имени карты

Inherited From:
Source:

getScale()

Получение текущего масштаба

.

Получение текущего масштаба

Inherited From:
Source:

groupLayers()

Включение слоев в группу

.

Включение слоев в группу

Inherited From:
Source:

hide()

Скрытие карты

.

Скрытие карты

Inherited From:
Source:

highlight(params)

Подсветка объекта на карте

.

Подсветка объекта на карте

Parameters:
Name Type Description
params object

опции подсветки

Properties
Name Type Description
clear boolean

удалить предыдущие объекты выделения, по умолчанию выключено
feature ol.Feature

объект выделения
geometry ol.geom

геометрия выделения
Source:

identify(params)

Parameters:
Name Type Description
params
Properties
Name Type Description
func

функция обратного вызова
layers

перечень слоев для идентификации
Overrides:
Source:
Returns:
Type
*

initEvents(params)

Осуществление привязки событий

.

Осуществление привязки событий

Parameters:
Name Type Description
params
Properties
Name Type Description
identify object

описание привязки события идентификации
Source:

initGraphics(params)

Инициализация графикческого слоя

.

Инициализация графикческого слоя

Parameters:
Name Type Description
params object

опции создания графического слоя
Source:
Returns:
Type
GraphicLayer

initStack()

Инициализация стека, ассоциированного с картой (п.с.

Инициализация стека, ассоциированного с картой (п.с. - в дальнейшем будет создаваться локальный стек для каждого нового экземпляра карты)

Source:
Returns:
Type
Map

initStore(params)

Инициализация хранилища по заданным параметрам

.

Инициализация хранилища по заданным параметрам

Parameters:
Name Type Description
params object

опции создания карты

Properties
Name Type Description
GUID string

идентификатор карты
Overrides:
Source:
Returns:
Type
Map

<async> legend()

Возвращает легенду для всех слоев

.

Возвращает легенду для всех слоев

Source:
Returns:
Type
Promise.<Array>

legendSync()

Возвращает легенду для всех слоев синхронно

.

Возвращает легенду для всех слоев синхронно

Source:
Returns:
Type
Array

off(eventName)

Отвязка события от объекта

.

Отвязка события от объекта

Parameters:
Name Type Description
eventName
Inherited From:
Overrides:
Source:

on(eventName, func)

Привязка событий и вызов обратной функции

.

Привязка событий и вызов обратной функции

Parameters:
Name Type Description
eventName
func
Inherited From:
Overrides:
Source:

panTo(params)

Перемещение карты в заданную точку

.

Перемещение карты в заданную точку

Parameters:
Name Type Description
params
Inherited From:
Source:

print()

Печать содержимого карты

.

Печать содержимого карты

Inherited From:
Source:

remove(layerId)

Удаляет слой с карты

.

Удаляет слой с карты

Parameters:
Name Type Description
layerId
Source:
Returns:
Type
Map

removeLayer()

Удаление слоя с карты

.

Удаление слоя с карты

Inherited From:
Source:

reorderLayers()

Изменение порядка слоев

.

Изменение порядка слоев

Inherited From:
Source:

save()

Сохранение карты

.

Сохранение карты

Inherited From:
Source:

saveAs(params)

Выполняет сохранение карты в файл, по умолчанию с расширением png (map.png)

.

Выполняет сохранение карты в файл, по умолчанию с расширением png (map.png)

Parameters:
Name Type Description
params object

опции эскпорта

Properties
Name Type Description
fileExtention string

расширение файла
fileName string

имя файла
Overrides:
Source:
Returns:
Type
Map
Parameters:
Name Type Description
params object

опции поиска

Properties
Name Type Description
query string

Строка запроса, содержащая часть или полное значение поля
includeGeocoding boolean

использовать результаты геокодирвоания (по умолчанию - true)
Overrides:
Source:
Returns:
Type
Promise

select(params)

Инструмент выделения объектов на карте

.

Инструмент выделения объектов на карте

Parameters:
Name Type Description
params object
Source:

setBaseMap(id)

устанавливает базовую карту по идентификатору

.

устанавливает базовую карту по идентификатору

Parameters:
Name Type Description
id
Overrides:
Source:

setDescription()

Присвоение описания объекту карты

.

Присвоение описания объекту карты

Inherited From:
Source:

setExtent(params)

Устанавливает экстент карты

.

Устанавливает экстент карты

Parameters:
Name Type Description
params
Properties
Name Type Description
extent object

целевой экстент
geometry object

целевая геометрия
nearest boolean

флаг принудительного вписывания экстента к экстенту/геометрии
Source:

setName()

Присвоение имнени

.

Присвоение имнени

Inherited From:
Source:

stopInteractions()

Завершает все взаимодействия

.

Завершает все взаимодействия

Source:

Events

layer-add-result

Source:
Returns:
  • добавленный слой
Type
Layer

layers-add-result

Source:
Returns:
  • добавленные слой
Type
array