Namespace: feature

geo.event. feature

This event object provides mouse/keyboard events that can be handled by the features. This provides a similar interface as core events, but with different names so the events don't interfere. Subclasses can override this to provide custom events.

These events will only be triggered on features which were instantiated with the option 'selectionAPI'.

Events

geo.event.feature.brush

This event is fired for each data component of a feature under an active brush.

Type:
Properties:
Name Type Description
data object

The feature data the mouse is over.

index number

The index of the feature data the mouse is over.

mouse geo.mouseState

The mouse state.

brush geo.brushSelection

The current brush selection.

eventID number

a monotonically increasing event number. All features that the mouse goes over simultaneously will have the same eventID.

top boolean

True if this is the topmost data element.

geo.event.feature.brushend

This event is fired for each data component of a feature under a brush that has just finished its selection.

Type:
Properties:
Name Type Description
data object

The feature data the mouse is over.

index number

The index of the feature data the mouse is over.

mouse geo.mouseState

The mouse state.

brush geo.brushSelection

The current brush selection.

eventID number

a monotonically increasing event number. All features that the mouse goes over simultaneously will have the same eventID.

top boolean

True if this is the topmost data element.

geo.event.feature.mouseclick

The event is the feature version of geo.event.mouseclick.

Type:
Properties:
Name Type Description
data object

The feature data the mouse is off.

index number

The index of the feature data the mouse is off.

extra object

Extra information about the feature and mouse location.

mouse geo.mouseState

The mouse state.

eventID number

a monotonically increasing event number. All features that the mouse clicks simultaneously will have the same eventID.

top boolean

True if this is the topmost data element.

sourceEvent geo.event

The underlying event that trigger this.

geo.event.feature.mouseclick_order

The event contains the feature, the mouse record, and over, the record of data elements that are under the mouse.

Type:
Properties:
Name Type Description
feature geo.feature

The feature that was clicked.

mouse geo.mouseState

The mouse state.

over geo.feature.searchResult

A list of feature components that the mouse is over.

sourceEvent geo.event

The underlying event that trigger this.

geo.event.feature.mousemove

The event is the feature version of geo.event.mousemove. It is fired for each data component of a feature below the mouse when the mouse moves.

Type:
Properties:
Name Type Description
data object

The feature data the mouse is over.

index number

The index of the feature data the mouse is over.

extra object

Extra information about the feature and mouse location.

mouse geo.mouseState

The mouse state.

eventID number

a monotonically increasing event number. All features that the mouse moves over simultaneously will have the same eventID.

top boolean

True if this is the topmost data element.

sourceEvent geo.event

The underlying event that trigger this.

geo.event.feature.mouseoff

This event is fired when mouse is no longer has the same topmost data component of a feature.

Type:
Properties:
Name Type Description
data object

The feature data the mouse is off.

index number

The index of the feature data the mouse is off.

mouse geo.mouseState

The mouse state.

sourceEvent geo.event

The underlying event that trigger this.

geo.event.feature.mouseon

This event is fired when mouse is over a new topmost data component of a feature.

Type:
Properties:
Name Type Description
data object

The feature data the mouse is on.

index number

The index of the feature data the mouse is on.

mouse geo.mouseState

The mouse state.

sourceEvent geo.event

The underlying event that trigger this.

geo.event.feature.mouseout

The event is the feature version of geo.event.mouseout.a This event is fired for each data component of a feature when the mouse is no longer above it.

Type:
Properties:
Name Type Description
data object

The feature data the mouse is over.

index number

The index of the feature data the mouse is over.

extra object

Extra information about the feature and mouse location.

mouse geo.mouseState

The mouse state.

eventID number

a monotonically increasing event number. All features that the mouse goes over simultaneously will have the same eventID.

top boolean

True if this is the topmost data element.

sourceEvent geo.event

The underlying event that trigger this.

geo.event.feature.mouseover

This event is fired for each data component of a feature when the mouse is above it.

Type:
Properties:
Name Type Description
data object

The feature data the mouse is over.

index number

The index of the feature data the mouse is over.

extra object

Extra information about the feature and mouse location.

mouse geo.mouseState

The mouse state.

eventID number

a monotonically increasing event number. All features that the mouse goes over simultaneously will have the same eventID.

top boolean

True if this is the topmost data element.

sourceEvent geo.event

The underlying event that trigger this.

geo.event.feature.mouseover_order

This event is fired when the mouse changes either which feature components or the order of the feature components that it is over.

Type:
Properties:
Name Type Description
feature geo.feature

The feature.

mouse geo.mouseState

The mouse state.

over geo.feature.searchResult

A list of feature components that the mouse is over.

The Array.<number>

indices of the data components that the mouse was over before this event.

sourceEvent geo.event

The underlying event that trigger this.