OpenLayers.Handler.Point - OpenLayers

# 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’ and ‘cancel’. 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.
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 ‘done’ property whose value is a function to be called when the point drawing is finished. The callback should expect to recieve a single argument, the point geometry. If the callbacks object contains a ‘cancel’ property, this function will be called when the handler is deactivated while drawing. The cancel should expect to receive a geometry.
options | {Object} An optional object with properties to be set on the handler

### Functions

### activate

> activate: function()

turn on the handler

### createFeature

> createFeature: function()

Add temporary features

### 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

### 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

Vector features use the OpenLayers.Geometry classes as geometry description.
Instances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources.
This class represents a screen coordinate, in x and y coordinates

> activate: function()

turn on the handler

> createFeature: function()

Add temporary features

> deactivate: function()

turn off the handler

> destroyFeature: function()

Destroy the temporary geometries

> finalize: function( | cancel | )

Finish the geometry and call the “done” callback.

> cancel: function()

Finish the geometry and call the “cancel” callback.

> click: function( | evt | )

Handle clicks.

> dblclick: function( | evt | )

Handle double-clicks.

> drawFeature: function()

Render features on the temporary layer.

> getGeometry: function()

Return the sketch geometry.

> geometryClone: function()

Return a clone of the relevant geometry.

> mousedown: function( | evt | )

Handle mouse down.

> mousemove: function ( | evt | )

Handle mouse move.

> mouseup: function ( | evt | )

Handle mouse up.
Create a new point handler.
Base class to construct a higher-level handler for event sequences.
Controls affect the display or behavior of the map.
{Boolean} Cast features to multi-part geometries before passing to the layer.
Point geometry class.
A Geometry is a description of a geographic object.
Close