Namespace: annotation

Events

geo.event.annotation.add

event.js, line 601

Triggered when an annotation has been added.

Type:

• geo.event.base

Properties:

Name	Type	Description
annotation	geo.annotation	The annotation that was added.

geo.event.annotation.add_before

event.js, line 610

Triggered when an annotation is about to be added.

Type:

• geo.event.base

Properties:

Name	Type	Description
annotation	geo.annotation	The annotation that will be added.

geo.event.annotation.boolean

event.js, line 695

Triggered when an annotation can be combined via a boolean operation (union, intersect, difference, xor).

Type:

• geo.event.base

Properties:

Name	Type	Argument	Description
annotation	geo.annotation		The annotation that is being operated on.
operation	string		The operation being performed.
cancel	boolean	<optional>	If the handle sets this to false, don't apply the operation to the annotation layer.

geo.event.annotation.coordinates

event.js, line 629

Triggered when an annotation's coordinates have been updated.

Type:

• geo.event.base

Properties:

Name	Type	Description
annotation	geo.annotation	The annotation that was altered.

geo.event.annotation.cursor_action

event.js, line 723

Triggered when an annotation is in cursor mode and an action occurs.

Type:

• geo.event.base

Properties:

Name	Type	Argument	Description
annotation	geo.annotation		The annotation that is being operated on.
operation	string		The operation being performed.
cancel	boolean	<optional>	If the handle sets this to false, don't apply the operation to the annotation layer.
event	object		The triggering event.

geo.event.annotation.cursor_click

event.js, line 709

Triggered when an annotation is in cursor mode and the mouse is clicked.

Type:

• geo.event.base

Properties:

Name	Type	Argument	Description
annotation	geo.annotation		The annotation that is being operated on.
operation	string		The operation being performed.
cancel	boolean	<optional>	If the handle sets this to false, don't apply the operation to the annotation layer.
event	object		The triggering event.

geo.event.annotation.edit_action

event.js, line 651

Triggered when an action is performed on an annotation's edit handle.

Type:

• geo.event.base

Properties:

Name	Type	Description
annotation	geo.annotation	The annotation that has an edit handle selected or unselected.
handle	object	Information on the edit handle.
action	boolean	The edit action, typically one of geo.event.actiondown, geo.event.actionmove, geo.event.actionup.

geo.event.annotation.mode

event.js, line 683

Triggered when the annotation mode is changed.

Type:

• geo.event.base

Properties:

Name	Type	Argument	Description
mode	string	<nullable>	The new annotation mode. This is one of the values from geo.annotation.state.
oldMode	string	<nullable>	The annotation mode before this change. This is one of the values from geo.annotation.state.

geo.event.annotation.remove

event.js, line 665

Triggered when an annotation has been removed.

Type:

• geo.event.base

Properties:

Name	Type	Description
annotation	geo.annotation	The annotation that was removed.

geo.event.annotation.select_edit_handle

event.js, line 638

Triggered when an annotation's edit handle is selected or released.

Type:

• geo.event.base

Properties:

Name	Type	Description
annotation	geo.annotation	The annotation that has an edit handle selected or unselected.
handle	object	Information on the edit handle.
enable	boolean	Truthy if the handle was enabled, falsy if disabled.

geo.event.annotation.state

event.js, line 674

Triggered when an annotation's state changes.

Type:

• geo.event.base

Properties:

Name	Type	Description
annotation	geo.annotation	The annotation that changed.

geo.event.annotation.update

event.js, line 619

Triggered when an annotation has been altered. This is currently only triggered when updating existing annotations via the geojson function.

Type:

• geo.event.base

Properties:

Name	Type	Description
annotation	geo.annotation	The annotation that was altered.