# Namespace: ol

## ol

### Classes

Attribution
Collection
CollectionEvent
DeviceOrientation
DragBoxEvent
DrawEvent
Feature
FeatureOverlay
Geolocation
ImageTile
IView
IView2D
IView3D
Kinetic
Map
MapBrowserEvent
MapEvent
Object
ObjectEvent
Observable
Overlay
Tile
TileCoord
View
View2D

### Namespaces

animation
BrowserFeature
control
coordinate
events
extent
feature
geom
interaction
layer
loadingstrategy
proj
render
source
tilegrid

### Members

#### staticol.inherits experimental

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

  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"

### Type Definitions

#### ol.CanvasFunctionType() experimental

src/ol/canvasfunction.js, line 17

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

#### ol.CenterConstraintType() experimental

src/ol/centerconstraint.js, line 11

#### ol.Coordinate{Array.<number>} experimental

  An array of numbers representing an xy coordinate. Example: `[16, 48]`.

#### ol.CoordinateArray{Array.<ol.Coordinate>} experimental

  An array of coordinate arrays.

#### ol.CoordinateFormatType() experimental

src/ol/coordinate.js, line 16

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

#### ol.Extent{Array.<number>} experimental

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

#### ol.OverlayPositioning{string} experimental

  Overlay position: `'bottom-left'`, `'bottom-center'`, `'bottom-right'`, `'center-left'`, `'center-center'`, `'center-right'`, `'top-left'`, `'top-center'`, `'top-right'`

#### ol.Pixel{Array.<number>} experimental

  An array with two elements, representing a pixel. The first element is the x-coordinate, the second the y-coordinate of the pixel.

#### ol.PreRenderFunction() experimental

src/ol/framestate.js, line 22

  Function to perform manipulations before rendering. This function is called with the `ol.Map` as first and an optional `olx.FrameState` as second argument. Return `true` to keep this function for the next frame, `false` to remove it.

#### ol.RendererType{string} experimental

  Available renderers: `'canvas'`, `'dom'` or `'webgl'`.

#### ol.Size{Array.<number>} experimental

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

#### ol.TileLoadFunctionType() experimental

src/ol/tileloadfunction.js, line 11

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

#### ol.TileUrlFunctionType() experimental

src/ol/tileurlfunction.js, line 19

  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.

#### ol.TransformFunction() experimental

src/ol/transformfunction.js, line 13

  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.