Namespace: geo

geo

Classes

annotation
annotationLayer
camera
choroplethFeature
contourFeature
domRenderer
feature
featureLayer
fetchQueue
fileReader
graphFeature
heatmapFeature
imageTile
jsonReader
layer
lineAnnotation
lineFeature
map
mapInteractor
object
osmLayer
pathFeature
pixelmapFeature
pointFeature
poinyAnnotation
polygonAnnotation
polygonFeature
quadFeature
rectangleAnnotation
renderer
sceneObject
textFeature
tile
tileCache
tileLayer
timestamp
transform
vectorFeature

Namespaces

canvas
d3
event
gl
gui
util

Type Definitions

geo.actionRecordobject

The conditions that are necessary to make an action occur.

Properties:
Name Type Argument Description
action string

The name of the action, from (@link geo.action}.

owner string <optional>

A name of an owning process that can be used to locate or filter actions.

name string <optional>

A human-readable name that can be used to locate or filter actions.

input string | object

The name of an input that is used for the action, or an object with input names as keys and boolean values of inputs that are required to occur or required to not occur to trigger the action. Input names include left, right, middle (for mouse buttons), wheel (the mouse wheel), pan (touch pan), rotate (touch rotate).

modifiers string | object <optional>

The name of a modifier key or an object with modifiers as the keys and boolean values. The listed modifiers must be set or unset depending on the boolean value. Modifiers include shift, ctrl, alt, and meta.

selectionRectangle boolean | string <optional>

If truthy, a selection rectangle is shown during the action. If a string, the name of an event that is triggered when the selection is complete.

geo.actionStateobject

The current action state a map interactor.

Properties:
Name Type Argument Description
action string

Name of the action that is being handled.

actionRecord geo.actionRecord

The action record which triggered the current action.

origAction string <optional>

The name of an action that triggered this action.

origin geo.mouseState

The mouse state at the start of the action.

initialZoom number

The zoom level at the start of the action.

initialRotation number

The map's rotation in radians at the start of the action.

initialEventRotation number

The rotation reported by the event that triggered this action. For example, this could be the angle between two multi-touch points.

delta object

The total movement of during the action in gcs coordinates.

Properties
Name Type Description
x number

The horizontal movement during the action.

y number

The vertical movement during the action.

boundDocumentHandlers boolean

true if the mouse is down and being tracked.

start Date <optional>

The time when the action started.

handler function <optional>

A function to call on every animation from while the action is occurring.

momentum geo.mouseState <optional>

The mouse location when a momentum action starts.

zoomrotateAllowRotation boolean <optional>

Truthy if enough movement has occurred that rotations are allowed.

zoomrotateAllowZoom boolean <optional>

Truthy if enough movement has occurred that zooms are allowed.

zoomrotateAllowPan boolean <optional>

Truthy if enough movement has occurred that pans are allowed.

lastRotationDelta number <optional>

When rotating, the last amount that was rotated from the start of the action. This is used to debounce jitter on touch events.

initialEventGeo geo.geoPosition <optional>

The position of the mouse when significant movement first occurred.

geo.brushSelectionobject

The current brush selection (this is when a rectangular area is selected by dragging).

Properties:
Name Type Description
display geo.screenBounds

The selection bounds in pixel space.

gcs object

The selection bounds in the map's gcs.

Properties
Name Type Description
upperLeft geo.geoPosition

Upper left corner.

upperRight geo.geoPosition

Upper right corner.

lowerLeft geo.geoPosition

Lower left corner.

lowerRight geo.geoPosition

Lower right corner.

mouse geo.mouseState

The current mouse state.

origin geo.mouseState

The mouse state at the start of the brush action.

geo.geoBoundsobject

General representation of rectangular bounds in world coordinates.

Properties:
Name Type Description
left number

Horizontal coordinate of the top-left corner.

top number

Vertical coordinate of the top-left corner.

right number

Horizontal coordinate of the bottom-right corner.

bottom number

Vertical coordinate of the bottom-right corner.

geo.geoColorgeo.geoColorObject string

A color value. Although opacity can be specified, it is not always used. When a string is specified, any of the following forms can be used:

  • CSS color name
  • #rrggbb The color specified in hexadecmial with each channel on a scale between 0 and 255 (ff). Case insensitive.
  • #rrggbbaa The color and opacity specified in hexadecmial with each channel on a scale between 0 and 255 (ff). Case insensitive.
  • #rgb The color specified in hexadecmial with each channel on a scale between 0 and 15 (f). Case insensitive.
  • #rgba The color and opacity specified in hexadecmial with each channel on a scale between 0 and 15 (f). Case insensitive.
  • rgb(R, G, B), rgb(R, G, B, A), rgba(R, G, B), rgba(R, G, B, A) The color with the values of each color channel specified as numeric values between 0 and 255 or as percent (between 0 and 100) if a percent % follows the number. The alpha (opacity) channel is optional and can either be a number between 0 and 1 or a percent. White space may appear before and after numbers, and between the number and a percent symbol. Commas are not required. A slash may be used as a separator before the alpha value instead of a comma. The numbers conform to the CSS number specification, and can be signed floating-point values, possibly with exponents.
  • hsl(H, S, L), hsl(H, S, L, A), hsla(H, S, L), hsla(H, S, L, A) Hue, saturation, and lightness with optional alpha (opacity). Hue is a number between 0 and 360 and is interpretted as degrees unless an angle unit is specified. CSS units of deg, grad, rad, and turn are supported. Saturation and lightness are percentages between 0 and 100 and must be followed by a percent % symbol. The alpha (opacity) channel is optional and is specified as with rgba(R, G, B, A).
  • transparent Black with 0 opacity.

See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value for more details on CSS color values.

geo.geoColorObjectobject

A color value represented as an object. Although opacity can be specified, it is not always used.

Properties:
Name Type Argument Description
r number

The red intensity on a scale of [0-1].

g number

The green intensity on a scale of [0-1].

b number

The blue intensity on a scale of [0-1].

a number <optional>

The opacity on a scale of [0-1]. If unspecified and used, it should be treated as 1.

geo.geoPositionobject

General represention of a point on the earth. The coordinates are most commonly in longitude and latitude, but the coordinate system is changed by the interface gcs.

Properties:
Name Type Argument Default Description
x number

Horizontal coordinate, often degrees longitude.

y number

Vertical coordinate, often degrees latitude.

z number <optional>
0

Altitude coordinate.

geo.modifierKeysobject

The status of all modifier keys. These are usually copied from the standard DOM events.

Properties:
Name Type Description
alt boolean

True if the alt or option key is down.

ctrl boolean

True if the control key is down.

shift boolean

True if the shift key is down.

meta boolean

True if the meta, windows, or command key is down.

geo.mouseButtonsobject

The status of all mouse buttons.

Properties:
Name Type Description
left boolean

True if the left mouse button is down.

right boolean

True if the right mouse button is down.

middle boolean

True if the middle mouse button is down.

geo.mouseStateobject

The state of the mouse.

Properties:
Name Type Description
page geo.screenPosition

Mouse location in pixel space relative to the entire browser window.

map geo.screenPosition

Mouse location in pixel space relative to the map DOM node.

geo geo.geoPosition

Mouse location in interface gcs space.

mapgcs geo.geoPosition

Mouse location in gcs space.

buttons geo.mouseButtons

The current state of the mouse buttons.

modifiers geo.modifierKeys

The current state of all modifier keys.

time Date

The timestamp the event took place.

deltaTime number

The time in milliseconds since the last mouse event.

velocity geo.screenPosition

The velocity of the mouse pointer in pixels per millisecond.

geo.point2Dobject

General represention of a two-dimensional point in any coordinate system.

Properties:
Name Type Description
x number

Horizontal coordinate.

y number

Vertical coordinate.

geo.screenBoundsobject

General representation of rectangular bounds in pixel coordinates.

Properties:
Name Type Description
upperLeft geo.screenPosition

Upper left corner.

upperRight geo.screenPosition

Upper right corner.

lowerLeft geo.screenPosition

Lower left corner.

lowerRight geo.screenPosition

Lower right corner.

geo.screenPositionobject

General representation of a point on the screen.

Properties:
Name Type Description
x number

Horizontal coordinate in pixels.

y number

Vertical coordinate in pixels.

geo.screenSizeobject

Represention of a size in pixels.

Properties:
Name Type Description
width number

Width in pixels.

height number

Height in pixels.

geo.worldPositionobject

Represention of a point on the map. The coordinates are in the map's reference system, possibly with an affine transformation.

Properties:
Name Type Argument Default Description
x number

Horizontal coordinate in map coordinates.

y number

Vertical coordinate in map coordinates.

z number <optional>
0

Altitude coordinate, often zero.

geo.zoomAndCenterobject

A location and zoom value.

Properties:
Name Type Description
center geo.geoPosition

The center coordinates.

zoom number

The zoom level.