These events are triggered by the annotation layer.
Events
-
Triggered when an annotation has been added.
Type:
Properties:
Name Type Description annotation
geo.annotation The annotation that was added.
-
Triggered when an annotation is about to be added.
Type:
Properties:
Name Type Description annotation
geo.annotation The annotation that will be added.
-
Triggered when an annotation can be combined via a boolean operation (union, intersect, difference, xor).
Type:
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.
-
Triggered when an annotation's coordinates have been updated.
Type:
Properties:
Name Type Description annotation
geo.annotation The annotation that was altered.
-
Triggered when an annotation is in cursor mode and an action occurs.
Type:
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.
-
Triggered when an annotation is in cursor mode and the mouse is clicked.
Type:
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.
-
Triggered when an action is performed on an annotation's edit handle.
Type:
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
. -
Triggered when the annotation mode is changed.
Type:
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
. -
Triggered when an annotation has been removed.
Type:
Properties:
Name Type Description annotation
geo.annotation The annotation that was removed.
-
Triggered when an annotation's edit handle is selected or released.
Type:
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.
-
Triggered when an annotation's state changes.
Type:
Properties:
Name Type Description annotation
geo.annotation The annotation that changed.
-
Triggered when an annotation has been altered. This is currently only triggered when updating existing annotations via the geojson function.
Type:
Properties:
Name Type Description annotation
geo.annotation The annotation that was altered.