ol/geom/Polygon~Многоугольник

Наследует от

• ПростаяГеометрия

Методы

appendLinearRing(linearRing)

geom/Polygon.js, line 105

Добавить переданное линейное кольцо к этому многоугольнику.

Имя	Тип	Описание
linearRing	ЛинейноеКольцо	Линейное кольцо.

applyTransform(transformFn) унаследованно

geom/SimpleGeometry.js, строка 208

Применить функцию преобразования к координатам геометрии. Геометрия изменяется на месте. Если вы не хотите изменять геометрию на месте, сначала clone() её, а затем используйте эту функцию на клоне.

Имя	Тип	Описание
transformFn	ФункцияПреобразования	Функция преобразования. Вызывается с плоским массивом координат геометрии.

changed() унаследованно

Observable.js, строка 68

Увеличивает счетчик ревизий и отправляет событие 'change'.

clone(){Многоугольник}

geom/Polygon.js, строка 121

Создает полную копию геометрии.

Возвращает:

Клон.

dispatchEvent(event){boolean | undefined} унаследованно

events/Target.js, строка 85

Отправляет событие и вызывает всех слушателей, ожидающих события этого типа. Параметр event может быть либо строкой, либо объектом с свойством type.

Имя	Тип	Описание
event	БазовоеСобытие | строка	Объект события.

Возвращает:

false, если кто-то вызвал preventDefault в объекте события или если какой-либо из слушателей вернул false.

get(key){*} унаследованно

Object.js, строка 135

Получает значение.

Имя	Тип	Описание
key	строка	Имя ключа.

Возвращает:

Значение.

getArea(){число}

geom/Polygon.js, строка 191

Возвращает площадь многоугольника на проекционной плоскости.

Возвращает:

Площадь (на проекционной плоскости).

getClosestPoint(point, closestPoint){Координата} унаследованно

geom/Geometry.js, строка 154

Возвращает ближайшую точку геометрии к переданной точке как coordinate.

Имя	Тип	Описание
point	Координата	Точка.
closestPoint	Координата | undefined	Ближайшая точка.

Возвращает:

Ближайшая точка.

getCoordinates(right){Массив<Массив<Координата>>}

geom/Polygon.js, строка 214

Получить массив координат для этой геометрии. Этот массив имеет структуру массива координат GeoJSON для многоугольников.

Имя	Тип	Описание
right	логический | undefined	Ориентировать координаты в соответствии с правилом правой руки (против часовой стрелки для внешних и по часовой стрелке для внутренних колец). Если false, координаты будут ориентированы в соответствии с правилом левой руки (по часовой стрелке для внешних и против часовой стрелки для внутренних колец). По умолчанию ориентация координат зависит от того, как была построена геометрия.

Возвращает:

Координаты.

getExtent(extent){Охватывает} унаследованно

geom/Geometry.js, строка 187

Получить область геометрии.

Имя	Тип	Описание
extent	Охватывает | undefined	Область.

Возвращает:

Охватывает Область.

getFirstCoordinate(){Координата} унаследованно

geom/SimpleGeometry.js, строка 69

Возвращает первую координату геометрии.

Возвращает:

Первая координата.

getInteriorPoint(){Точка}

geom/Polygon.js, строка 260

Возвращает внутреннюю точку многоугольника.

Возвращает:

Внутренняя точка как координата XYM, где M — длина горизонтального пересечения, к которому принадлежит точка.

getKeys(){Array.<string>} inherited

Object.js, line 148

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

Возвращает:

Список имён свойств.

getLastCoordinate(){Координата} inherited

geom/SimpleGeometry.js, line 85

Возвратить последнюю координату геометрии.

Возвращает:

Последняя точка.

getLayout(){Тип геометрии} inherited

geom/SimpleGeometry.js, line 96

Возвратить layout геометрии.

Возвращает:

Тип.

getLinearRing(index){Линейный контур | null}

geom/Polygon.js, line 285

Возвратить N-й линейный контур многоугольной геометрии. Возвращает null, если переданный индекс находится за пределами допустимого диапазона. Внешний линейный контур доступен по индексу 0, а внутренние контуры — по индексу 1 и далее.

Имя	Тип	Описание
index	число	Индекс.

Возвращает:

Линейный контур.

getLinearRingCount(){число}

geom/Polygon.js, line 271

Возвратить количество контуров многоугольника, включая внешний и внутренние.

Возвращает:

Количество контуров.

getLinearRings(){Array<Линейный контур>}

geom/Polygon.js, line 303

Возвратить линейные контуры многоугольника.

Возвращает:

Линейные контуры.

getProperties(){Object.<string, *>} inherited

Object.js, line 157

Получить объект со всеми именами свойств и их значениями.

Возвращает:

Объект.

getRevision(){число} inherited

Observable.js, line 79

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

Возвращает:

Версия.

getType(){Тип}

geom/Polygon.js, line 373

Получить тип этой геометрии.

Возвращает:

Тип геометрии.

intersectsCoordinate(координата){логическое} inherited

geom/Geometry.js, line 167

Возвращает true, если эта геометрия содержит указанную координату. Если координата находится на границе геометрии, возвращает false.

Имя	Тип	Описание
coordinate	Координата	Координата.

Возвращает:

Содержит координату.

intersectsExtent(охватывающая область){логическое}

geom/Polygon.js, line 384

Проверить пересечение геометрии и переданной охватывающей области.

Имя	Тип	Описание
extent	Охватывающая область	Охватывающая область.

Возвращает:

true, если геометрия и охватывающая область пересекаются.

on(тип, обработчик){Ключ события | Array<Ключ события>} inherited

Observable.js, line 152

Прислушаться к определённому типу события.

Имя	Тип	Описание
type	строка | Массив<строка>	Тип события или массив типов событий.
listener	функция	Функция-обработчик.

Возвращает:

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

once(тип, обработчик){Ключ события | Array<Ключ события>} inherited

Observable.js, line 164

Прослушивание определённого типа события один раз.

Имя	Тип	Описание
type	string | Array.<string>	Тип события или массив типов событий.
listener	function	Функция-слушатель.

Возвращаемое значение:

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

rotate(angle, anchor) унаследованное

geom/SimpleGeometry.js, строка 228

Поворот геометрии вокруг заданной координаты. Это изменяет координаты геометрии на месте.

Имя	Тип	Описание
angle	number	Угол поворота против часовой стрелки в радианах.
anchor	Координата	Центр поворота.

scale(sx, sy, anchor) унаследованное

geom/SimpleGeometry.js, строка 255

Масштабирование геометрии (с необязательной точкой начала). Это изменяет координаты геометрии на месте.

Имя	Тип	Описание
sx	number	Коэффициент масштабирования по оси X.
sy	number | undefined	Коэффициент масштабирования по оси Y (по умолчанию равен sx).
anchor	Координата | undefined	Точка начала масштабирования (по умолчанию - центр области геометрии).

set(key, value, silent) унаследованное

Object.js, строка 215

Устанавливает значение.

Имя	Тип	Описание
key	string	Имя ключа.
value	*	Значение.
silent	boolean | undefined	Обновление без срабатывания события.

setCoordinates(coordinates, layout)

geom/Polygon.js, строка 401

Устанавливает координаты многоугольника.

Имя	Тип	Описание
coordinates	Array<Array<Координата>>	Координаты.
layout	Макет геометрии | undefined	Макет.

setProperties(values, silent) унаследованное

Object.js, строка 235

Устанавливает набор пар "ключ-значение". Обратите внимание, что это изменяет все существующие свойства и добавляет новые (не удаляет какие-либо существующие свойства).

Имя	Тип	Описание
values	Object.<string, *>	Значения.
silent	boolean | undefined	Обновление без срабатывания события.

simplify(tolerance){Геометрия} унаследованное

geom/Geometry.js, строка 233

Создаёт упрощённую версию этой геометрии. Для линий используется алгоритм Даугаса-Пекера. Для полигонов используется упрощение на основе квантования для сохранения топологии.

Имя	Тип	Описание
tolerance	number	Расстояние допуска для упрощения.

Возвращаемое значение:

Новая, упрощённая версия исходной геометрии.

transform(source, destination){this} унаследованное

geom/Geometry.js, строка 308

Преобразовать каждую координату геометрии из одной системы координат в другую. Геометрия изменяется на месте. Например, линия будет преобразована в линию, а круг в круг. Если вы не хотите изменять геометрию на месте, сначала скопируйте её, а затем используйте эту функцию для копии.

Имя	Тип	Описание
source	Тип проекции	Текущая проекция. Может быть строковым идентификатором или объектом Projection.
destination	Тип проекции	Желаемая проекция. Может быть строковым идентификатором или объектом Projection.

Возвращаемое значение:

Эта геометрия. Обратите внимание, что исходная геометрия изменяется на месте.

translate(deltaX, deltaY) унаследованное

geom/SimpleGeometry.js, строка 287

Переведите геометрию. Это изменяет координаты геометрии на месте. Если вы хотите новую геометрию, сначала clone() эту геометрию.

Имя	Тип	Описание
deltaX	число	Дельта X.
deltaY	число	Дельта Y.

un(тип, слушатель) унаследованный

Observable.js, строка 173

Отменить прослушивание определенного типа события.

Имя	Тип	Описание
type	строка | Массив.<строка>	Тип события или массив типов событий.
listener	функция	Функция-слушатель.

unset(ключ, без звука) унаследованный

Object.js, строка 259

Сбрасывает свойство.

Имя	Тип	Описание
key	строка	Имя ключа.
silent	логическое | undefined	Сбросить без запуска события.