OpenLayers 3- Source:
- ol.jsdoc, line 1
Classes
- ol.Attribution
- ol.Collection
- ol.CollectionEvent
- ol.DeviceOrientation
- ol.DragBoxEvent
- ol.DrawEvent
- ol.Feature
- ol.FeatureOverlay
- ol.Geolocation
- ol.ImageTile
- ol.Kinetic
- ol.Map
- ol.MapBrowserEvent
- ol.MapEvent
- ol.Object
- ol.ObjectEvent
- ol.Observable
- ol.Overlay
- ol.Tile
- ol.TileCoord
- ol.View2D
Namespaces
- ol.animation
- ol.BrowserFeature
- ol.control
- ol.feature
- ol.geom
- ol.interaction
- ol.layer
- ol.proj
- ol.render
- ol.source
- ol.tilegrid
Members
-
<static> inherits
Stability: 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"
- Source:
- ol.js, line 190
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
-
CenterConstraintType
Stability: experimental -
- Source:
- centerconstraint.js, line 11
-
Coordinate
Stability: experimental -
An array of numbers representing a coordinate.
- Source:
- coordinate.js, line 19
-
CoordinateArray
Stability: experimental -
An array of coordinate arrays.
- Source:
- coordinate.js, line 32
-
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 17
-
OverlayPositioning
Stability: experimental -
Overlay position:
'bottom-left','bottom-center','bottom-right','center-left','center-center','center-right','top-left','top-center','top-right'- Source:
- overlay.js, line 34
-
PreRenderFunction
Stability: experimental -
Function to perform manipulations before rendering. This function is called with the ol.Map as first and an optional oli.FrameState as second argument. Return
trueto keep this function for the next frame,falseto remove it.- Source:
- framestate.js, line 22
-
RendererHint
Stability: experimental -
Available renderers:
'canvas','dom'or'webgl'.- Source:
- map.js, line 106
-
Size
Stability: experimental -
An array of numbers representing a size:
[width, height].- Source:
- size.js, line 10
-
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.- Source:
- tileurlfunction.js, line 19
-
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