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