Classes

ol.Attribution

ol.Collection

ol.DeviceOrientation

ol.Feature

ol.FeatureOverlay

ol.Geolocation

ol.Kinetic

ol.Map

ol.MapBrowserEvent

ol.Object

ol.Observable

ol.Overlay

ol.View2D

Namespaces

ol.animation

ol.BrowserFeature

ol.control

ol.feature

ol.geom

ol.interaction

ol.layer

ol.proj

ol.source

ol.tilegrid

Members

<static> Coordinate

Stability: not documented

Source:

• coordinate.js, line 24

<static> inherits

Stability: experimental

ol.inherits is an alias to the goog.inherits function. It is exported for use in non-compiled application code. See ol.exports.

FIXME: We use a new line to fake the linter. Without the new line the linter complains with:

"Missing newline between constructor and goog.inherits"

Source:

• ol.js, line 14

<static> OverlayPositioning :string

Stability: experimental

Properties:

Name	Type	Default	Description
BOTTOM_LEFT	string	bottom-left
BOTTOM_CENTER	string	bottom-center
BOTTOM_RIGHT	string	bottom-right
CENTER_LEFT	string	center-left
CENTER_CENTER	string	center-center
CENTER_RIGHT	string	center-right
TOP_LEFT	string	top-left
TOP_CENTER	string	top-center
TOP_RIGHT	string	top-right

Source:

• overlay.js, line 31

<static> RendererHint :string

Stability: experimental

Properties:

Name	Type	Default	Description
CANVAS	string	canvas
DOM	string	dom
WEBGL	string	webgl

Source:

• map.js, line 107

<static> Size

Stability: not documented

Source:

• size.js, line 10

Methods

<static> IView

Stability: not documented

Interface for views.

Source:

• iview.js, line 12

TypeDefs

CanvasFunctionType

Stability: experimental

A function returning the canvas element ({HTMLCanvasElement}) used by the source as an image. The arguments passed to the function are: ol.Extent the image extent, {number} the image resolution, {number} the device pixel ratio, ol.Size the image size, and ol.proj.Projection the image projection. The canvas returned by this function is cached by the source. The this keyword inside the function references the ol.source.ImageCanvas.

Source:

• canvasfunction.js, line 17

Color

Stability: not documented

A color represented as a short array [red, green, blue, alpha]. red, green, and blue should be integers in the range 0..255 inclusive. alpha should be a float in the range 0..1 inclusive.

Source:

• color.js, line 30

Coordinate

Stability: experimental

An array of numbers representing a coordinate.

Source:

• coordinate.js, line 19

CoordinateFormatType

Stability: experimental

A function that takes a ol.Coordinate and transforms it into a {string}.

Source:

• coordinate.js, line 16

Extent

Stability: experimental

An array of numbers representing an extent: [minx, miny, maxx, maxy].

Source:

• extent.js, line 15

Pixel

Stability: not documented

Source:

• pixel.js, line 7

Size

Stability: experimental

An array of numbers representing a size: [width, height].

Source:

• size.js, line 5

TileLoadFunctionType

Stability: experimental

A function that takes an ol.ImageTile for the image tile and a {string} for the src as arguments.

Source:

• tileloadfunction.js, line 11

TileUrlFunctionType

Stability: experimental

A function that takes an ol.TileCoord for the tile coordinate, a {number} representing the pixel ratio and an ol.proj.Projection for the projection as arguments and returns a {string} or undefined representing the tile URL. The this keyword inside the function references the ol.source.TileImage.

Source:

• tileurlfunction.js, line 20

TransformFunction

Stability: experimental

A transform function accepts an array of input coordinate values, an optional output array, and an optional dimension (default should be 2). The function transforms the input coordinate values, populates the output array, and returns the output array.

Source:

• transformfunction.js, line 13