Draw~Draw

import Draw from 'ol/interaction/Draw.js';

Интеракция для рисования геометрий объектов.

new Draw(options) interaction/Draw.js, line 594

Имя	Тип	Описание
`type`	Тип	Тип геометрии, рисуемой с помощью этого экземпляра.
`clickTolerance`	число (по умолчанию 6)	Максимальное расстояние в пикселях между событиями «нажатие» и «отпускание» для того, чтобы событие «отпускание» считалось событием «щелчок» и фактически добавляло точку/вершину в рисуемую геометрию. Значение по умолчанию `6` было выбрано для корректной работы взаимодействия рисования как с мышью, так и с сенсорными устройствами.
`features`	Коллекция<Объект> \| undefined	Целевая коллекция для нарисованных объектов.
`source`	Источник векторов \| undefined	Целевой источник для нарисованных объектов.
`dragVertexDelay`	число (по умолчанию 500)	Задержка в миллисекундах после события pointerdown, перед тем как текущая вершина может быть перетащена в точное положение.
`snapTolerance`	число (по умолчанию 12)	Расстояние в пикселях для привязки к завершению рисования. Должно быть больше, чем `0`.
`stopClick`	логическое (по умолчанию false)	Прекратить обработку событий щелчка, одиночного щелчка и двойного щелчка во время рисования.
`maxPoints`	число \| undefined	Количество точек, которое можно нарисовать, прежде чем закроется полигональная линия или линия.
`minPoints`	число \| undefined	Количество точек, которые должны быть нарисованы, прежде чем полигональная линия или линия могут быть завершены. По умолчанию это `3` для полигональных линий и `2` для линий.
`finishCondition`	Условие \| undefined	Функция, которая принимает `MapBrowserEvent` и возвращает булево значение, указывающее, можно ли завершить рисование. Не используется при рисовании геометрий ТОЧКА или МНОГОТОЧЕК.
`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')	Макет геометрии объектов, созданных с помощью взаимодействия рисования.

Вызывает:

change (BaseEvent) - Общее событие изменения. Вызывается при увеличении счётчика ревизий.
change:active (ObjectEvent)
drawabort (DrawEvent) - Вызывается при прерывании рисования объекта.
drawend (DrawEvent) - Вызывается при завершении рисования объекта.
drawstart (DrawEvent) - Вызывается при начале рисования объекта.
error (BaseEvent) - Общее событие ошибки. Вызывается при возникновении ошибки.
propertychange (ObjectEvent) - Вызывается при изменении свойства.

Расширяет

PointerInteraction

Наблюдаемые свойства

Имя	Тип	Устанавливаемое	ObjectEvent тип	Описание
`active`	логическое	да	`change:active`	`true`, если взаимодействие активно, `false` в противном случае.

Методы

abortDrawing() interaction/Draw.js, line 1745

Остановьте рисование, не добавляя чертежный элемент на целевой слой.

appendCoordinates(coordinates) interaction/Draw.js, line 1761

Добавьте координаты в конец геометрии, которая в данный момент рисуется. Это может использоваться при рисовании LineStrings или Polygons. Координаты будут добавлены либо к текущей LineString, либо к внешнему контуру текущего Polygon. Если геометрия не рисуется, будет создана новая.

Имя	Тип	Описание
`coordinates`	LineCoordType	Линейные координаты, которые будут добавлены в массив координат.

changed() inherited Observable.js, line 68

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

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

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

Имя	Тип	Описание
`event`	BaseEvent \| string	Объект события.

Возвращает:

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

extend(feature) interaction/Draw.js, line 1810

Запускает режим рисования, начиная с существующей геометрии, которая получит новые дополнительные точки. Это работает только с геометриями, где взаимодействие будет расширять линии, добавляя точки в конец массива координат. Это изменит исходный элемент, а не нарисует копию.

Функция отправит событие drawstart.

Имя	Тип	Описание
`feature`	Feature<LineString>	Расширяемый элемент.

finishDrawing(){Feature<SimpleGeometry> | null} interaction/Draw.js, line 1678

Остановьте рисование и добавьте чертежный элемент на целевой слой. Событие DRAWEND отправляется перед вставкой элемента.

Возвращает:

Нарисованный элемент.

get(key){*} inherited Object.js, line 135

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

Имя	Тип	Описание
`key`	string	Имя ключа.

Возвращает:

Значение.

getActive(){boolean} inherited interaction/Interaction.js, line 82

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

Возвращает:

true, если интерактивный элемент активен, false в противном случае.

getKeys(){Array.<string>} inherited Object.js, line 148

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

Возвращает:

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

getMap(){Map | null} inherited interaction/Interaction.js, line 91

Получить карту, связанную с этим взаимодействием.

Возвращает:

Карта.

getOverlay(){VectorLayer} interaction/Draw.js, line 980

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

Возвращает:

Слой наложения.

getPointerCount(){number} inherited interaction/Pointer.js, line 95

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

Возвращает:

Количество указателей.

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

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

Возвращает:

Объект.

getRevision(){number} inherited Observable.js, line 79

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

Возвращает:

Revision.

handleEvent(event){boolean} interaction/Draw.js, line 991

Обрабатывает событие map browser event и, возможно, выполняет отрисовку или завершает отрисовку.

Имя	Тип	Описание
`event`	MapBrowserEvent	Событие браузера карты.

Возвращает:

false для остановки распространения события.

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	Функция-слушатель.

Возвращает:

removeLastPoint() interaction/Draw.js, line 1667

Удалить последнюю точку текущего чертежа. Не делает ничего при рисовании геометрий POINT или MULTI_POINT.

set(key, value, silent) inherited Object.js, line 215

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

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

setActive(active) inherited interaction/Interaction.js, line 111

Активировать или деактивировать взаимодействие.

Имя	Тип	Описание
`active`	boolean	Активный.

setProperties(values, silent) inherited Object.js, line 235

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

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

un(type, listener) inherited Observable.js, line 173

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

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

unset(key, silent) inherited Object.js, line 259

Удаляет свойство.

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