OpenLayers.Handler.Point

Handler to draw a point on the map. Point is displayed on mouse down, moves on mouse move, and is finished on mouse up. The handler triggers callbacks for ‘done’, ‘cancel’, and ‘modify’. The modify callback is called with each change in the sketch and will receive the latest point drawn. Create a new instance with the OpenLayers.Handler.Point constructor.

Inherits from

OpenLayers.Handler

Summary

OpenLayers.Handler.Point	Handler to draw a point on the map.
Properties
point	{OpenLayers.Feature.Vector} The currently drawn point
layer	{OpenLayers.Layer.Vector} The temporary drawing layer
multi	{Boolean} Cast features to multi-part geometries before passing to the layer.
drawing	{Boolean} A point is being drawn
mouseDown	{Boolean} The mouse is down
lastDown	{OpenLayers.Pixel} Location of the last mouse down
lastUp	{OpenLayers.Pixel}
persist	{Boolean} Leave the feature rendered until destroyFeature is called.
layerOptions	{Object} Any optional properties to be set on the sketch layer.
Constructor
OpenLayers.Handler.Point	Create a new point handler.
Functions
activate	turn on the handler
createFeature	Add temporary features
deactivate	turn off the handler
destroyFeature	Destroy the temporary geometries
finalize	Finish the geometry and call the “done” callback.
cancel	Finish the geometry and call the “cancel” callback.
click	Handle clicks.
dblclick	Handle double-clicks.
modifyFeature	Modify the existing geometry given a pixel location.
drawFeature	Render features on the temporary layer.
getGeometry	Return the sketch geometry.
geometryClone	Return a clone of the relevant geometry.
mousedown	Handle mouse down.
mousemove	Handle mouse move.
mouseup	Handle mouse up.

Properties

point

{OpenLayers.Feature.Vector} The currently drawn point

layer

{OpenLayers.Layer.Vector} The temporary drawing layer

multi

{Boolean} Cast features to multi-part geometries before passing to the layer. Default is false.

drawing

{Boolean} A point is being drawn

mouseDown

{Boolean} The mouse is down

lastDown

{OpenLayers.Pixel} Location of the last mouse down

lastUp

{OpenLayers.Pixel}

persist

{Boolean} Leave the feature rendered until destroyFeature is called. Default is false. If set to true, the feature remains rendered until destroyFeature is called, typically by deactivating the handler or starting another drawing.

layerOptions

{Object} Any optional properties to be set on the sketch layer.

Constructor

OpenLayers.Handler.Point

Create a new point handler.

Parameters

control	{OpenLayers.Control} The control that owns this handler
callbacks	{Object} An object with a properties whose values are functions. Various callbacks described below.
options	{Object} An optional object with properties to be set on the handler

Named callbacks

create	Called when a sketch is first created. Callback called with the creation point geometry and sketch feature.
modify	Called with each move of a vertex with the vertex (point) geometry and the sketch feature.
done	Called when the point drawing is finished. The callback will recieve a single argument, the point geometry.
cancel	Called when the handler is deactivated while drawing. The cancel callback will receive a geometry.

Functions

activate

activate: function()

turn on the handler

createFeature

createFeature: function( pixel )

Add temporary features

Parameters

pixel

{OpenLayers.Pixel} A pixel location on the map.

deactivate

deactivate: function()

turn off the handler

destroyFeature

destroyFeature: function()

Destroy the temporary geometries

finalize

finalize: function( cancel )

Finish the geometry and call the “done” callback.

Parameters

cancel

{Boolean} Call cancel instead of done callback. Default is false.

cancel

cancel: function()

Finish the geometry and call the “cancel” callback.

click

click: function( evt )

Handle clicks. Clicks are stopped from propagating to other listeners on map.events or other dom elements.

Parameters

evt	{Event} The browser event

Returns

{Boolean} Allow event propagation

dblclick

dblclick: function( evt )

Handle double-clicks. Double-clicks are stopped from propagating to other listeners on map.events or other dom elements.

Parameters

evt	{Event} The browser event

Returns

{Boolean} Allow event propagation

modifyFeature

modifyFeature: function( pixel )

Modify the existing geometry given a pixel location.

Parameters

pixel

{OpenLayers.Pixel} A pixel location on the map.

drawFeature

drawFeature: function()

Render features on the temporary layer.

getGeometry

getGeometry: function()

Return the sketch geometry. If multi is true, this will return a multi-part geometry.

Returns

{OpenLayers.Geometry.Point}

geometryClone

geometryClone: function()

Return a clone of the relevant geometry.

Returns

{OpenLayers.Geometry}

mousedown

mousedown: function( evt )

Handle mouse down. Adjust the geometry and redraw. Return determines whether to propagate the event on the map.

Parameters

evt	{Event} The browser event

Returns

{Boolean} Allow event propagation

mousemove

mousemove: function ( evt )

Handle mouse move. Adjust the geometry and redraw. Return determines whether to propagate the event on the map.

Parameters

evt	{Event} The browser event

Returns

{Boolean} Allow event propagation

mouseup

mouseup: function ( evt )

Handle mouse up. Send the latest point in the geometry to the control. Return determines whether to propagate the event on the map.

Parameters

evt	{Event} The browser event

Returns

{Boolean} Allow event propagation