ol/geom/MultiLineString~MultiLineString
import MultiLineString from 'ol/geom/MultiLineString.js';
Геометрия из нескольких линий.
-
new MultiLineString(coordinates, layout, ends)
-
Имя Тип Описание coordinatesArray.<(Array.<module:ol/coordinate~Coordinate>|module:ol/geom/LineString~LineString)> | Array.<number> Координаты или геометрии LineString. (Для внутреннего использования также допускаются плоские координаты в сочетании с
layoutиends.)layoutGeometryLayout | undefined Компоновка.
endsArray.<number> | undefined Концы плоских координат для внутреннего использования.
События:
-
change(BaseEvent) - Общее событие изменения. Вызывается при увеличении счётчика ревизий. -
error(BaseEvent) - Общее событие ошибки. Вызывается при возникновении ошибки. -
propertychange(ObjectEvent) - Вызывается при изменении свойства.
-
Наследует
Методы
-
appendLineString(lineString)
-
Добавляет переданную строку в мультилинейную геометрию.
Имя Тип Описание lineStringLineString LineString.
-
applyTransform(transformFn) унаследовано
-
Применяет функцию преобразования к координатам геометрии. Геометрия изменяется на месте. Если вы не хотите изменять геометрию на месте, сначала создайте её копию с помощью
clone(), а затем вызовите эту функцию для копии.Имя Тип Описание transformFnTransformFunction Функция преобразования. Вызывается с плоским массивом координат геометрии.
-
changed() унаследовано
-
Увеличивает счётчик версий и отправляет событие «change».
-
clone(){MultiLineString}
-
Создаёт полную копию геометрии.
Возвращает:
Копия.
-
dispatchEvent(event){boolean | undefined} унаследовано
-
Отправляет событие и вызывает все обработчики, ожидающие события этого типа. Параметр event может быть строкой или объектом со свойством
type.Имя Тип Описание eventBaseEvent | string Объект события.
Возвращает:
false, если кто-либо вызвал preventDefault для объекта события или если какой-либо из обработчиков вернул false.
-
get(key){*} унаследовано
-
Получает значение.
Имя Тип Описание keystring Имя ключа.
Возвращает:
Значение.
-
getClosestPoint(point, closestPoint){Coordinate} унаследовано
-
Возвращает ближайшую к переданной точке точку геометрии в виде
coordinate.Имя Тип Описание pointCoordinate Точка.
closestPointCoordinate | undefined Ближайшая точка.
Возвращает:
Ближайшая точка.
-
getCoordinateAtM(m, extrapolate, interpolate){Coordinate | null}
-
Возвращает координату для
mс помощью линейной интерполяции илиnull, если такой координаты нет.Параметр
extrapolateуправляет экстраполяцией за пределами диапазона M в MultiLineString. Еслиextrapolateимеет значениеtrue, то для M меньше первого M возвращается первая координата, а для M больше последнего M — последняя координата.Параметр
interpolateуправляет интерполяцией между последовательными LineString в MultiLineString. Еслиinterpolateимеет значениеtrue, координаты линейно интерполируются между последней координатой одной LineString и первой координатой следующей LineString. Еслиinterpolateимеет значениеfalse, функция возвращаетnullдля значений M между LineString.Имя Тип Описание mnumber M.
extrapolateboolean | undefined Экстраполяция. По умолчанию —
false.interpolateboolean | undefined Интерполяция. По умолчанию —
false.Возвращает:
Координата.
-
getCoordinates(){Array<Array<Coordinate>>}
-
Возвращает координаты мультилинейной геометрии.
Возвращает:
Координаты.
-
getExtent(extent){Extent} унаследовано
-
Возвращает охват геометрии.
Имя Тип Описание extentExtent | undefined Охват.
Возвращает:
extent — охват.
-
getFirstCoordinate(){Coordinate} унаследовано
-
Возвращает первую координату геометрии.
Возвращает:
Первая координата.
-
getKeys(){Array.<string>} унаследовано
-
Возвращает список имён свойств объекта.
Возвращает:
Список имён свойств.
-
getLastCoordinate(){Coordinate} унаследовано
-
Возвращает последнюю координату геометрии.
Возвращает:
Последняя точка.
-
getLayout(){GeometryLayout} унаследовано
-
Возвращает
layoutгеометрии.Возвращает:
Компоновка.
-
getLength(){number}
-
Возвращает сумму длин всех линейных строк
Возвращает:
Длина (в проецированной плоскости).
-
getLineString(index){LineString}
-
Возвращает линейную строку с указанным индексом.
Имя Тип Описание indexnumber Индекс.
Возвращает:
LineString.
-
getLineStrings(){Array<LineString>}
-
Возвращает линейные строки этой мультилинейной геометрии.
Возвращает:
Линейные строки.
-
getProperties(){NoInfer.<Properties>} унаследовано
-
Возвращает объект со всеми именами и значениями свойств.
Возвращает:
Объект.
-
getRevision(){number} унаследовано
-
Возвращает номер версии этого объекта. При каждом изменении объекта номер его версии увеличивается.
Возвращает:
Номер версии.
-
getType(){Type}
-
Возвращает тип этой геометрии.
Возвращает:
Тип геометрии.
-
intersectsCoordinate(coordinate){boolean} унаследовано
-
Возвращает true, если геометрия содержит указанную координату. Если координата находится на границе геометрии, возвращает false.
Имя Тип Описание coordinateCoordinate Координата.
Возвращает:
Содержит ли геометрия координату.
-
intersectsExtent(extent){boolean}
-
Проверяет, пересекаются ли геометрия и переданный охват.
Имя Тип Описание extentExtent Охват.
Возвращает:
true, если геометрия и охват пересекаются.
-
on(type, listener){EventsKey | Array<EventsKey>} унаследовано
-
Ожидает событие указанного типа.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
Возвращает:
Уникальный ключ обработчика. Если в качестве первого аргумента передан массив типов событий, возвращается массив ключей.
-
once(type, listener){EventsKey | Array<EventsKey>} унаследовано
-
Однократно ожидает событие указанного типа.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
Возвращает:
Уникальный ключ обработчика. Если в качестве первого аргумента передан массив типов событий, возвращается массив ключей.
-
rotate(angle, anchor) унаследовано
-
Поворачивает геометрию вокруг заданной координаты. Координаты геометрии изменяются на месте.
Имя Тип Описание anglenumber Угол поворота в радианах против часовой стрелки.
anchorCoordinate Центр поворота.
-
scale(sx, sy, anchor) унаследовано
-
Изменяет масштаб геометрии (с необязательной точкой начала координат). Координаты геометрии изменяются на месте.
Имя Тип Описание sxnumber Коэффициент масштабирования по оси x.
synumber | undefined Коэффициент масштабирования по оси y (по умолчанию равен sx).
anchorCoordinate | undefined Точка начала масштабирования (по умолчанию — центр охвата геометрии).
-
set(key, value, silent) унаследовано
-
Задаёт значение.
Имя Тип Описание keystring Имя ключа.
value* Значение.
silentboolean | undefined Обновить без вызова события.
-
setCoordinates(coordinates, layout)
-
Задаёт координаты мультилинейной геометрии.
Имя Тип Описание coordinatesArray<Array<Coordinate>> Координаты.
layoutGeometryLayout | undefined Компоновка.
-
setProperties(values, silent) унаследовано
-
Задаёт набор пар «ключ — значение». Обратите внимание: существующие свойства при этом изменяются, а новые добавляются (существующие свойства не удаляются).
Имя Тип Описание valuesPartial.<NoInfer.<Properties>> Значения.
silentboolean | undefined Обновить без вызова события.
-
simplify(tolerance){Geometry} унаследовано
-
Создаёт упрощённую версию этой геометрии. Для строк используются алгоритм Дугласа — Пекера. Для полигонов используется упрощение на основе квантования, сохраняющее топологию.
Имя Тип Описание tolerancenumber Допуск упрощения.
Возвращает:
Новую упрощённую версию исходной геометрии.
-
transform(source, destination){this} унаследовано
-
Преобразует каждую координату геометрии из одной системы координат в другую. Геометрия изменяется на месте. Например, линия будет преобразована в линию, а окружность — в окружность. Если вы не хотите изменять геометрию на месте, сначала создайте её копию с помощью
clone(), а затем вызовите эту функцию для копии.Имя Тип Описание sourceProjectionLike Текущая проекция. Может быть строковым идентификатором или объектом
Projection.destinationProjectionLike Требуемая проекция. Может быть строковым идентификатором или объектом
Projection.Возвращает:
Эту геометрию. Обратите внимание, что исходная геометрия изменяется на месте.
-
translate(deltaX, deltaY) унаследовано
-
Перемещает геометрию. Координаты геометрии изменяются на месте. Если вместо этого вам нужна новая геометрия, сначала создайте копию этой геометрии с помощью
clone().Имя Тип Описание deltaXnumber Смещение по X.
deltaYnumber Смещение по Y.
-
un(type, listener) унаследовано
-
Отменяет прослушивание событий указанного типа.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
-
unset(key, silent) унаследовано
-
Удаляет свойство.
Имя Тип Описание keystring Имя ключа.
silentboolean | 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