ol/geom/MultiPolygon~Многоугольник
import MultiPolygon from 'ol/geom/MultiPolygon.js';
Геометрия множества многоугольников.
-
новый Многоугольник(координаты, формат, концы)
-
Имя Тип Описание coordinatesМассив.<(Массив.<Массив.<модуль:ol/coordinate~Координата>>|модуль:ol/geom/Polygon~Многоугольник)> | Массив.<число> Координаты. Для внутреннего использования также принимаются плоские координаты в сочетании с
layoutиendss.layoutФорматГеометрии | undefined Формат.
endssМассив.<Массив.<число>> | undefined Массив концов для внутреннего использования с плоскими координатами.
События:
-
change(BaseEvent) - Общее событие изменения. Срабатывает при увеличении счётчика ревизии. -
error(BaseEvent) - Общее событие ошибки. Срабатывает при возникновении ошибки. -
propertychange(ObjectEvent) - Срабатывает при изменении свойства.
-
Расширяет
Методы
-
appendPolygon(polygon)
-
Добавить переданный многоугольник в этот многоугольник.
Имя Тип Описание polygonМногоугольник Многоугольник.
-
applyTransform(transformFn) унаследованный
-
Применить функцию преобразования к координатам геометрии. Геометрия изменяется на месте. Если вы не хотите изменять геометрию на месте, сначала скопируйте её, а затем используйте эту функцию на копии.
Имя Тип Описание transformFnФункция преобразования Функция преобразования. Вызывается с плоским массивом координат геометрии.
-
changed() унаследованный
-
Увеличивает счётчик ревизий и отправляет событие 'изменение'.
-
clone(){Многоугольник}
-
Создаёт полную копию геометрии.
Возвращает:
Клонированный объект.
-
dispatchEvent(event){boolean | undefined} унаследованный
-
Отправляет событие и вызывает всех слушателей, ожидающих события данного типа. Параметр event может быть строкой или объектом с свойством
type.Имя Тип Описание eventБазовое событие | строка Объект события.
Возвращает:
`true`, если кто-то вызвал `preventDefault` на объекте события или если какой-либо из слушателей вернул `false`.
-
get(key){*} унаследованный
-
Получение значения.
Имя Тип Описание keyстрока Имя ключа.
Возвращает:
Значение.
-
getArea(){число}
-
Возвращает площадь многоугольника на проекционной плоскости.
Возвращает:
Площадь (на проекционной плоскости).
-
getClosestPoint(point, closestPoint){Координата} унаследованный
-
Возвращает ближайшую точку геометрии к переданной точке в виде
coordinate.Имя Тип Описание pointКоордината Точка.
closestPointКоордината | undefined Ближайшая точка.
Возвращает:
Ближайшая точка.
-
getCoordinates(right){Array<Array<Array<Координата>>>}
-
Получить массив координат для этой геометрии. Этот массив имеет структуру массива координат GeoJSON для многоугольников.
Имя Тип Описание rightboolean | undefined Ориентировать координаты по правилу правой руки (против часовой стрелки для внешних и по часовой стрелке для внутренних колец). Если `
false`, координаты будут ориентированы по правилу левой руки (по часовой стрелке для внешних и против часовой стрелки для внутренних колец). По умолчанию ориентация координат зависит от того, как была построена геометрия.Возвращает:
Координаты.
-
getExtent(extent){Область} унаследованный
-
Получить область геометрии.
Имя Тип Описание extentОбласть | undefined Область.
Возвращает:
Область.
-
getFirstCoordinate(){Координата} унаследованный
-
Возвращает первую координату геометрии.
Возвращает:
Первая координата.
-
getInteriorPoints(){Многоточек}
-
Возвращает внутренние точки в виде
multipoint.Возвращает:
Внутренние точки в координатах XYM, где M — длина горизонтального пересечения, к которому принадлежит точка.
-
getKeys(){Array.<string>} inherited
-
Получить список имён свойств объекта.
Возвращает:
Список имён свойств.
-
getLastCoordinate(){Координата} inherited
-
Возвращает последнюю координату геометрии.
Возвращает:
Последняя точка.
-
getLayout(){Формат геометрии} inherited
-
Возвращает
layoutгеометрии.Возвращает:
Формат.
-
getPolygon(index){Многоугольник}
-
Возвращает многоугольник по указанному индексу.
Имя Тип Описание indexчисло Индекс.
Возвращает:
Многоугольник.
-
getPolygons(){Array<Многоугольник>}
-
Возвращает многоугольники этого многоугольника.
Возвращает:
Многоугольники.
-
getProperties(){Object.<string, *>} inherited
-
Получить объект всех имён свойств и значений.
Возвращает:
Объект.
-
getRevision(){number} inherited
-
Получить номер версии этого объекта. Каждый раз, когда объект изменяется, его номер версии увеличивается.
Возвращает:
Номер ревизии.
-
getType(){Тип}
-
Получить тип этой геометрии.
Возвращает:
Тип геометрии.
-
intersectsCoordinate(coordinate){boolean} inherited
-
Возвращает true, если эта геометрия включает указанную координату. Если координата находится на границе геометрии, возвращает false.
Имя Тип Описание coordinateКоордината Координата.
Возвращает:
Содержит ли координату.
-
intersectsExtent(extent){boolean}
-
Проверка, пересекается ли геометрия и переданный прямоугольник.
Имя Тип Описание extentПрямоугольник Прямоугольник.
Возвращает:
true, если геометрия и прямоугольник пересекаются.
-
on(type, listener){Ключ события | Array<Ключ события>} inherited
-
Прослушивание событий определённого типа.
Имя Тип Описание typeстрока | Array.<строка> Тип события или массив типов событий.
listenerфункция Функция обработчика.
Возвращает:
Уникальный ключ обработчика. Если вызван с массивом типов событий в качестве первого аргумента, возвращаемое значение будет массивом ключей.
-
once(type, listener){Ключ события | Array<Ключ события>} inherited
-
Прослушивание события определённого типа один раз.
Имя Тип Описание typeстрока | Array.<строка> Тип события или массив типов событий.
listenerфункция Функция обработчика.
Возвращает:
Уникальный ключ обработчика. Если вызван с массивом типов событий в качестве первого аргумента, возвращаемое значение будет массивом ключей.
-
rotate(angle, anchor) inherited
-
Повернуть геометрию вокруг заданной координаты. Это изменяет координаты геометрии на месте.
Имя Тип Описание angleчисло Угол поворота против часовой стрелки в радианах.
anchorКоордината Центр поворота.
-
scale(sx, sy, anchor) inherited
-
Масштабировать геометрию (с необязательной точкой отсчёта). Это изменяет координаты геометрии на месте.
Имя Тип Описание sxчисло Коэффициент масштабирования по оси X.
syчисло | undefined Коэффициент масштабирования по оси Y (по умолчанию равен sx).
anchorКоордината | undefined Начальная точка масштабирования (по умолчанию — центр области геометрии).
-
set(key, value, silent) inherited
-
Устанавливает значение.
Имя Тип Описание keyстрока Имя ключа.
value* Значение.
silentлогическое | undefined Обновить без срабатывания события.
-
setCoordinates(coordinates, layout)
-
Установить координаты многоугольника.
Имя Тип Описание coordinatesМассив<Массив<Массив<Координата>>> Координаты.
layoutМакет геометрии | undefined Макет.
-
setProperties(values, silent) inherited
-
Устанавливает коллекцию пар ключ-значение. Обратите внимание, что это изменяет все существующие свойства и добавляет новые (не удаляет существующие свойства).
Имя Тип Описание valuesОбъект.<строка, *> Значения.
silentлогическое | undefined Обновить без срабатывания события.
-
Создаёт упрощенную версию этой геометрии. Для линий используется алгоритм Douglas Peucker. Для полигонов используется упрощение на основе квантования для сохранения топологии.
Имя Тип Описание toleranceчисло Допустимая погрешность для упрощения.
Возвращает:
Новая упрощенная версия исходной геометрии.
-
transform(source, destination){this} inherited
-
Преобразовать каждую координату геометрии из одной системы координат в другую. Геометрия изменяется на месте. Например, линия преобразуется в линию, а окружность в окружность. Если вы не хотите изменять геометрию на месте, сначала скопируйте её, а затем используйте эту функцию на копии.
Имя Тип Описание sourceПроекция Текущая проекция. Может быть строковым идентификатором или объектом
Projection.destinationПроекция Желаемая проекция. Может быть строковым идентификатором или объектом
Projection.Возвращает:
Геометрию. Обратите внимание, что исходная геометрия изменяется на месте.
-
translate(deltaX, deltaY) inherited
-
Переместить геометрию. Это изменяет координаты геометрии на месте. Если вы хотите новую геометрию, сначала скопируйте эту геометрию.
Имя Тип Описание deltaXчисло Delta X.
deltaYчисло Delta Y.
-
un(type, listener) inherited
-
Отменить подписку на определённый тип события.
Имя Тип Описание typeстрока | Массив.<строка> Тип события или массив типов событий.
listenerфункция Функция-обработчик.
-
unset(ключ, беззвучно) унаследованный
-
Удалить свойство.
Имя Тип Описание 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