Spec-Zone.ru › OpenLayers

ol/geom/LinearRing~LinearRing


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

Геометрия линейного кольца. Используется только как часть полигона; не может отображаться самостоятельно.

new LinearRing(coordinates, layout)

geom/LinearRing.js, line 20
Имя Тип Описание
coordinates Array<Coordinate> | Array.<number>

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

layout GeometryLayout | undefined

Компоновка.

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

Наследует

  • SimpleGeometry

Методы

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

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

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

Имя Тип Описание
transformFn TransformFunction

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

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

Observable.js, строка 68

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

clone(){LinearRing}

geom/LinearRing.js, строка 62

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

Возвращает:
Клон.

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

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

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

Имя Тип Описание
event BaseEvent | string

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

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

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

Object.js, строка 136

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

Имя Тип Описание
key string

Имя ключа.

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

getArea(){number}

geom/LinearRing.js, строка 109

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

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

getClosestPoint(point, closestPoint){Coordinate} унаследовано

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

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

Имя Тип Описание
point Coordinate

Точка.

closestPoint Coordinate | undefined

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

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

getCoordinates(){Array<Coordinate>}

geom/LinearRing.js, строка 124

Возвращает координаты линейного кольца.

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

getExtent(extent){Extent} унаследовано

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

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

Имя Тип Описание
extent Extent | undefined

Область охвата.

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

getFirstCoordinate(){Coordinate} унаследовано

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

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

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

getKeys(){Array.<string>} унаследовано

Object.js, строка 149

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

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

getLastCoordinate(){Coordinate} унаследовано

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

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

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

getLayout(){GeometryLayout} унаследовано

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

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

Возвращает:
Раскладка.

getProperties(){NoInfer.<Properties>} унаследовано

Object.js, строка 158

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

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

getRevision(){number} унаследовано

Observable.js, строка 79

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

Возвращает:
Ревизия.

getType(){Type}

geom/LinearRing.js, строка 160

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

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

intersectsCoordinate(coordinate){boolean} унаследовано

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

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

Имя Тип Описание
coordinate Coordinate

Координата.

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

intersectsExtent(extent){boolean}

geom/LinearRing.js, строка 172

Проверяет, пересекаются ли геометрия и переданная область охвата. При этой проверке линейное кольцо рассматривается как строка линий.

Имя Тип Описание
extent Extent

Область охвата.

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

on(type, listener){EventsKey | Array<EventsKey>} унаследовано

Observable.js, строка 152

Ожидает событие определённого типа.

Имя Тип Описание
type string | Array.<string>

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

listener function

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

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

once(type, listener){EventsKey | Array<EventsKey>} унаследовано

Observable.js, строка 164

Однократно ожидает событие определённого типа.

Имя Тип Описание
type string | Array.<string>

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

listener function

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

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

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

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

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

Имя Тип Описание
angle number

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

anchor Coordinate

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

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

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

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

Имя Тип Описание
sx number

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

sy number | undefined

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

anchor Coordinate | undefined

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

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

Object.js, строка 218

Задаёт значение.

Имя Тип Описание
key string

Имя ключа.

value *

Значение.

silent boolean | undefined

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

setCoordinates(coordinates, layout)

geom/LinearRing.js, строка 189

Задаёт координаты линейного кольца.

Имя Тип Описание
coordinates Array<Coordinate>

Координаты.

layout GeometryLayout | undefined

Раскладка.

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

Object.js, строка 238

Задаёт набор пар «ключ — значение». Обратите внимание: при этом изменяются существующие свойства и добавляются новые (существующие свойства не удаляются).

Имя Тип Описание
values Partial.<NoInfer.<Properties>>

Значения.

silent boolean | undefined

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

simplify(tolerance){Geometry} унаследовано

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

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

Имя Тип Описание
tolerance number

Допустимое расстояние при упрощении.

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

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

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

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

Имя Тип Описание
source ProjectionLike

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

destination ProjectionLike

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

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

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

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

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

Имя Тип Описание
deltaX number

Смещение по X.

deltaY number

Смещение по Y.

un(type, listener) унаследовано

Observable.js, строка 173

Прекращает ожидание события определённого типа.

Имя Тип Описание
type string | Array.<string>

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

listener function

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

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

Object.js, строка 262

Удаляет свойство.

Имя Тип Описание
key string

Имя ключа.

silent boolean | undefined

Удаляет свойство без вызова события.

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

Spec-Zone.ru

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