Polygon
Расширяет GeoObject.
Многоугольник. Представляет собой геообъект с геометрией geometry.Polygon.
См.: GeoObject geometry.Polygon
Конструктор | Поля | События | Методы
Конструктор
Polygon(geometry[, properties[, options]])
Создает экземпляр многоугольника.
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
geometry * | — | Тип: Number[][][]|Object|IPolygonGeometry Координаты вершин ломаных, определяющих внешнюю и внутренние границы многоугольника, хэш-объект с параметрами геометрии или ссылка на объект геометрии. Внутренняя граница может отсутствовать. |
properties | — | Тип: Object|IDataManager Данные геообъекта. Соответствуют данным класса GeoObject. |
options | — | Тип: Object Опции геообъекта. Соответствуют опциям класса GeoObject. |
Параметр | Значение по умолчанию | Описание |
---|---|---|
geometry * | — | Тип: Number[][][]|Object|IPolygonGeometry Координаты вершин ломаных, определяющих внешнюю и внутренние границы многоугольника, хэш-объект с параметрами геометрии или ссылка на объект геометрии. Внутренняя граница может отсутствовать. |
properties | — | Тип: Object|IDataManager Данные геообъекта. Соответствуют данным класса GeoObject. |
options | — | Тип: Object Опции геообъекта. Соответствуют опциям класса GeoObject. |
* Обязательный параметр/опция.
Пример:
var polygon = new ymaps.Polygon([
// Координаты внешнего контура.
[[-80, 60], [-90, 50], [-60, 40], [-80, 60]],
// Координаты внутреннего контура.
[[-90, 80], [-90, 30], [-20, 40], [-90, 80]]
], {
hintContent: "Многоугольник"
}, {
fillColor: '#6699ff',
// Делаем полигон прозрачным для событий карты.
interactivityModel: 'default#transparent',
strokeWidth: 8,
opacity: 0.5
});
myMap.geoObjects.add(polygon);
myMap.setBounds(polygon.geometry.getBounds());
Поля
Имя | Тип | Описание |
---|---|---|
balloon | geoObject.Balloon | Балун геообъекта. Унаследовано от GeoObject. |
editor | geometryEditor.Polygon | Редактор геометрии "Многоугольник". |
events | event.Manager | Менеджер событий. Унаследовано от GeoObject. |
geometry | geometry.Polygon | Геометрия типа "Многоугольник". |
hint | geoObject.Hint | Хинт геообъекта. Унаследовано от GeoObject. |
options | option.Manager | Менеджер опций геообъекта. Унаследовано от GeoObject. |
properties | data.Manager | Менеджер данных геообъекта. Унаследовано от GeoObject. |
state | data.Manager | Состояние геообъекта. Определяется следующими полями:
Унаследовано от GeoObject. |
Имя | Тип | Описание |
---|---|---|
balloon | geoObject.Balloon | Балун геообъекта. Унаследовано от GeoObject. |
editor | geometryEditor.Polygon | Редактор геометрии "Многоугольник". |
events | event.Manager | Менеджер событий. Унаследовано от GeoObject. |
geometry | geometry.Polygon | Геометрия типа "Многоугольник". |
hint | geoObject.Hint | Хинт геообъекта. Унаследовано от GeoObject. |
options | option.Manager | Менеджер опций геообъекта. Унаследовано от GeoObject. |
properties | data.Manager | Менеджер данных геообъекта. Унаследовано от GeoObject. |
state | data.Manager | Состояние геообъекта. Определяется следующими полями:
Унаследовано от GeoObject. |
События
Имя | Описание |
---|---|
balloonclose | Закрытие балуна. Экземпляр класса Event. Унаследовано от GeoObject. |
balloonopen | Открытие балуна на геообъекте.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
beforedrag | Событие, предшествующее событию drag.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
beforedragstart | Событие, предшествующее событию dragstart.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
click | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
contextmenu | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
dblclick | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
drag | Перетаскивание геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
dragend | Завершение перетаскивания геообъекта. Экземпляр класса Event. Унаследовано от GeoObject. |
dragstart | Начало перетаскивания геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
editorstatechange | Изменение состояния редактора геометрии геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
geometrychange | Изменение геометрии геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
mapchange | Сменилась карта.
Поля данных:
Унаследовано от IParentOnMap. |
mousedown | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
mouseenter | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
mouseleave | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
mousemove | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
mouseup | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
multitouchend | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от IDomEventEmitter. |
multitouchmove | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от IDomEventEmitter. |
multitouchstart | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от IDomEventEmitter. |
optionschange | Изменение в опциях объекта. Унаследовано от ICustomizable. |
overlaychange | Изменение оверлея геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
parentchange | Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
pixelgeometrychange | Изменение пиксельной геометрии геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
propertieschange | Изменение данных геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
wheel | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
Имя | Описание |
---|---|
balloonclose | Закрытие балуна. Экземпляр класса Event. Унаследовано от GeoObject. |
balloonopen | Открытие балуна на геообъекте.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
beforedrag | Событие, предшествующее событию drag.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
beforedragstart | Событие, предшествующее событию dragstart.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
click | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
contextmenu | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
dblclick | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
drag | Перетаскивание геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
dragend | Завершение перетаскивания геообъекта. Экземпляр класса Event. Унаследовано от GeoObject. |
dragstart | Начало перетаскивания геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
editorstatechange | Изменение состояния редактора геометрии геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
geometrychange | Изменение геометрии геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
mapchange | Сменилась карта.
Поля данных:
Унаследовано от IParentOnMap. |
mousedown | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
mouseenter | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
mouseleave | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
mousemove | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
mouseup | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
multitouchend | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от IDomEventEmitter. |
multitouchmove | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от IDomEventEmitter. |
multitouchstart | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от IDomEventEmitter. |
optionschange | Изменение в опциях объекта. Унаследовано от ICustomizable. |
overlaychange | Изменение оверлея геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
parentchange | Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
pixelgeometrychange | Изменение пиксельной геометрии геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
propertieschange | Изменение данных геообъекта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
wheel | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
Методы
Имя | Возвращает | Описание |
---|---|---|
getMap() | Returns ссылку на карту. Унаследован от IParentOnMap. | |
getOverlay() | IOverlay|null | Returns оверлей геообъекта, либо null. Унаследован от IGeoObject. |
getParent() | Returns ссылку на родительский объект. Унаследован от IChildOnMap. | |
setParent(parent) | Устанавливает родительский объект. Унаследован от IChildOnMap. |
Имя | Возвращает | Описание |
---|---|---|
getMap() | Returns ссылку на карту. Унаследован от IParentOnMap. | |
getOverlay() | IOverlay|null | Returns оверлей геообъекта, либо null. Унаследован от IGeoObject. |
getParent() | Returns ссылку на родительский объект. Унаследован от IChildOnMap. | |
setParent(parent) | Устанавливает родительский объект. Унаследован от IChildOnMap. |
Описание полей
editor
{geometryEditor.Polygon} editor
Редактор геометрии "Многоугольник".
geometry
{geometry.Polygon} geometry
Геометрия типа "Многоугольник".