Spec-Zone.ru › OpenLayers

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


import MultiPolygon from 'ol/geom/MultiPolygon.js';

Геометрия множества многоугольников.

новый Многоугольник(координаты, формат, концы)

geom/MultiPolygon.js, строка 32
Имя Тип Описание
coordinates Массив.<(Массив.<Массив.<модуль:ol/coordinate~Координата>>|модуль:ol/geom/Polygon~Многоугольник)> | Массив.<число>

Координаты. Для внутреннего использования также принимаются плоские координаты в сочетании с layout и endss.

layout ФорматГеометрии | undefined

Формат.

endss Массив.<Массив.<число>> | undefined

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

События:
  • change (BaseEvent) - Общее событие изменения. Срабатывает при увеличении счётчика ревизии.
  • error (BaseEvent) - Общее событие ошибки. Срабатывает при возникновении ошибки.
  • propertychange (ObjectEvent) - Срабатывает при изменении свойства.

Расширяет

  • SimpleGeometry

Методы

appendPolygon(polygon)

geom/MultiPolygon.js, line 125

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

Имя Тип Описание
polygon Многоугольник

Многоугольник.

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

geom/SimpleGeometry.js, line 208

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

Имя Тип Описание
transformFn Функция преобразования

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

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

Observable.js, line 68

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

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

geom/MultiPolygon.js, line 150

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

Возвращает:
Клонированный объект.

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

events/Target.js, line 85

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

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

Объект события.

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

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

Object.js, line 135

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

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

Имя ключа.

Возвращает:
Значение.

getArea(){число}

geom/MultiPolygon.js, line 227

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

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

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

geom/Geometry.js, line 154

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

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

Точка.

closestPoint Координата | undefined

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

Возвращает:
Ближайшая точка.

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

geom/MultiPolygon.js, line 250

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

Имя Тип Описание
right boolean | undefined

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

Возвращает:
Координаты.

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

geom/Geometry.js, line 187

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

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

Область.

Возвращает:
Область.

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

geom/SimpleGeometry.js, line 69

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

Возвращает:
Первая координата.

getInteriorPoints(){Многоточек}

geom/MultiPolygon.js, line 309

Возвращает внутренние точки в виде multipoint.

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

getKeys(){Array.<string>} inherited

Object.js, строка 148

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

Возвращает:
Список имён свойств.

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

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

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

Возвращает:
Последняя точка.

getLayout(){Формат геометрии} inherited

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

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

Возвращает:
Формат.

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

geom/MultiPolygon.js, строка 367

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

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

Индекс.

Возвращает:
Многоугольник.

getPolygons(){Array<Многоугольник>}

geom/MultiPolygon.js, строка 397

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

Возвращает:
Многоугольники.

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

Object.js, строка 157

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

Возвращает:
Объект.

getRevision(){number} inherited

Observable.js, строка 79

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

Возвращает:
Номер ревизии.

getType(){Тип}

geom/MultiPolygon.js, строка 428

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

Возвращает:
Тип геометрии.

intersectsCoordinate(coordinate){boolean} inherited

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

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

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

Координата.

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

intersectsExtent(extent){boolean}

geom/MultiPolygon.js, строка 439

Проверка, пересекается ли геометрия и переданный прямоугольник.

Имя Тип Описание
extent Прямоугольник

Прямоугольник.

Возвращает:
true, если геометрия и прямоугольник пересекаются.

on(type, listener){Ключ события | Array<Ключ события>} inherited

Observable.js, строка 152

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

Имя Тип Описание
type строка | Array.<строка>

Тип события или массив типов событий.

listener функция

Функция обработчика.

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

once(type, listener){Ключ события | Array<Ключ события>} inherited

Observable.js, строка 164

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

Имя Тип Описание
type строка | Array.<строка>

Тип события или массив типов событий.

listener функция

Функция обработчика.

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

rotate(angle, anchor) inherited

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

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

Имя Тип Описание
angle число

Угол поворота против часовой стрелки в радианах.

anchor Координата

Центр поворота.

scale(sx, sy, anchor) inherited

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

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

Имя Тип Описание
sx число

Коэффициент масштабирования по оси X.

sy число | undefined

Коэффициент масштабирования по оси Y (по умолчанию равен sx).

anchor Координата | undefined

Начальная точка масштабирования (по умолчанию — центр области геометрии).

set(key, value, silent) inherited

Object.js, строка 215

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

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

Имя ключа.

value *

Значение.

silent логическое | undefined

Обновить без срабатывания события.

setCoordinates(coordinates, layout)

geom/MultiPolygon.js, строка 456

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

Имя Тип Описание
coordinates Массив<Массив<Массив<Координата>>>

Координаты.

layout Макет геометрии | undefined

Макет.

setProperties(values, silent) inherited

Object.js, строка 235

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

Имя Тип Описание
values Объект.<строка, *>

Значения.

silent логическое | undefined

Обновить без срабатывания события.

simplify(tolerance){Геометрия} inherited

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

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

Имя Тип Описание
tolerance число

Допустимая погрешность для упрощения.

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

transform(source, destination){this} inherited

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

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

Имя Тип Описание
source Проекция

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

destination Проекция

Желаемая проекция. Может быть строковым идентификатором или объектом Projection.

Возвращает:
Геометрию. Обратите внимание, что исходная геометрия изменяется на месте.

translate(deltaX, deltaY) inherited

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

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

Имя Тип Описание
deltaX число

Delta X.

deltaY число

Delta Y.

un(type, listener) inherited

Observable.js, строка 173

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

Имя Тип Описание
type строка | Массив.<строка>

Тип события или массив типов событий.

listener функция

Функция-обработчик.

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

Object.js, строка 259

Удалить свойство.

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

Имя ключа.

silent логическое | undefined

Удалить без срабатывания события.

© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_geom_MultiPolygon-MultiPolygon.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API