new ol.interaction.Draw(options)
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Options.
|
Fires:
-
change
(ol.events.Event) experimental - Generic change event. Triggered when the revision counter is increased. -
change:active
(ol.ObjectEvent) -
drawend
(ol.interaction.DrawEvent) - Triggered upon feature draw end -
drawstart
(ol.interaction.DrawEvent) - Triggered upon feature draw start -
propertychange
(ol.ObjectEvent) - Triggered when a property is changed.
Extends
Observable Properties
Name | Type | Settable | ol.ObjectEvent type | Description |
---|---|---|---|---|
active |
boolean | yes | change:active |
|
Methods
-
ol.interaction.Draw.createRegularPolygon(opt_sides, opt_angle){ol.DrawGeometryFunctionType} experimental
src/ol/interaction/draw.js, line 780 -
Create a
geometryFunction
formode: 'Circle'
that will create a regular polygon with a user specified number of sides and start angle instead of anol.geom.Circle
geometry.Name Type Description sides
number Number of sides of the regular polygon. Default is 32.
angle
number Angle of the first point in radians. 0 means East. Default is the angle defined by the heading from the center of the regular polygon to the current pointer position.
Returns:
Function that draws a polygon.
-
ol.interaction.Draw.handleEvent(mapBrowserEvent){boolean} experimental
src/ol/interaction/draw.js, line 341 -
Handles the
map browser event
and may actually draw or finish the drawing.This:
Name Type Description mapBrowserEvent
ol.MapBrowserEvent Map browser event.
Returns:
false
to stop event propagation.
-
changed() inherited experimental
src/ol/observable.js, line 58 -
Increases the revision counter and dispatches a 'change' event.
-
dispatchEvent(event) inherited experimental
src/ol/observable.js, line 75 -
Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a
type
property.Name Type Description event
Object | ol.events.Event | string Event object.
-
extend(feature) experimental
src/ol/interaction/draw.js, line 709 -
Extend an existing geometry by adding additional points. This only works on features with
LineString
geometries, where the interaction will extend lines by adding points to the end of the coordinates array.Name Type Description feature
ol.Feature Feature to be extended.
-
finishDrawing() experimental
src/ol/interaction/draw.js, line 644 -
Stop drawing and add the sketch feature to the target layer. The
ol.interaction.DrawEventType.DRAWEND
event is dispatched before inserting the feature. -
get(key){*} inherited
src/ol/object.js, line 148 -
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getActive(){boolean} inherited experimental
src/ol/interaction/interaction.js, line 64 -
Return whether the interaction is currently active.
Returns:
true
if the interaction is active,false
otherwise.
-
getKeys(){Array.<string>} inherited
src/ol/object.js, line 162 -
Get a list of object property names.
Returns:
List of property names.
-
Get the map associated with this interaction.
Returns:
Map.
-
getProperties(){Object.<string, *>} inherited
src/ol/object.js, line 172 -
Get an object of all property names and values.
Returns:
Object.
-
getRevision(){number} inherited experimental
src/ol/observable.js, line 84 -
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Returns:
Revision.
-
on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 99 -
Listen for a certain type of event.
Name Type Description type
string | Array.<string> The event type or array of event types.
listener
function The listener function.
this
Object The object to use as
this
inlistener
.Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
once(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 124 -
Listen once for a certain type of event.
Name Type Description type
string | Array.<string> The event type or array of event types.
listener
function The listener function.
this
Object The object to use as
this
inlistener
.Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
removeLastPoint() experimental
src/ol/interaction/draw.js, line 615 -
Remove last point of the feature currently being drawn.
-
set(key, value, opt_silent) inherited
src/ol/object.js, line 197 -
Sets a value.
Name Type Description key
string Key name.
value
* Value.
silent
boolean Update without triggering an event.
-
setActive(active) inherited experimental
src/ol/interaction/interaction.js, line 86 -
Activate or deactivate the interaction.
Name Type Description active
boolean Active.
-
setProperties(values, opt_silent) inherited
src/ol/object.js, line 217 -
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Name Type Description values
Object.<string, *> Values.
silent
boolean Update without triggering an event.
-
un(type, listener, opt_this) inherited
src/ol/observable.js, line 147 -
Unlisten for a certain type of event.
Name Type Description type
string | Array.<string> The event type or array of event types.
listener
function The listener function.
this
Object The object which was used as
this
by thelistener
. -
unByKey(key) inherited
src/ol/observable.js, line 168 -
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
ol.EventsKey | Array.<ol.EventsKey> The key returned by
on()
oronce()
(or an array of keys). -
unset(key, opt_silent) inherited
src/ol/object.js, line 231 -
Unsets a property.
Name Type Description key
string Key name.
silent
boolean Unset without triggering an event.