new ol.interaction.Draw(options)
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Options.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
Fires:
-
change(ol.events.Event) - Generic change event. Triggered when the revision counter is increased. -
change:active(ol.Object.Event) -
drawend(ol.interaction.Draw.Event) - Triggered upon feature draw end -
drawstart(ol.interaction.Draw.Event) - Triggered upon feature draw start -
propertychange(ol.Object.Event) - Triggered when a property is changed.
Extends
Classes
Observable Properties
| Name | Type | Settable | ol.Object.Event type | Description |
|---|---|---|---|---|
active |
boolean | yes | change:active |
|
Methods
-
Create a
geometryFunctionthat will create a box-shaped polygon (aligned with the coordinate system axes). Use this with the draw interaction andtype: 'Circle'to return a box instead of a circle geometry.Returns:
Function that draws a box-shaped polygon.
-
ol.interaction.Draw.createRegularPolygon(opt_sides, opt_angle){ol.DrawGeometryFunctionType}
src/ol/interaction/draw.js, line 787 -
Create a
geometryFunctionfortype: 'Circle'that will create a regular polygon with a user specified number of sides and start angle instead of anol.geom.Circlegeometry.Name Type Description sidesnumber Number of sides of the regular polygon. Default is 32.
anglenumber 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(event){boolean}
src/ol/interaction/draw.js, line 323 -
Handles the
map browser eventand may actually draw or finish the drawing.This:
Name Type Description eventol.MapBrowserEvent Map browser event.
Returns:
falseto stop event propagation.
-
Increases the revision counter and dispatches a 'change' event.
-
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
typeproperty.Name Type Description eventObject | ol.events.Event | string Event object.
-
extend(feature)
src/ol/interaction/draw.js, line 720 -
Extend an existing geometry by adding additional points. This only works on features with
LineStringgeometries, where the interaction will extend lines by adding points to the end of the coordinates array.Name Type Description featureol.Feature Feature to be extended.
-
finishDrawing()
src/ol/interaction/draw.js, line 657 -
Stop drawing and add the sketch feature to the target layer. The
ol.interaction.DrawEventType.DRAWENDevent is dispatched before inserting the feature. -
Gets a value.
Name Type Description keystring Key name.
Returns:
Value.
-
Return whether the interaction is currently active.
Returns:
trueif the interaction is active,falseotherwise.
-
Get a list of object property names.
Returns:
List of property names.
-
Get the map associated with this interaction.
Returns:
Map.
-
Get an object of all property names and values.
Returns:
Object.
-
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 typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.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 typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.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()
src/ol/interaction/draw.js, line 622 -
Remove last point of the feature currently being drawn.
-
Sets a value.
Name Type Description keystring Key name.
value* Value.
silentboolean Update without triggering an event.
-
Activate or deactivate the interaction.
Name Type Description activeboolean Active.
-
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 valuesObject.<string, *> Values.
silentboolean Update without triggering an event.
-
Unlisten for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object which was used as
thisby thelistener. -
Unsets a property.
Name Type Description keystring Key name.
silentboolean Unset without triggering an event.
OpenLayers