Namespaces

olx.animation

olx.control

olx.format

olx.interaction

olx.layer

olx.parser

olx.render

olx.source

olx.style

olx.tilegrid

TypeDefs

AttributionOptions

Stability: experimental

Properties:

Name	Type	Description
html	string	HTML markup for this attribution.
tileRanges	Object.<string, Array.<ol.TileRange>> | undefined	Tile ranges (FOR INTERNAL USE ONLY).

Source:

• objectliterals.jsdoc, line 1

DeviceOptions

Stability: experimental

Properties:

Name	Type	Description
loadTilesWhileAnimating	boolean | undefined	When set to false, no tiles will be loaded while animating, which improves responsiveness on devices with slow memory. Default is true.
loadTilesWhileInteracting	boolean | undefined	When set to false, no tiles will be loaded while interacting, which improves responsiveness on devices with slow memory. Default is true.

Source:

• objectliterals.jsdoc, line 3

DeviceOrientationOptions

Stability: experimental

Properties:

Name	Type	Description
tracking	boolean | undefined	Start tracking. Default is false.

Source:

• objectliterals.jsdoc, line 5

FeatureOverlayOptions

Stability: not documented

Properties:

Name	Type	Description
features	Array.<ol.Feature> | ol.Collection | undefined	Features.
map	ol.Map | undefined	Map.
style	ol.style.Style | Array.<ol.style.Style> | ol.feature.StyleFunction | undefined	Feature style.

Source:

• objectliterals.jsdoc, line 101

GeolocationOptions

Stability: experimental

Properties:

Name	Type	Description
tracking	boolean | undefined	Start Tracking. Default is false.
trackingOptions	GeolocationPositionOptions | undefined	Tracking options.
projection	ol.proj.ProjectionLike	Projection.

Source:

• objectliterals.jsdoc, line 7

MapOptions

Stability: experimental

Object literal with config options for the map.

Properties:

Name	Type	Description
controls	ol.Collection | Array.<ol.control.Control> | undefined	Controls initially added to the map.
deviceOptions	olx.DeviceOptions | undefined	Device options for the map.
pixelRatio	number | undefined	The ratio between physical pixels and device-independent pixels (dips) on the device. If undefined then it gets set by using window.devicePixelRatio.
interactions	ol.Collection | Array.<ol.interaction.Interaction> | undefined	Interactions that are initially added to the map.
keyboardEventTarget	Element | Document | string | undefined	The element to listen to keyboard events on. This determines when the KeyboardPan and KeyboardZoom interactions trigger. For example, if this option is set to document the keyboard interactions will always trigger. If this option is not specified, the element the library listens to keyboard events on is the map target (i.e. the user-provided div for the map). If this is not document the target element needs to be focused for key events to be emitted, requiring that the target element has a tabindex attribute.
layers	Array.<ol.layer.Base> | ol.Collection | undefined	Layers.
ol3Logo	boolean | undefined	Show ol3 logo. Default is true.
overlays	ol.Collection | Array.<ol.Overlay> | undefined	Overlays initially added to the map.
renderer	ol.RendererHint | Array.<(ol.RendererHint|string)> | string | undefined	Renderer.
target	Element | string | undefined	The container for the map.
view	ol.IView | undefined	The map's view. Currently ol.View2D is available as view.

Source:

• objectliterals.jsdoc, line 9

OverlayOptions

Stability: experimental

Object literal with config options for the overlay.

Properties:

Name	Type	Description
element	Element | undefined	The overlay element.
position	ol.Coordinate | undefined	The overlay position in map projection.
positioning	ol.OverlayPositioning | string | undefined	Positioning.
stopEvent	boolean | undefined	Whether event propagation to the map viewport should be stopped. Default is true. If true the overlay is placed in the same container as that of the controls (ol-overlaycontainer-stopevent).
insertFirst	boolean | undefined	Whether the overlay is inserted first in the overlay container, or appended. Default is true. If the overlay is placed in the same container as that of the controls (see the stopEvent option) you will probably set insertFirst to true so the overlay is displayed below the controls.

Source:

• objectliterals.jsdoc, line 11

Proj4jsProjectionOptions

Stability: experimental

Object literal with config options for the Proj4js projection.

Properties:

Name	Type	Description
code	string	The SRS identifier code, e.g. EPSG:31256.
extent	ol.Extent | undefined	The validity extent for the SRS.
global	boolean | undefined	Whether the projection is valid for the whole globe. Default is false.

Source:

• objectliterals.jsdoc, line 13

ProjectionOptions

Stability: experimental

Object literal with config options for the projection.

Properties:

Name	Type	Description
code	string	The SRS identifier code, e.g. EPSG:4326.
units	ol.proj.Units | string	Units.
extent	ol.Extent | undefined	The validity extent for the SRS.
axisOrientation	string | undefined	The axis orientation as specified in Proj4. The default is enu.
global	boolean | undefined	Whether the projection is valid for the whole globe. Default is false.

Source:

• objectliterals.jsdoc, line 15

View2DOptions

Stability: experimental

Object literal with config options for the view.

Properties:

Name	Type	Description
center	ol.Coordinate | undefined	The initial center for the view. The coordinate system for the center is specified with the projection option. Default is undefined, and layer sources will not be fetched if this is not set.
constrainRotation	boolean | number | undefined	Rotation constraint. false means no constraint. true means no constraint, but snap to zero near zero. A number constraints the rotation to that number of values. For example, 4 will constrain the rotation to 0, 90, 180, and 270 degrees. The default is true.
enableRotation	boolean | undefined	Enable rotation. Default is true.
extent	ol.Extent | undefined	The extent that constrains the center, in other words, center cannot be set outside this extent. Default is undefined.
maxResolution	number | undefined	The maximum resolution used to determine the resolution constraint. It is used together with maxZoom and zoomFactor. If unspecified it is calculated in such a way that the projection's validity extent fits in a 256x256 px tile. If the projection is Spherical Mercator (the default) then maxResolution defaults to 40075016.68557849 / 256 = 156543.03392804097.
maxZoom	number | undefined	The maximum zoom level used to determine the resolution constraint. It is used together with maxResolution and zoomFactor. Default is 28.
projection	ol.proj.ProjectionLike	The projection. Default is EPSG:3857 (Spherical Mercator).
resolution	number | undefined	The initial resolution for the view. The units are projection units per pixel (e.g. meters per pixel). An alternative to setting this is to set zoom. Default is undefined, and layer sources will not be fetched if neither this nor zoom are defined.
resolutions	Array.<number> | undefined	Resolutions to determine the resolution constraint. If set the maxResolution, maxZoom and zoomFactor options are ignored.
rotation	number | undefined	The initial rotation for the view in radians (positive rotation clockwise). Default is 0.
zoom	number | undefined	Only used if resolution is not defined. Zoom level used to calculate the initial resolution for the view. The initial resolution is determined using the ol.View2D#constrainResolution method.
zoomFactor	number | undefined	The zoom factor used to determine the resolution constraint. Used together with maxResolution and maxZoom. Default is 2.

Source:

• objectliterals.jsdoc, line 17