geometry.Polygon
Расширяет IPolygonGeometry.
Геометрия "Многоугольник".
См.: Polygon
Конструктор | Поля | События | Методы
Конструктор
geometry.Polygon([coordinates[, fillRule[, options]]])
Параметры:
Параметр |
Значение по умолчанию |
Описание |
[] |
Тип: Number[][][] Координаты геометрии. Трехмерный массив, элементами которого являются двумерные массивы координат контуров многоугольника. Первый элемент описывает внешний контур, остальные - внутренние. |
|
"evenOdd" |
Тип: String Строковый идентификатор, определяющий алгоритм заливки многоугольника. Может принимать одно из двух значений:
|
|
— |
Тип: Object Опции геометрии. |
|
"shortestPath" |
Тип: String Строковый идентификатор, определяющий алгоритм пересчета координат геометрии в пиксельные координаты. Может принимать одно из двух значений:
|
|
false |
Тип: Boolean Включает отображение с использованием геодезических линий. |
|
"jumpy" |
Тип: String Метод расчета пиксельных координат отображения в зацикленных проекциях. Опция может принимать одно из следующих значений:
|
|
— |
Тип: IProjection Проекция. |
|
true |
Тип: Boolean Включает симплификацию при рендеринге пиксельной геометрии. |
Пример:
// Создаем инстанцию геометрии многоугольника (указываем координаты вершин контуров).
var polygonGeometry = new ymaps.geometry.Polygon([
// Внешний контур.
[
[0, 0], [0, 5], [5, 5], [5, 0], [0, 0]
],
// Внутренний контур.
[
[1, 1], [1, 2], [2, 2], [2, 1], [1, 1]
]
]),
// Создаем инстанцию геообъекта и передаем нашу геометрию в конструктор.
polygonGeoObject = new ymaps.GeoObject({ geometry: polygonGeometry });
// Также доступ к polygonGeometry можно получить через polygonGeoObject.geometry.
Поля
Имя |
Тип |
Описание |
Менеджер событий. Унаследовано от IEventEmitter. |
||
Менеджер опций. Унаследовано от ICustomizable. |
События
Имя |
Описание |
Изменение координат. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IPolygonGeometryAccess. |
|
Сменилась карта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IGeometry. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Изменилась пиксельная геометрия. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IGeometry. |
Методы
Имя |
Возвращает |
Описание |
Boolean |
Проверяет, лежит ли переданная точка внутри многоугольника. Унаследован от IPolygonGeometryAccess. |
|
freeze() |
Переводит объект в "замороженный" режим. Унаследован от IFreezable. |
|
Number[][] |
Возвращает координаты контура c заданным индексом. Унаследован от IPolygonGeometryAccess. |
|
Number[][]|null |
Возвращает координаты двух противоположных углов области, охватывающей геометрию. Первый элемент массива - юго-западный угол области; второй элемент - северо-восточный угол соответственно. Унаследован от IGeometry. |
|
Создает и возвращает объект ILinearRingGeometryAccess для заданного контура. Унаследован от IPolygonGeometryAccess. |
||
Object |
Ищет на контуре многоугольника точку, ближайшую к anchorPosition. Унаследован от IPolygonGeometryAccess. |
|
Number[][][] |
Возвращает массив координат геометрии. Унаследован от IPolygonGeometryAccess. |
|
String |
Возвращает идентификатор алгоритма заливки. Унаследован от IPolygonGeometryAccess. |
|
Integer |
Возвращает количество контуров в геометрии. Унаследован от IPolygonGeometryAccess. |
|
getMap() |
Map|null |
Возвращает текущую карту. Унаследован от IGeometry. |
Возвращает пиксельную геометрию, соответствующую данной геометрии, ее опциям и состоянию карты. Унаследован от IGeometry. |
||
getType() |
String |
Возвращает строку "Polygon". Унаследован от IPolygonGeometry. |
Добавляет новый контур с заданным индексом. Унаследован от IPolygonGeometryAccess. |
||
isFrozen() |
Boolean |
Возвращает true, если объект находится в "замороженном" режиме, иначе false. Унаследован от IFreezable. |
Удаляет контур с заданным индексом. Унаследован от IPolygonGeometryAccess. |
||
Задает координаты контура c заданным индексом. Унаследован от IPolygonGeometryAccess. |
||
Задает массив координат геометрии. Унаследован от IPolygonGeometryAccess. |
||
Задает алгоритм заливки многоугольника. Унаследован от IPolygonGeometryAccess. |
||
Задает карту. Унаследован от IGeometry. |
||
Удаляет определенное число контуров начиная с заданного индекса. При этом на место удаляемых контуров могут быть добавлены новые. Координаты новых контуров можно передавать дополнительными аргументами после параметра number. Унаследован от IPolygonGeometryAccess. |
||
unfreeze() |
Переводит объект в активный режим. Унаследован от IFreezable. |