GeoJS

feature

geo .event. Namespace

feature

Description:

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'.

Source:

event.js, line 374

Events

brush

Description:

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

Source:

event.js, line 561

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.

Type:

geo.event.base

brushend

Description:

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

Source:

event.js, line 545

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.

Type:

geo.event.base

mouseclick

Description:

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

Source:

event.js, line 480

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.

Type:

geo.event.base

mouseclick_order

Description:

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

Source:

event.js, line 497

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.

Type:

geo.event.base

mousedown

Description:

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

Source:

event.js, line 510

Properties:

Name	Type	Description
`data`	object	The feature data the mouse is above.
`index`	number	The index of the feature data the mouse is above.
`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 down on 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.

Type:

geo.event.base

mousemove

Description:

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.

Source:

event.js, line 385

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.

Type:

geo.event.base

mouseoff

Description:

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

Source:

event.js, line 468

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.

Type:

geo.event.base

mouseon

Description:

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

Source:

event.js, line 456

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.

Type:

geo.event.base

mouseout

Description:

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

Source:

event.js, line 437

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.

Type:

geo.event.base

mouseover

Description:

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

Source:

event.js, line 404

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.

Type:

geo.event.base

mouseover_order

Description:

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

Source:

event.js, line 422

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.

Type:

geo.event.base

mouseup

Description:

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

Source:

event.js, line 527

Properties:

Name	Type	Description
`data`	object	The feature data the mouse is above.
`index`	number	The index of the feature data the mouse is above.
`extra`	object	Extra information about the feature and mouse location.
`mouse`	geo.mouseState	The mouse state. The buttons are before the up action occurs.
`eventID`	number	a monotonically increasing event number. All features that the mouse goes up on 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.

Type:

geo.event.base