ol/interaction/Draw

Классы

DrawEvent

Draw

Функции

createBox(){GeometryFunction}

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

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

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

Возвращает:

Функцию, которая рисует прямоугольный полигон.

createRegularPolygon(sides, angle){GeometryFunction}

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

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

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

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

Возвращает:

Функцию, которая рисует полигон.

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

GeometryFunction()

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

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

LineCoordType{module:interaction/tracing~LineCoordType}

Mode{'Point'} {'LineString'} {'Polygon'} {'Circle'}

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

Options{Object}

Свойства:

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

PointCoordType{Coordinate}

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

PolyCoordType{Array<Array<Coordinate>>}

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

SketchCoordType{PointCoordType} {LineCoordType} {PolyCoordType}

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

TraceState{module:interaction/tracing~TraceState}

TraceTarget{module:interaction/tracing~TraceTarget}