Spec-Zone.ru › OpenLayers

ol/geom/MultiLineString~MultiLineString


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

Геометрия из нескольких линий.

new MultiLineString(coordinates, layout, ends)

geom/MultiLineString.js, line 25
Имя Тип Описание
coordinates Array.<(Array.<module:ol/coordinate~Coordinate>|module:ol/geom/LineString~LineString)> | Array.<number>

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

layout GeometryLayout | undefined

Компоновка.

ends Array.<number> | undefined

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

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

Наследует

  • SimpleGeometry

Методы

appendLineString(lineString)

geom/MultiLineString.js, строка 91

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

Имя Тип Описание
lineString LineString

LineString.

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

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

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

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

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

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

Observable.js, строка 68

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

clone(){MultiLineString}

geom/MultiLineString.js, строка 103

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

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

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

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

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

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

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

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

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

Object.js, строка 136

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

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

Имя ключа.

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

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

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

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

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

Точка.

closestPoint Coordinate | undefined

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

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

getCoordinateAtM(m, extrapolate, interpolate){Coordinate | null}

geom/MultiLineString.js, строка 173

Возвращает координату для m с помощью линейной интерполяции или null, если такой координаты нет.

Параметр extrapolate управляет экстраполяцией за пределами диапазона M в MultiLineString. Если extrapolate имеет значение true, то для M меньше первого M возвращается первая координата, а для M больше последнего M — последняя координата.

Параметр interpolate управляет интерполяцией между последовательными LineString в MultiLineString. Если interpolate имеет значение true, координаты линейно интерполируются между последней координатой одной LineString и первой координатой следующей LineString. Если interpolate имеет значение false, функция возвращает null для значений M между LineString.

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

M.

extrapolate boolean | undefined

Экстраполяция. По умолчанию — false.

interpolate boolean | undefined

Интерполяция. По умолчанию — false.

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

getCoordinates(){Array<Array<Coordinate>>}

geom/MultiLineString.js, строка 199

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

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

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 геометрии.

Возвращает:
Компоновка.

getLength(){number}

geom/MultiLineString.js, строка 263

Возвращает сумму длин всех линейных строк

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

getLineString(index){LineString}

geom/MultiLineString.js, строка 221

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

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

Индекс.

Возвращает:
LineString.

getLineStrings(){Array<LineString>}

geom/MultiLineString.js, строка 239

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

Возвращает:
Линейные строки.

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

Object.js, строка 158

Возвращает объект со всеми именами и значениями свойств.

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

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

Observable.js, строка 79

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

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

getType(){Type}

geom/MultiLineString.js, строка 334

Возвращает тип этой геометрии.

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

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

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

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

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

Координата.

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

intersectsExtent(extent){boolean}

geom/MultiLineString.js, строка 345

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

Имя Тип Описание
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/MultiLineString.js, строка 362

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

Имя Тип Описание
coordinates Array<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_MultiLineString-MultiLineString.html

Spec-Zone.ru

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