ol/geom/LineString~LineString

Расширяет

• SimpleGeometry

Методы

appendCoordinate(coordinate)

geom/LineString.js, line 75

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

Имя	Тип	Описание
coordinate	Координата	Координата.

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

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

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

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

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

Observable.js, строка 68

Увеличивает счетчик ревизии и отправляет событие 'change'.

clone(){LineString}

geom/LineString.js, строка 86

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

Возвращает:

Клон.

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

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

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

Имя	Тип	Описание
event	Базовое событие | строка	Объект события.

Возвращает:

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

forEachSegment(callback){T | boolean}

geom/LineString.js, строка 144

Итерируется по каждому сегменту, вызывая предоставленную функцию обратного вызова. Если обратный вызов возвращает истинное значение, функция возвращает это значение немедленно. В противном случае функция возвращает false.

Имя	Тип	Описание
callback	функция	Функция, вызываемая для каждого сегмента. Функция получит два аргумента, начальную и конечную координаты сегмента.

Возвращает:

Значение.

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

Object.js, строка 135

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

Имя	Тип	Описание
key	строка	Имя ключа.

Возвращает:

Значение.

getClosestPoint(point, closestPoint){Координата} унаследованно

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

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

Имя	Тип	Описание
point	Координата	Точка.
closestPoint	Координата | undefined	Ближайшая точка.

Возвращает:

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

getCoordinateAt(fraction, dest){Координата}

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

Возвращает координату в заданной доли вдоль линии. fraction — число от 0 до 1, где 0 — начало линии, а 1 — конец.

Имя	Тип	Описание
fraction	число	Доля.
dest	Координата | undefined	Необязательная координата, значения которой будут изменены. Если не указано, будет возвращена новая координата.

Возвращает:

Координата интерполированной точки.

getCoordinateAtM(m, extrapolate){Координата | null}

geom/LineString.js, строка 168

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

extrapolate управляет экстраполяцией за пределы диапазона Ms в MultiLineString. Если extrapolate равно true, то Ms, меньшие первой M, вернут первую координату, а Ms, большие последней M, вернут последнюю координату.

Имя	Тип	Описание
m	число	M.
extrapolate	логическое | undefined	Экстраполировать. По умолчанию false.

Возвращает:

Координата.

getCoordinates(){Array<Coordinate>}

geom/LineString.js, line 189

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

Возвращаемое значение:

Координаты.

getExtent(extent){Extent} inherited

geom/Geometry.js, line 187

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

Имя	Тип	Описание
extent	Extent | undefined	Область.

Возвращаемое значение:

Область Extent.

getFirstCoordinate(){Coordinate} inherited

geom/SimpleGeometry.js, line 69

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

Возвращаемое значение:

Первая координата.

getKeys(){Array.<string>} inherited

Object.js, line 148

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

Возвращаемое значение:

Список имён свойств.

getLastCoordinate(){Coordinate} inherited

geom/SimpleGeometry.js, line 85

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

Возвращаемое значение:

Последняя точка.

getLayout(){GeometryLayout} inherited

geom/SimpleGeometry.js, line 96

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

Возвращаемое значение:

Разметка.

getLength(){number}

geom/LineString.js, line 225

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

Возвращаемое значение:

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

getProperties(){Object.<string, *>} inherited

Object.js, line 157

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

Возвращаемое значение:

Объект.

getRevision(){number} inherited

Observable.js, line 79

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

Возвращаемое значение:

Версия.

getType(){Type}

geom/LineString.js, line 275

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

Возвращаемое значение:

Тип геометрии.

intersectsCoordinate(coordinate){boolean} inherited

geom/Geometry.js, line 167

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

Имя	Тип	Описание
coordinate	Coordinate	Координата.

Возвращаемое значение:

Содержит координату.

intersectsExtent(extent){boolean}

geom/LineString.js, line 286

Проверить пересечение геометрии и переданной области.

Имя	Тип	Описание
extent	Extent	Область.

Возвращаемое значение:

true, если геометрия и область пересекаются.

on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

Прослушивание определённого типа события.

Имя	Тип	Описание
type	string | Array.<string>	Тип события или массив типов событий.
listener	function	Функция-обработчик.

Возвращаемое значение:

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

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

Прослушивание одного раза для определенного типа события.

Имя	Тип	Описание
type	string | Array.<string>	Тип события или массив типов событий.
listener	function	Функция-обработчик.

Возвращает:

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

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

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

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

Имя	Тип	Описание
angle	number	Угол поворота против часовой стрелки в радианах.
anchor	Координата	Центр вращения.

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

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

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

Имя	Тип	Описание
sx	number	Коэффициент масштабирования по оси X.
sy	number | undefined	Коэффициент масштабирования по оси Y (по умолчанию равен sx).
anchor	Координата | undefined	Точка отсчёта масштабирования (по умолчанию — центр области геометрии).

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

Object.js, строка 215

Устанавливает значение.

Имя	Тип	Описание
key	string	Имя ключа.
value	*	Значение.
silent	boolean | undefined	Обновить без срабатывания события.

setCoordinates(coordinates, layout)

geom/LineString.js, строка 304

Установить координаты ломаной линии.

Имя	Тип	Описание
coordinates	Array<Координата>	Координаты.
layout	Макет геометрии | undefined	Макет.

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

Object.js, строка 235

Устанавливает набор пар ключ-значение. Обратите внимание, что это изменяет все существующие свойства и добавляет новые (это не удаляет какие-либо существующие свойства).

Имя	Тип	Описание
values	Object.<string, *>	Значения.
silent	boolean | undefined	Обновить без срабатывания события.

simplify(tolerance){Геометрия} унаследованно

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

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

Имя	Тип	Описание
tolerance	number	Расстояние допуска для упрощения.

Возвращает:

Новая, упрощенная версия исходной геометрии.

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

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

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

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

Возвращает:

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

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

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

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

Имя	Тип	Описание
deltaX	число	Дельта X.
deltaY	число	Дельта Y.

un(тип, слушатель) унаследованно

Observable.js, строка 173

Отключить прослушивание определенного типа события.

Имя	Тип	Описание
type	строка | Массив.<строка>	Тип события или массив типов событий.
listener	функция	Функция-слушатель.

unset(ключ, беззвучно) унаследованно

Object.js, строка 259

Сбросить свойство.

Имя	Тип	Описание
key	строка	Имя ключа.
silent	логическое значение | undefined	Сбросить без срабатывания события.