ol/interaction/Draw

Классы

DrawEvent

Draw

Функции

createBox(){GeometryFunction}

interaction/Draw.js, строка 1922

import {createBox} from 'ol/interaction/Draw';

Создать функцию, которая будет создавать многоугольник в форме прямоугольника (выровненный по осям координат). Используйте это с взаимодействием рисования и type: 'Circle' для возврата прямоугольника вместо круга.

Возвращает:

Функция, рисующая многоугольник в форме прямоугольника.

createRegularPolygon(sides, angle){GeometryFunction}

interaction/Draw.js, строка 1881

import {createRegularPolygon} from 'ol/interaction/Draw';

Создайте функцию для type: 'Circle', которая будет создавать правильный многоугольник с заданным количеством сторон и начальным углом вместо геометрии Circle.

Имя	Тип	Описание
sides	число | undefined	Количество сторон правильного многоугольника. По умолчанию 32.
angle	число | undefined	Угол первой точки против часовой стрелки в радианах. 0 означает восток. По умолчанию — угол, определяемый азимутом от центра правильного многоугольника до текущей позиции указателя.

Возвращает:

Функция, рисующая многоугольник.

Определения типов

GeometryFunction()

interaction/Draw.js, line 150

Функция, которая принимает массив координат, необязательную существующую геометрию и проекцию в качестве аргументов и возвращает геометрию. Необязательная существующая геометрия — это геометрия, которая возвращается при вызове функции без второго аргумента.

LineCoordType{Array<Координата>}

Тип координат при рисовании линий.

Mode{'Точка'} {'Линия'} {'Многоугольник'} {'Окружность'}

Режим рисования. Это объединяет многокомпонентные типы геометрии с их однокомпонентными аналогами.

Options{Объект}

Свойства:

Имя	Тип	Описание
type	Тип	Тип геометрии создаваемых геометрий.
clickTolerance	число (по умолчанию 6)	Максимальное расстояние в пикселях между "вниз" и "вверх" для того, чтобы событие "вверх" считалось событием "нажатия" и фактически добавляло точку/вершину в чертежную геометрию. Значение по умолчанию (6) было выбрано для того, чтобы взаимодействие рисования работало корректно как с мышью, так и с сенсорными устройствами.
features	Коллекция<Элемент> | undefined	Целевая коллекция для нарисованных объектов.
source	Источник векторов | undefined	Целевой источник для нарисованных объектов.
dragVertexDelay	число (по умолчанию 500)	Задержка в миллисекундах после нажатия указателя, прежде чем текущую вершину можно будет перетащить в точное положение.
snapTolerance	число (по умолчанию 12)	Расстояние в пикселях для привязки к окончанию рисования. Должно быть больше, чем 0.
stopClick	логическое (по умолчанию false)	Остановить срабатывание событий click, singleclick и doubleclick во время рисования.
maxPoints	число | undefined	Количество точек, которое может быть нарисовано, прежде чем многоугольная линия или строка будет завершена. По умолчанию ограничений нет.
minPoints	число | undefined	Количество точек, которое должно быть нарисовано, прежде чем многоугольная линия или строка может быть завершена. По умолчанию 3 для многоугольных линий и 2 для линий.
finishCondition	Условие | undefined	Функция, которая принимает MapBrowserEvent и возвращает логическое значение для указания того, может ли быть завершено рисование. Не используется при рисовании геометрий POINT или MULTI_POINT.
style	Стиль | Стиль плоской формы | undefined	Стиль для эскизных объектов. Взаимодействие рисования может содержать до трех эскизных объектов, в зависимости от режима. Он всегда будет содержать объект с геометрией Point, соответствующей текущему положению курсора. Если режим является LineString или Polygon и нарисовано как минимум одна точка, он также будет содержать объект с геометрией LineString, соответствующей линии между уже нарисованными точками и текущим положением курсора. Если режим является Polygon, и нарисовано как минимум одна точка, он также будет содержать объект с геометрией Polygon, соответствующей многоугольнику между уже нарисованными точками и текущим положением курсора (обратите внимание, что этот многоугольник имеет только две точки, если нарисованна только одна точка). Если режим является Circle и нарисованна одна точка, он также будет содержать объект с геометрией Circle, центр которой является нарисованной точкой, а радиус определяется расстоянием между нарисованной точкой и курсором.
geometryFunction	Функция геометрии | undefined	Функция, которая вызывается при обновлении координат геометрии.
geometryName	строка | undefined	Имя геометрии, которое нужно использовать для объектов, созданных взаимодействием рисования.
condition	Условие | undefined	Функция, которая принимает MapBrowserEvent и возвращает логическое значение, чтобы указать, следует ли обработать это событие. По умолчанию noModifierKeys, т. е. клик, добавляет вершину или деактивирует рисование свободной рукой.
freehand	логическое (по умолчанию false)	Работать в режиме свободного рисования для линий, многоугольников и окружностей. Это заставляет взаимодействие всегда работать в режиме свободного рисования и имеет приоритет над любым параметром freehandCondition.
freehandCondition	Условие | undefined	Условие, активирующее рисование свободной рукой для линий и многоугольников. Эта функция принимает MapBrowserEvent и возвращает логическое значение, чтобы указать, следует ли обработать это событие. По умолчанию shiftKeyOnly, что означает, что клавиша Shift активирует рисование свободной рукой.
trace	логическое | Условие (по умолчанию false)	Проследить часть другой геометрии. Игнорируется, когда активен режим свободного рисования.
traceSource	Источник векторов | undefined	Источник объектов для отслеживания. Если отслеживание активно и traceSource не указано, будет использоваться source взаимодействия. Отслеживание требует, чтобы взаимодействие было настроено либо с traceSource, либо с source.
wrapX	логическое (по умолчанию false)	Переворачивать мир по горизонтали на накладке эскиза.
geometryLayout	Макет геометрии (по умолчанию 'XY')	Макет геометрии объектов, созданных взаимодействием рисования.

PointCoordType{Координата}

Тип координат при рисовании точек.

PointSegmentRelationship{Объект}

Свойства:

Имя	Тип	Описание
along	число	Ближайшая точка, выраженная как дробь вдоль длины отрезка.
squaredDistance	число	Квадратное расстояние от точки до отрезка.

PolyCoordType{Массив<Массив<Координата>>}

Тип координат при рисовании многоугольников.

SketchCoordType{PointCoordType} {LineCoordType} {PolyCoordType}

Типы, используемые для рисования координат.

TraceState{Object}

Свойства:

Имя	Тип	Описание
active	boolean	Слежение активно.
startPx	Pixel | undefined	Местоположение пикселя, на который был произведен первоначальный клик.
targets	Array<TraceTarget> | undefined	Доступные цели для слежения.
targetIndex	number | undefined	Индекс текущей цели слежения. Значение -1 указывает, что нет активной цели слежения.

TraceTarget{Object}

Свойства:

Имя	Тип	Описание
coordinates	Array<Coordinate>	Координаты цели.
ring	boolean	Координаты цели являются замкнутой ломаной.
startIndex	number	Индекс первой отслеживаемой координаты. Дробный индекс представляет пересечение отрезка. Значения индексов для колец будут циклическими (могут быть отрицательными или больше длины координат).
endIndex	number	Индекс последней отслеживаемой координаты. Подробности из startIndex также применяются здесь.

TraceTargetUpdateInfo{Object}

Свойства:

Имя	Тип	Описание
index	number	Новый индекс цели.
endIndex	number	Новый индекс конца сегмента.