geoObject.Sequence

Расширяет IGeoObject , IGeoObjectSequence .

Неизменяемая коллекция геообъектов. Позволяет группировать геообъекты для добавления на карту, задания опций и т.д. Коллекция также является геообъектом.

Конструктор | Поля | События | Методы

Конструктор

geoObject.Sequence([feature[, options]])

Создает неизменяемую коллекцию геообъектов.

Параметры:

Параметр Значение по умолчанию Описание
feature

Тип: Object

Описание коллекции. Функционально соответствует описанию геообъекта. См.: GeoObject

feature.children

Тип: IGeoObject []

Массив дочерних геообъектов.

feature.geometry

Тип: IGeometry |Object

Геометрия коллекции.

feature.properties

Тип: IDataManager |Object

Данные коллекции.

options

Тип: Object

Опции коллекции. Здесь можно задавать все опции, описанные в классе GeoObject . Значения опций будут применяться как к самой коллекции, так и к ее дочерним объектам, если для них данные опции не определены.

Поля

Имя Тип Описание
events IEventManager

Менеджер событий.

Унаследовано от IDomEventEmitter .

geometry IGeometry |null

Геометрия геообъекта.

Унаследовано от IGeoObject .

options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable .

properties IDataManager

Данные геообъекта.

Унаследовано от IGeoObject .

state IDataManager

Состояние геообъекта.

Унаследовано от IGeoObject .

События

Имя Описание
boundschange

Изменение координат географической области, охватывающей коллекцию и ее дочерние геообъекты. Экземпляр класса Event .

Унаследовано от IGeoObjectSequence .

click

Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager .

Унаследовано от IDomEventEmitter .

contextmenu

Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager .

Унаследовано от IDomEventEmitter .

dblclick

Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager .

Унаследовано от IDomEventEmitter .

geometrychange
Изменение геометрии геообъекта. Экземпляр класса Event . Имена полей, доступных через метод Event.get :
  • originalEvent: IEvent - оригинальное событие геометрии.

Унаследовано от IGeoObject .

mapchange
Сменилась карта. Поля данных:
  • oldMap - старая карта;
  • newMap - новая карта.

Унаследовано от IParentOnMap .

mousedown

Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager .

Унаследовано от IDomEventEmitter .

mouseenter

Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager .

Унаследовано от IDomEventEmitter .

mouseleave

Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager .

Унаследовано от IDomEventEmitter .

mousemove

Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager .

Унаследовано от IDomEventEmitter .

mouseup

Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager .

Унаследовано от IDomEventEmitter .

multitouchend

Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent.

Унаследовано от IDomEventEmitter .

multitouchmove
Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
  • clientX - координата касания X относительно видимой области браузера;
  • clientY - координата касания Y относительно видимой области браузера;
  • pageX - координата касания X касания относительно начала документа;
  • pageY - координата касания Y касания относительно начала документа.

Унаследовано от IDomEventEmitter .

multitouchstart
Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
  • clientX - координата касания X относительно видимой области браузера;
  • clientY - координата касания Y относительно видимой области браузера;
  • pageX - координата касания X касания относительно начала документа;
  • pageY - координата касания Y касания относительно начала документа.

Унаследовано от IDomEventEmitter .

optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable .

overlaychange
Изменение оверлея геообъекта. Экземпляр класса Event . Имена полей, доступных через метод Event.get :
  • overlay: IOverlay |null - ссылка на оверлей;
  • oldOverlay: IOverlay |null - предыдущий оверлей геообъекта.

Унаследовано от IGeoObject .

parentchange

Сменился родительский объект.

Поля данных:

  • oldParent - старый родитель;
  • newParent - новый родитель.

Унаследовано от IChild .

pixelboundschange

Изменение пиксельных координат области, охватывающей коллекцию и ее дочерние геообъекты. Экземпляр класса Event .

Унаследовано от IGeoObjectSequence .

propertieschange
Изменение данных геообъекта. Экземпляр класса Event . Имена полей, доступных через метод Event.get :
  • originalEvent: IEvent - оригинальное событие менеджера данных.

Унаследовано от IGeoObject .

wheel

Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager .

Унаследовано от IDomEventEmitter .

Методы

Имя Возвращает Описание
each (callback[, context])

Для каждого дочернего геообъекта, вызывает функцию-обработчик.

Унаследован от IGeoObjectSequence .

get (index)

IGeoObject

Возвращает дочерний геообъект с заданным индексом.

Унаследован от IGeoObjectSequence .

getBounds ()

Number[][]|null

Возвращает географические координаты области, охватывающей коллекции и ее дочерние геообъекты.

Унаследован от IGeoObjectSequence .

getIterator ()

IIterator

Возвращает итератор по дочерним геообъектам коллекции.

Унаследован от IGeoObjectSequence .

getLength ()

Integer

Возвращает длину коллекции.

Унаследован от IGeoObjectSequence .

getMap ()

Map

Возвращает ссылку на карту.

Унаследован от IParentOnMap .

getOverlay ()

vow.Promise

Возвращает объект-обещание, который подтверждается объектом оверлея в момент его фактического создания, либо отклоняется с передачей соответствующей ошибки.

Унаследован от IGeoObject .

getOverlaySync ()

IOverlay |null

Метод предоставляет синхронный доступ к оверлею.

Унаследован от IGeoObject .

getParent ()

IParentOnMap |null

Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.

Унаследован от IChildOnMap .

getPixelBounds ()

Number[][]|null

Возвращает глобальные пиксельные координаты области, охватывающей коллекцию и ее дочерние геообъекты.

Унаследован от IGeoObjectSequence .

indexOf (object)

Integer

Возвращает индекс дочернего геообъекта. Если геообъект в коллекции не найден, возвращается -1.

Унаследован от IGeoObjectSequence .

setParent (parent)

IChildOnMap

Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

Унаследован от IChildOnMap .