GeoJS

event

geo. Namespace

event

Description:

Common object containing all event types that are provided by the GeoJS API. Each property contained here is a valid target for event handling via geo.object#geoOn. The event object provided to handlers is different for each event type. Each handler is generally called with the this context being the class that caused the event.

Source:

event.js, line 18

Example

map.geoOn(geo.event.layerAdd, function (event) {
  // event is an object with type: geo.event.layerAdd
});

Namespaces

annotation
camera
feature
pixelmap
screenshot
svg

Type Definitions

base

Description:

All events are sent an object that are an extension of this type.

Source:

event.js, line 20

Properties:

Name	Type	Description
`event`	string	The event type that was triggered.
`geo`	object	A universal event object for controlling propagation.

All events are sent an object that are an extension of this type.

Type:

object

Events

actiondown

Description:

Triggered when an action is initiated with mouse down.

Source:

event.js, line 243

Properties:

Name	Type	Description
`state`	geo.actionState	The action state.
`mouse`	geo.mouseState	The mouse state.
`event`	jQuery.Event	The triggering jQuery event.

Type:

geo.event.base

actionmove

Description:

Triggered when an action is being processed during mouse movement.

Source:

event.js, line 254

Properties:

Name	Type	Description
`state`	geo.actionState	The action state.
`mouse`	geo.mouseState	The mouse state.
`event`	jQuery.Event	The triggering event.

Type:

geo.event.base

actionselection

Description:

Triggered when an action results in a selection.

Source:

event.js, line 276

Properties:

Name	Type	Description
`state`	geo.actionState	The action state.
`mouse`	geo.mouseState	The mouse state.
`event`	jQuery.Event	The triggering event.
`lowerLeft`	geo.screenPosition	Lower left of selection in screen coordinates.
`upperRight`	geo.screenPosition	Upper right of selection in screen coordinates.

Type:

geo.event.base

actionup

Description:

Triggered when an action is ended with a mouse up.

Source:

event.js, line 265

Properties:

Name	Type	Description
`state`	geo.actionState	The action state.
`mouse`	geo.mouseState	The mouse state.
`event`	jQuery.Event	The triggering event.

Type:

geo.event.base

actionwheel

Description:

Triggered when an action is triggered with a mouse wheel event.

Source:

event.js, line 291

Properties:

Name	Type	Description
`state`	geo.actionState	The action state.
`mouse`	geo.mouseState	The mouse state.
`event`	jQuery.Event	The triggering event.

Type:

geo.event.base

brush

Description:

Triggered on every mousemove during a brushing selection. The event object extends geo.brushSelection.

Source:

event.js, line 188

Type:

geo.event.base | geo.brushSelection

brushend

Description:

Triggered after a brush selection ends. The event object extends geo.brushSelection.

Source:

event.js, line 197

Type:

geo.event.base | geo.brushSelection

brushstart

Description:

Triggered when a brush selection starts. The event object extends geo.brushSelection.

Source:

event.js, line 206

Type:

geo.event.base | geo.brushSelection

draw

Description:

Triggered on every call to geo.map#draw before the map is rendered.

Source:

event.js, line 110

Properties:

Name	Type	Description
`target`	geo.map	The current map.

Type:

geo.event.base

drawEnd

Description:

Triggered on every call to geo.map#draw after the map is rendered.

Source:

event.js, line 119

Properties:

Name	Type	Description
`target`	geo.map	The current map.

Type:

geo.event.base

hidden

Description:

Triggered when the map is hidden (the browser tab is no longer visible)

Source:

event.js, line 137

Properties:

Name	Type	Description
`target`	geo.map	The current map.

Type:

geo.event.base

keyaction

Description:

Triggered when an action is triggered via the keyboard.

Source:

event.js, line 302

Properties:

Name Type Description

move

object

The movement that would happen if the action is passed through.

Properties

Name	Type	Attributes	Description
`zoomDelta`	number	<optional>	A change in the zoom level.
`zoom`	number	<optional>	A new zoom level.
`rotationDelta`	number	<optional>	A change in the rotation in radians.
`rotation`	number	<optional>	A new absolute rotation in radians.
`panX`	number	<optional>	A horizontal shift in display pixels.
`panY`	number	<optional>	A vertical shift in display pixels.
`cancel`	boolean	<optional>	Set to `true` to cancel the entire movement.

action

string

Action based on key

factor

number

Factor based on metakeys [0-2]. 0 means a small movement is preferred, 1 a medium movement, and 2 a large movement.

event

jQuery.Event

The triggering event

Type:

geo.event.base

layerAdd

Description:

Triggered when a layer is added to the map.

Source:

event.js, line 33

Properties:

Name	Type	Description
`target`	geo.map	The current map.
`layer`	geo.layer	The new layer that was added.

Type:

geo.event.base

layerMove

Description:

Triggered when a layer z-index is changed.

Source:

event.js, line 53

Properties:

Name	Type	Description
`target`	geo.map	The current map.
`layer`	geo.layer	The old layer that was removed.

Type:

geo.event.base

layerRemove

Description:

Triggered when a layer is removed from the map.

Source:

event.js, line 43

Properties:

Name	Type	Description
`target`	geo.map	The current map.
`layer`	geo.layer	The old layer that was removed.

Type:

geo.event.base

mouseclick

Description:

Triggered on mouseup events that happen soon enough and close enough to a mousedown event. The event object extends geo.mouseState.

Source:

event.js, line 155

Properties:

Name	Type	Description
`buttonsDown`	geo.mouseButtons	The buttons that were down at the start of the click action.

Type:

geo.event.base | geo.mouseState

mousedown

Description:

Triggered on mousedown events. The event object extends geo.mouseState.

Source:

event.js, line 177

Properties:

Name	Type	Description
`buttonsDown`	geo.mouseButtons	The buttons that were down at the end of the down action.

Type:

geo.event.base | geo.mouseState

mousemove

Description:

Triggered on every mousemove over the map's DOM element unless a click might occur. The event object extends geo.mouseState.

Source:

event.js, line 146

Type:

geo.event.base | geo.mouseState

mouseup

Description:

Triggered on mouseup events. The event object extends geo.mouseState.

Source:

event.js, line 166

Properties:

Name	Type	Description
`buttonsDown`	geo.mouseButtons	The buttons that were down at the start of the up action.

Type:

geo.event.base | geo.mouseState

pan

Description:

Triggered when the map is panned either by user interaction or map transition.

Source:

event.js, line 87

Properties:

Name Type Description

screenDelta

object

The number of pixels of the pan.

Properties

Name	Type	Description
`x`	number	Horizontal pan distance in pixels.
`y`	number	Vertical pan distance in pixels.

Type:

geo.event.base

parallelprojection

Description:

Triggered when the parallel projection mode is changes.

Source:

event.js, line 364

Properties:

Name	Type	Description
`paralellProjection`	boolean	`true` if parallel projection is turned on.

Type:

geo.event.base

resize

Description:

Triggered when the map's canvas is resized.

Source:

event.js, line 99

Properties:

Name	Type	Description
`target`	geo.map	The map that was resized.
`width`	number	The new width in pixels.
`height`	number	The new height in pixels.

Type:

geo.event.base

rotate

Description:

Triggered when the map is rotated around the current map center (pointing downward so that positive angles are clockwise rotations).

Source:

event.js, line 74

Properties:

Name	Type	Description
`rotation`	number	The angle of the rotation in radians. This is the map's complete rotation, not a delta.
`screenPosition`	geo.screenPosition	The screen position of the mouse pointer.

Type:

geo.event.base

select

Description:

Triggered when brushing results in a selection. The event object extends geo.brushSelection.

Source:

event.js, line 215

Type:

geo.event.base | geo.brushSelection

transitioncancel

Description:

Triggered if a map navigation animation is canceled.

Source:

event.js, line 352

Properties:

Name	Type	Description
`center`	geo.geoPosition	The target center.
`zoom`	number	The target zoom level.
`duration`	number	The duration of the transition in milliseconds.
`ease`	function	The easing function.

Type:

geo.event.base

transitionend

Description:

Triggered after a map navigation animation ends.

Source:

event.js, line 340

Properties:

Name	Type	Description
`center`	geo.geoPosition	The target center.
`zoom`	number	The target zoom level.
`duration`	number	The duration of the transition in milliseconds.
`ease`	function	The easing function.

Type:

geo.event.base

transitionstart

Description:

Triggered before a map navigation animation begins. Set event.geo.cancelAnimation to cancel the animation of the navigation. This will cause the map to navigate to the target location immediately. Set event.geo.cancelNavigation to cancel the navigation completely. The transition options can be modified in place.

Source:

event.js, line 324

Properties:

Name	Type	Description
`center`	geo.geoPosition	The target center.
`zoom`	number	The target zoom level.
`duration`	number	The duration of the transition in milliseconds.
`ease`	function	The easing function.