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

Class: VectorLayer

VectorLayer

Класс слоя типа VectorLayer - рендеринг производится на стороне клиента на основе сведений о геометрии и атрибутах объектов, а также назначенной функции стилизации (рендерера)

new VectorLayer(params)

Создание экземляра слоя типа VectorLayer

Parameters:
Name Type Description
params
Properties
Name Type Description
url

адрес геосервера
className

имя слоя
mappings object

словарь полей (свойств) слоя
Source:

Extends

Methods

addFeatures(data)

Добавить объекты в источник

.

Добавить объекты в источник

Parameters:
Name Type Description
data
Source:

draw(params)

Создание нового объекта и сохранение в dataSource

.

Создание нового объекта и сохранение в dataSource

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

шаблон свойств создаваемого объекта
snap boolean

привязка к другим объектам (true, false)
Source:

emit(eventName, context)

Инициация события с контекстом

.

Инициация события с контекстом

Parameters:
Name Type Description
eventName
context
Source:

getDisplayField()

Возвращает имя поля, используемое для подписи

.

Возвращает имя поля, используемое для подписи

Source:
Returns:
Type
*

getFeatures(params)

Получить список объектов источника

.

Получить список объектов источника

Parameters:
Name Type Description
params
Source:
Returns:
Type
* | Array.<(ol.Feature|ol.render.Feature)> | ol.Collection.<ol.Feature> | Array.<ol.Feature>

getFields()

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

.

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

Source:
Returns:
Type
* | Object

getGeometryType()

Возвращает тип геометрии слоя

.

Возвращает тип геометрии слоя

Source:
Returns:
  • тип геометрии
Type
string

getMap()

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

.

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

Inherited From:
Source:
Returns:
Type
*

getOpacity()

Возвращает прозрачность слоя

.

Возвращает прозрачность слоя

Source:

getState()

Получение текущего состояния слоя

.

Получение текущего состояния слоя

Inherited From:
Source:

getStyle()

Получает стиль объекта (слоя)

.

Получает стиль объекта (слоя)

Overrides:
Source:

getTransactionMode()

Возвращает текущий режим применения транзакций редактирования

.

Возвращает текущий режим применения транзакций редактирования

Source:
Returns:
Type
* | string

getVisibility()

Получение текущей видимости слоя

.

Получение текущей видимости слоя

Inherited From:
Source:

identify(params)

Идентификация объектов на слое

.

Идентификация объектов на слое

Parameters:
Name Type Description
params
Overrides:
Source:
Returns:
Type
* | Array.<(ol.Feature|ol.render.Feature)> | ol.Collection.<ol.Feature> | Array.<ol.Feature>

initStore(params)

Parameters:
Name Type Description
params object
Properties
Name Type Description
className string

имя класса
mappings object

объект, содержащий трансляцию полей (подстановка)
displayField string

подписываемое поле
Overrides:
Source:

legend()

Прокси для запроса легенды Возвращает либо асинхронную, либо синхронную версию

.

Прокси для запроса легенды Возвращает либо асинхронную, либо синхронную версию

Source:
Returns:
Type
*

<async> loadFeatureFromService(featureId)

Получение feature из сервиса

.

Получение feature из сервиса

Parameters:
Name Type Description
featureId string

featureId
Source:

modify(params)

Включает модификацию объектов слоя

.

Включает модификацию объектов слоя

Parameters:
Name Type Description
params
Source:

off(eventName)

Выключение подписки на событие

.

Выключение подписки на событие

Parameters:
Name Type Description
eventName
Overrides:
Source:

on(eventName, listener)

Подписка на события

.

Подписка на события

Parameters:
Name Type Description
eventName
listener
Overrides:
Source:

query(params)

Выполняет запрос к объектам слоя (через сервис или локально)

.

Выполняет запрос к объектам слоя (через сервис или локально)

Parameters:
Name Type Description
params
Overrides:
Source:

remove(params)

Удаляет объекты слоя

.

Удаляет объекты слоя

Parameters:
Name Type Description
params
Source:

removeFeature(feature)

Удаление feature из источника

.

Удаление feature из источника

Parameters:
Name Type Description
feature
Source:

removeFeatureByProperty(params)

Удаление feature из источника через указания свойства и значения

.

Удаление feature из источника через указания свойства и значения

Parameters:
Name Type Description
params object

параметры поиска

Properties
Name Type Description
key string

имя свойства
value string

искомое значение
Source:

Выполняет поисковый запрос к слою

.

Выполняет поисковый запрос к слою

Parameters:
Name Type Description
params object
Properties
Name Type Description
query string

поисковый запрос, например, ПС-12
minLength number

минимальная длина запроса, по умолчанию - 1 символ
Overrides:
Source:
Returns:
Type
*

setMap(map)

Присвоение объекта родительской карты

.

Присвоение объекта родительской карты

Parameters:
Name Type Description
map
Inherited From:
Source:

setMode()

Динамическое изменение на режим отображения heatmap

.

Динамическое изменение на режим отображения heatmap

Source:

setOpacity(value)

Устанавливает прозрачность слоя

.

Устанавливает прозрачность слоя

Parameters:
Name Type Description
value number

степень прозначности в диапазоне от 0 до 1
Source:

setOptions(params)

Применяет переданные свойства к слою

.

Применяет переданные свойства к слою

Parameters:
Name Type Description
params object

изменеяемые свойства

Properties
Name Type Description
visible boolean

видимость слоя
opacity number

прозрачносиь слоя
minResolution number

минимальное разрешение
maxResolution number

максимальное разрешение
style object

конфигурация стиля
zIndex number

уровень слоя
Source:
Returns:
  • результат выполнения операции
Type
boolean

setStyle(style)

Parameters:
Name Type Description
style

объект типа style
Overrides:
Source:

setTransactionMode(params)

Управление режимом применения изменений при редактировании

.

Управление режимом применения изменений при редактировании

Parameters:
Name Type Description
params object
Properties
Name Type Description
transactionMode string

Возможные значения: direct - выполнение транзакций немедленно, stack - передача транзакий в глобальный стек (сессии)
Source:

setVisibility(value, afterTimeValue)

Установление видимости слоя

.

Установление видимости слоя

Parameters:
Name Type Description
value boolean

Возможные значения - true, false
afterTimeValue
Inherited From:
Source:

snap(params)

Включает или выключает привязку к другим объектам слоя

.

Включает или выключает привязку к другим объектам слоя

Parameters:
Name Type Description
params
Source:

<async> transact()

Создание транзакции, которая в зависимости от текущего значения режима - getTransactionMode() - выполняется немедленно или передается в стек операций

.

Создание транзакции, которая в зависимости от текущего значения режима - getTransactionMode() - выполняется немедленно или передается в стек операций

Source: