OpenLayers
Docs
Examples
API
Code
ol
Typedefs
AttributionLike
CanvasFunctionType
Color
ColorLike
Coordinate
CoordinateFormatType
DragBoxEndConditionType
DrawGeometryFunctionType
EventsConditionType
EventsKey
Extent
FeatureLoader
FeatureStyleFunction
FeatureUrlFunction
ImageLoadFunctionType
LoadingStrategy
OverlayPositioning
Pixel
ProjectionLike
RasterOperation
RenderOrderFunction
SelectFilterFunction
Size
StyleFunction
StyleGeometryFunction
TileCoord
TileLoadFunctionType
TileUrlFunctionType
TransformFunction
WFSFeatureCollectionMetadata
WFSTransactionResponse
Methods
inherits
ol.AssertionError
Members
code
ol.Attribution
Methods
getHTML
ol.Collection
Methods
changed
clear
dispatchEvent
extend
forEach
get
getArray
getKeys
getLength
getProperties
getRevision
insertAt
item
on
once
pop
push
remove
removeAt
set
setAt
setProperties
un
unset
Fires
add
change
change:length
propertychange
remove
ol.Collection.Event
Members
element
target
type
Methods
preventDefault
stopPropagation
ol.DeviceOrientation
Methods
changed
dispatchEvent
get
getAlpha
getBeta
getGamma
getHeading
getKeys
getProperties
getRevision
getTracking
on
once
set
setProperties
setTracking
un
unset
Fires
change
change:alpha
change:beta
change:gamma
change:heading
change:tracking
propertychange
ol.Disposable
ol.Feature
Methods
changed
clone
dispatchEvent
get
getGeometry
getGeometryName
getId
getKeys
getProperties
getRevision
getStyle
getStyleFunction
on
once
set
setGeometry
setGeometryName
setId
setProperties
setStyle
un
unset
Fires
change
change:geometry
propertychange
ol.Geolocation
Methods
changed
dispatchEvent
get
getAccuracy
getAccuracyGeometry
getAltitude
getAltitudeAccuracy
getHeading
getKeys
getPosition
getProjection
getProperties
getRevision
getSpeed
getTracking
getTrackingOptions
on
once
set
setProjection
setProperties
setTracking
setTrackingOptions
un
unset
Fires
change
change:accuracy
change:accuracyGeometry
change:altitude
change:altitudeAccuracy
change:heading
change:position
change:projection
change:speed
change:tracking
change:trackingOptions
error
propertychange
ol.Graticule
Methods
getMap
getMeridians
getParallels
setMap
ol.Image
Methods
getImage
load
ol.ImageBase
ol.ImageTile
Methods
getImage
getTileCoord
load
ol.Kinetic
ol.Map
Methods
addControl
addInteraction
addLayer
addOverlay
changed
dispatchEvent
forEachFeatureAtPixel
forEachLayerAtPixel
get
getControls
getCoordinateFromPixel
getEventCoordinate
getEventPixel
getInteractions
getKeys
getLayerGroup
getLayers
getOverlayById
getOverlays
getPixelFromCoordinate
getProperties
getRevision
getSize
getTarget
getTargetElement
getView
getViewport
hasFeatureAtPixel
on
once
removeControl
removeInteraction
removeLayer
removeOverlay
render
renderSync
set
setLayerGroup
setProperties
setSize
setTarget
setView
un
unset
updateSize
Fires
change
change:layerGroup
change:size
change:target
change:view
click
dblclick
moveend
movestart
pointerdrag
pointermove
postcompose
postrender
precompose
propertychange
singleclick
ol.MapBrowserEvent
Members
coordinate
dragging
frameState
map
originalEvent
pixel
target
type
Methods
preventDefault
stopPropagation
ol.MapEvent
Members
frameState
map
target
type
Methods
preventDefault
stopPropagation
ol.Object
Methods
changed
dispatchEvent
get
getKeys
getProperties
getRevision
on
once
set
setProperties
un
unset
Fires
change
propertychange
ol.Object.Event
Members
key
oldValue
target
type
Methods
preventDefault
stopPropagation
ol.Observable
Methods
unByKey
changed
dispatchEvent
getRevision
on
once
un
Fires
change
ol.Overlay
Methods
changed
dispatchEvent
get
getElement
getId
getKeys
getMap
getOffset
getPosition
getPositioning
getProperties
getRevision
on
once
set
setElement
setMap
setOffset
setPosition
setPositioning
setProperties
un
unset
Fires
change
change:element
change:map
change:offset
change:position
change:positioning
propertychange
ol.Sphere
Methods
geodesicArea
haversineDistance
ol.Tile
Methods
getTileCoord
load
ol.VectorTile
Methods
getFeatures
getFormat
getProjection
getTileCoord
load
setFeatures
setLoader
setProjection
ol.View
Methods
animate
calculateExtent
cancelAnimations
centerOn
changed
constrainCenter
constrainResolution
constrainRotation
dispatchEvent
fit
get
getAnimating
getCenter
getInteracting
getKeys
getMaxResolution
getMaxZoom
getMinResolution
getMinZoom
getProjection
getProperties
getResolution
getResolutionForExtent
getResolutions
getRevision
getRotation
getZoom
getZoomForResolution
on
once
rotate
set
setCenter
setMaxZoom
setMinZoom
setProperties
setResolution
setRotation
setZoom
un
unset
Fires
change
change:center
change:resolution
change:rotation
propertychange
ol.color
Methods
asArray
asString
ol.colorlike
Methods
asColorLike
ol.control
Typedefs
ScaleLineUnits
Methods
defaults
ol.control.Attribution
Methods
render
changed
dispatchEvent
get
getCollapsed
getCollapsible
getKeys
getMap
getProperties
getRevision
on
once
set
setCollapsed
setCollapsible
setMap
setProperties
setTarget
un
unset
Fires
change
propertychange
ol.control.Control
Methods
changed
dispatchEvent
get
getKeys
getMap
getProperties
getRevision
on
once
set
setMap
setProperties
setTarget
un
unset
Fires
change
propertychange
ol.control.FullScreen
Methods
changed
dispatchEvent
get
getKeys
getMap
getProperties
getRevision
on
once
set
setMap
setProperties
setTarget
un
unset
Fires
change
propertychange
ol.control.MousePosition
Methods
render
changed
dispatchEvent
get
getCoordinateFormat
getKeys
getMap
getProjection
getProperties
getRevision
on
once
set
setCoordinateFormat
setMap
setProjection
setProperties
setTarget
un
unset
Fires
change
change:coordinateFormat
change:projection
propertychange
ol.control.OverviewMap
Methods
render
changed
dispatchEvent
get
getCollapsed
getCollapsible
getKeys
getMap
getOverviewMap
getProperties
getRevision
on
once
set
setCollapsed
setCollapsible
setMap
setProperties
setTarget
un
unset
Fires
change
propertychange
ol.control.Rotate
Methods
render
changed
dispatchEvent
get
getKeys
getMap
getProperties
getRevision
on
once
set
setMap
setProperties
setTarget
un
unset
Fires
change
propertychange
ol.control.ScaleLine
Methods
render
changed
dispatchEvent
get
getKeys
getMap
getProperties
getRevision
getUnits
on
once
set
setMap
setProperties
setTarget
setUnits
un
unset
Fires
change
change:units
propertychange
ol.control.Zoom
Methods
changed
dispatchEvent
get
getKeys
getMap
getProperties
getRevision
on
once
set
setMap
setProperties
setTarget
un
unset
Fires
change
propertychange
ol.control.ZoomSlider
Methods
render
changed
dispatchEvent
get
getKeys
getMap
getProperties
getRevision
on
once
set
setMap
setProperties
setTarget
un
unset
Fires
change
propertychange
ol.control.ZoomToExtent
Methods
changed
dispatchEvent
get
getKeys
getMap
getProperties
getRevision
on
once
set
setMap
setProperties
setTarget
un
unset
Fires
change
propertychange
ol.coordinate
Methods
add
createStringXY
format
rotate
toStringHDMS
toStringXY
ol.easing
Methods
easeIn
easeOut
inAndOut
linear
upAndDown
ol.events
ol.events.Event
Members
target
type
Methods
preventDefault
stopPropagation
ol.events.EventTarget
ol.events.condition
Methods
altKeyOnly
altShiftKeysOnly
always
click
doubleClick
mouseOnly
never
noModifierKeys
platformModifierKeyOnly
pointerMove
primaryAction
shiftKeyOnly
singleClick
targetNotEditable
ol.extent
Methods
applyTransform
boundingExtent
buffer
containsCoordinate
containsExtent
containsXY
createEmpty
equals
extend
getArea
getBottomLeft
getBottomRight
getCenter
getHeight
getIntersection
getSize
getTopLeft
getTopRight
getWidth
intersects
isEmpty
ol.featureloader
Methods
xhr
ol.format
Typedefs
IGCZ
ol.format.EsriJSON
Methods
readFeature
readFeatures
readGeometry
readProjection
writeFeature
writeFeatureObject
writeFeatures
writeFeaturesObject
writeGeometry
writeGeometryObject
ol.format.Feature
ol.format.GML
Methods
readFeatures
writeFeatures
writeFeaturesNode
ol.format.GML2
Methods
readFeatures
ol.format.GML3
Methods
readFeatures
writeFeatures
writeFeaturesNode
writeGeometryNode
ol.format.GMLBase
Methods
readFeatures
ol.format.GPX
Methods
readFeature
readFeatures
readProjection
writeFeatures
writeFeaturesNode
ol.format.GeoJSON
Methods
readFeature
readFeatures
readGeometry
readProjection
writeFeature
writeFeatureObject
writeFeatures
writeFeaturesObject
writeGeometry
writeGeometryObject
ol.format.IGC
Methods
readFeature
readFeatures
readProjection
ol.format.JSONFeature
ol.format.KML
Methods
readFeature
readFeatures
readName
readNetworkLinks
readProjection
readRegion
readRegionFromNode
writeFeatures
writeFeaturesNode
ol.format.MVT
Methods
readFeatures
readProjection
setLayers
ol.format.OSMXML
Methods
readFeatures
readProjection
ol.format.Polyline
Methods
decodeDeltas
decodeFloats
encodeDeltas
encodeFloats
readFeature
readFeatures
readGeometry
readProjection
writeGeometry
ol.format.TextFeature
ol.format.TopoJSON
Members
readProjection
Methods
readFeatures
ol.format.WFS
Methods
writeFilter
readFeatureCollectionMetadata
readFeatures
readProjection
readTransactionResponse
writeGetFeature
writeTransaction
ol.format.WKT
Methods
readFeature
readFeatures
readGeometry
writeFeature
writeFeatures
writeGeometry
ol.format.WMSCapabilities
Methods
read
ol.format.WMSGetFeatureInfo
Methods
readFeatures
ol.format.WMTSCapabilities
Methods
read
ol.format.XML
ol.format.XMLFeature
ol.format.filter
Methods
and
bbox
between
during
equalTo
greaterThan
greaterThanOrEqualTo
intersects
isNull
lessThan
lessThanOrEqualTo
like
not
notEqualTo
or
within
ol.format.filter.And
ol.format.filter.Bbox
ol.format.filter.Comparison
ol.format.filter.ComparisonBinary
ol.format.filter.During
ol.format.filter.EqualTo
ol.format.filter.Filter
ol.format.filter.GreaterThan
ol.format.filter.GreaterThanOrEqualTo
ol.format.filter.Intersects
ol.format.filter.IsBetween
ol.format.filter.IsLike
ol.format.filter.IsNull
ol.format.filter.LessThan
ol.format.filter.LessThanOrEqualTo
ol.format.filter.LogicalNary
ol.format.filter.Not
ol.format.filter.NotEqualTo
ol.format.filter.Or
ol.format.filter.Spatial
ol.format.filter.Within
ol.geom
Typedefs
GeometryLayout
GeometryType
ol.geom.Circle
Methods
applyTransform
changed
clone
dispatchEvent
get
getCenter
getClosestPoint
getExtent
getFirstCoordinate
getKeys
getLastCoordinate
getLayout
getProperties
getRadius
getRevision
getType
intersectsCoordinate
intersectsExtent
on
once
rotate
scale
set
setCenter
setCenterAndRadius
setProperties
setRadius
simplify
transform
translate
un
unset
Fires
change
propertychange
ol.geom.Geometry
Methods
changed
dispatchEvent
get
getClosestPoint
getExtent
getKeys
getProperties
getRevision
intersectsCoordinate
on
once
rotate
scale
set
setProperties
simplify
transform
un
unset
Fires
change
propertychange
ol.geom.GeometryCollection
Methods
applyTransform
changed
clone
dispatchEvent
get
getClosestPoint
getExtent
getGeometries
getKeys
getProperties
getRevision
getType
intersectsCoordinate
intersectsExtent
on
once
rotate
scale
set
setGeometries
setProperties
simplify
transform
translate
un
unset
Fires
change
propertychange
ol.geom.LineString
Methods
appendCoordinate
applyTransform
changed
clone
dispatchEvent
forEachSegment
get
getClosestPoint
getCoordinateAt
getCoordinateAtM
getCoordinates
getExtent
getFirstCoordinate
getKeys
getLastCoordinate
getLayout
getLength
getProperties
getRevision
getType
intersectsCoordinate
intersectsExtent
on
once
rotate
scale
set
setCoordinates
setProperties
simplify
transform
translate
un
unset
Fires
change
propertychange
ol.geom.LinearRing
Methods
applyTransform
changed
clone
dispatchEvent
get
getArea
getClosestPoint
getCoordinates
getExtent
getFirstCoordinate
getKeys
getLastCoordinate
getLayout
getProperties
getRevision
getType
intersectsCoordinate
on
once
rotate
scale
set
setCoordinates
setProperties
simplify
transform
translate
un
unset
Fires
change
propertychange
ol.geom.MultiLineString
Methods
appendLineString
applyTransform
changed
clone
dispatchEvent
get
getClosestPoint
getCoordinateAtM
getCoordinates
getExtent
getFirstCoordinate
getKeys
getLastCoordinate
getLayout
getLineString
getLineStrings
getProperties
getRevision
getType
intersectsCoordinate
intersectsExtent
on
once
rotate
scale
set
setCoordinates
setProperties
simplify
transform
translate
un
unset
Fires
change
propertychange
ol.geom.MultiPoint
Methods
appendPoint
applyTransform
changed
clone
dispatchEvent
get
getClosestPoint
getCoordinates
getExtent
getFirstCoordinate
getKeys
getLastCoordinate
getLayout
getPoint
getPoints
getProperties
getRevision
getType
intersectsCoordinate
intersectsExtent
on
once
rotate
scale
set
setCoordinates
setProperties
simplify
transform
translate
un
unset
Fires
change
propertychange
ol.geom.MultiPolygon
Methods
appendPolygon
applyTransform
changed
clone
dispatchEvent
get
getArea
getClosestPoint
getCoordinates
getExtent
getFirstCoordinate
getInteriorPoints
getKeys
getLastCoordinate
getLayout
getPolygon
getPolygons
getProperties
getRevision
getType
intersectsCoordinate
intersectsExtent
on
once
rotate
scale
set
setCoordinates
setProperties
simplify
transform
translate
un
unset
Fires
change
propertychange
ol.geom.Point
Methods
applyTransform
changed
clone
dispatchEvent
get
getClosestPoint
getCoordinates
getExtent
getFirstCoordinate
getKeys
getLastCoordinate
getLayout
getProperties
getRevision
getType
intersectsCoordinate
intersectsExtent
on
once
rotate
scale
set
setCoordinates
setProperties
simplify
transform
translate
un
unset
Fires
change
propertychange
ol.geom.Polygon
Methods
circular
fromCircle
fromExtent
appendLinearRing
applyTransform
changed
clone
dispatchEvent
get
getArea
getClosestPoint
getCoordinates
getExtent
getFirstCoordinate
getInteriorPoint
getKeys
getLastCoordinate
getLayout
getLinearRing
getLinearRingCount
getLinearRings
getProperties
getRevision
getType
intersectsCoordinate
intersectsExtent
on
once
rotate
scale
set
setCoordinates
setProperties
simplify
transform
translate
un
unset
Fires
change
propertychange
ol.geom.SimpleGeometry
Methods
applyTransform
changed
dispatchEvent
get
getClosestPoint
getExtent
getFirstCoordinate
getKeys
getLastCoordinate
getLayout
getProperties
getRevision
intersectsCoordinate
on
once
rotate
scale
set
setProperties
simplify
transform
translate
un
unset
Fires
change
propertychange
ol.has
Members
CANVAS
DEVICE_ORIENTATION
DEVICE_PIXEL_RATIO
GEOLOCATION
TOUCH
WEBGL
ol.interaction
Methods
defaults
ol.interaction.DoubleClickZoom
Methods
handleEvent
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setProperties
un
unset
Fires
change
change:active
propertychange
ol.interaction.DragAndDrop
Members
handleEvent
Methods
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setProperties
un
unset
Fires
addfeatures
change
change:active
propertychange
ol.interaction.DragAndDrop.Event
Members
features
file
projection
target
type
Methods
preventDefault
stopPropagation
ol.interaction.DragBox
Methods
changed
dispatchEvent
get
getActive
getGeometry
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setProperties
un
unset
Fires
boxdrag
boxend
boxstart
change
change:active
propertychange
ol.interaction.DragBox.Event
Members
coordinate
mapBrowserEvent
target
type
Methods
preventDefault
stopPropagation
ol.interaction.DragPan
Methods
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setProperties
un
unset
Fires
change
change:active
propertychange
ol.interaction.DragRotate
Methods
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setProperties
un
unset
Fires
change
change:active
propertychange
ol.interaction.DragRotateAndZoom
Methods
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setProperties
un
unset
Fires
change
change:active
propertychange
ol.interaction.DragZoom
Methods
changed
dispatchEvent
get
getActive
getGeometry
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setProperties
un
unset
Fires
boxdrag
boxend
boxstart
change
change:active
propertychange
ol.interaction.Draw
Methods
createBox
createRegularPolygon
handleEvent
changed
dispatchEvent
extend
finishDrawing
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
removeLastPoint
set
setActive
setProperties
un
unset
Fires
change
change:active
drawend
drawstart
propertychange
ol.interaction.Draw.Event
Members
feature
target
type
Methods
preventDefault
stopPropagation
ol.interaction.Extent
Methods
changed
dispatchEvent
get
getActive
getExtent
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setExtent
setProperties
un
unset
Fires
Event
change
change:active
propertychange
ol.interaction.Extent.Event
Members
extent_
target
type
Methods
preventDefault
stopPropagation
ol.interaction.Interaction
Methods
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setProperties
un
unset
Fires
change
change:active
propertychange
ol.interaction.KeyboardPan
Methods
handleEvent
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setProperties
un
unset
Fires
change
change:active
propertychange
ol.interaction.KeyboardZoom
Methods
handleEvent
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setProperties
un
unset
Fires
change
change:active
propertychange
ol.interaction.Modify
Methods
handleEvent
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
removePoint
set
setActive
setProperties
un
unset
Fires
change
change:active
modifyend
modifystart
propertychange
ol.interaction.Modify.Event
Members
features
mapBrowserEvent
target
type
Methods
preventDefault
stopPropagation
ol.interaction.MouseWheelZoom
Methods
handleEvent
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setMouseAnchor
setProperties
un
unset
Fires
change
change:active
propertychange
ol.interaction.PinchRotate
Methods
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setProperties
un
unset
Fires
change
change:active
propertychange
ol.interaction.PinchZoom
Methods
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setProperties
un
unset
Fires
change
change:active
propertychange
ol.interaction.Pointer
Methods
handleEvent
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setProperties
un
unset
Fires
change
change:active
propertychange
ol.interaction.Select
Methods
handleEvent
changed
dispatchEvent
get
getActive
getFeatures
getHitTolerance
getKeys
getLayer
getMap
getProperties
getRevision
on
once
set
setActive
setHitTolerance
setMap
setProperties
un
unset
Fires
change
change:active
propertychange
select
ol.interaction.Select.Event
Members
deselected
mapBrowserEvent
selected
target
type
Methods
preventDefault
stopPropagation
ol.interaction.Snap
Methods
addFeature
changed
dispatchEvent
get
getActive
getKeys
getMap
getProperties
getRevision
on
once
removeFeature
set
setActive
setProperties
un
unset
Fires
change
change:active
propertychange
ol.interaction.Translate
Methods
changed
dispatchEvent
get
getActive
getHitTolerance
getKeys
getMap
getProperties
getRevision
on
once
set
setActive
setHitTolerance
setProperties
un
unset
Fires
change
change:active
propertychange
translateend
translatestart
translating
ol.interaction.Translate.Event
Members
coordinate
features
target
type
Methods
preventDefault
stopPropagation
ol.layer
Typedefs
VectorTileRenderType
ol.layer.Base
Methods
changed
dispatchEvent
get
getExtent
getKeys
getMaxResolution
getMinResolution
getOpacity
getProperties
getRevision
getVisible
getZIndex
on
once
set
setExtent
setMaxResolution
setMinResolution
setOpacity
setProperties
setVisible
setZIndex
un
unset
Fires
change
change:extent
change:maxResolution
change:minResolution
change:opacity
change:visible
change:zIndex
propertychange
ol.layer.Group
Methods
changed
dispatchEvent
get
getExtent
getKeys
getLayers
getMaxResolution
getMinResolution
getOpacity
getProperties
getRevision
getVisible
getZIndex
on
once
set
setExtent
setLayers
setMaxResolution
setMinResolution
setOpacity
setProperties
setVisible
setZIndex
un
unset
Fires
change
change:extent
change:layers
change:maxResolution
change:minResolution
change:opacity
change:visible
change:zIndex
propertychange
ol.layer.Heatmap
Methods
changed
dispatchEvent
get
getBlur
getExtent
getGradient
getKeys
getMaxResolution
getMinResolution
getOpacity
getProperties
getRadius
getRevision
getSource
getStyle
getStyleFunction
getVisible
getZIndex
on
once
set
setBlur
setExtent
setGradient
setMap
setMaxResolution
setMinResolution
setOpacity
setProperties
setRadius
setSource
setStyle
setVisible
setZIndex
un
unset
Fires
change
change:blur
change:extent
change:gradient
change:maxResolution
change:minResolution
change:opacity
change:radius
change:source
change:visible
change:zIndex
postcompose
precompose
propertychange
render
ol.layer.Image
Methods
changed
dispatchEvent
get
getExtent
getKeys
getMaxResolution
getMinResolution
getOpacity
getProperties
getRevision
getSource
getVisible
getZIndex
on
once
set
setExtent
setMap
setMaxResolution
setMinResolution
setOpacity
setProperties
setSource
setVisible
setZIndex
un
unset
Fires
change
change:extent
change:maxResolution
change:minResolution
change:opacity
change:source
change:visible
change:zIndex
postcompose
precompose
propertychange
render
ol.layer.Layer
Methods
changed
dispatchEvent
get
getExtent
getKeys
getMaxResolution
getMinResolution
getOpacity
getProperties
getRevision
getSource
getVisible
getZIndex
on
once
set
setExtent
setMap
setMaxResolution
setMinResolution
setOpacity
setProperties
setSource
setVisible
setZIndex
un
unset
Fires
change
change:extent
change:maxResolution
change:minResolution
change:opacity
change:source
change:visible
change:zIndex
postcompose
precompose
propertychange
render
ol.layer.Tile
Methods
changed
dispatchEvent
get
getExtent
getKeys
getMaxResolution
getMinResolution
getOpacity
getPreload
getProperties
getRevision
getSource
getUseInterimTilesOnError
getVisible
getZIndex
on
once
set
setExtent
setMap
setMaxResolution
setMinResolution
setOpacity
setPreload
setProperties
setSource
setUseInterimTilesOnError
setVisible
setZIndex
un
unset
Fires
change
change:extent
change:maxResolution
change:minResolution
change:opacity
change:preload
change:source
change:useInterimTilesOnError
change:visible
change:zIndex
postcompose
precompose
propertychange
render
ol.layer.Vector
Methods
changed
dispatchEvent
get
getExtent
getKeys
getMaxResolution
getMinResolution
getOpacity
getProperties
getRevision
getSource
getStyle
getStyleFunction
getVisible
getZIndex
on
once
set
setExtent
setMap
setMaxResolution
setMinResolution
setOpacity
setProperties
setSource
setStyle
setVisible
setZIndex
un
unset
Fires
change
change:extent
change:maxResolution
change:minResolution
change:opacity
change:source
change:visible
change:zIndex
postcompose
precompose
propertychange
render
ol.layer.VectorTile
Methods
changed
dispatchEvent
get
getExtent
getKeys
getMaxResolution
getMinResolution
getOpacity
getPreload
getProperties
getRevision
getSource
getStyle
getStyleFunction
getUseInterimTilesOnError
getVisible
getZIndex
on
once
set
setExtent
setMap
setMaxResolution
setMinResolution
setOpacity
setPreload
setProperties
setSource
setStyle
setUseInterimTilesOnError
setVisible
setZIndex
un
unset
Fires
change
change:extent
change:maxResolution
change:minResolution
change:opacity
change:preload
change:source
change:useInterimTilesOnError
change:visible
change:zIndex
postcompose
precompose
propertychange
render
ol.loadingstrategy
Methods
all
bbox
tile
ol.proj
Members
METERS_PER_UNIT
Typedefs
Units
Methods
addCoordinateTransforms
addEquivalentProjections
addProjection
equivalent
fromLonLat
get
getPointResolution
getTransform
setProj4
toLonLat
transform
transformExtent
ol.proj.Projection
Methods
getCode
getExtent
getMetersPerUnit
getUnits
getWorldExtent
isGlobal
setExtent
setGetPointResolution
setGlobal
setWorldExtent
ol.render
Methods
toContext
ol.render.Event
Members
context
frameState
glContext
target
type
vectorContext
Methods
preventDefault
stopPropagation
ol.render.Feature
Methods
get
getExtent
getGeometry
getId
getProperties
getType
ol.render.VectorContext
ol.render.canvas
ol.render.canvas.Immediate
Methods
drawCircle
drawFeature
drawGeometry
setStyle
ol.render.webgl
ol.render.webgl.Immediate
Methods
drawFeature
drawGeometry
setStyle
ol.renderer
Typedefs
Type
ol.source
Typedefs
RasterOperationType
State
WMSServerType
WMTSRequestEncoding
ol.source.BingMaps
Members
TOS_ATTRIBUTION
Methods
changed
dispatchEvent
get
getApiKey
getAttributions
getImagerySet
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getTileGrid
getTileLoadFunction
getTileUrlFunction
getUrls
on
once
refresh
set
setAttributions
setProperties
setRenderReprojectionEdges
setTileGridForProjection
setTileLoadFunction
setTileUrlFunction
setUrl
setUrls
un
unset
Fires
change
propertychange
tileloadend
tileloaderror
tileloadstart
ol.source.CartoDB
Methods
changed
dispatchEvent
get
getAttributions
getConfig
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getTileGrid
getTileLoadFunction
getTileUrlFunction
getUrls
on
once
refresh
set
setAttributions
setConfig
setProperties
setRenderReprojectionEdges
setTileGridForProjection
setTileLoadFunction
setTileUrlFunction
setUrl
setUrls
un
unset
updateConfig
Fires
change
propertychange
tileloadend
tileloaderror
tileloadstart
ol.source.Cluster
Methods
addFeature
addFeatures
changed
clear
dispatchEvent
forEachFeature
forEachFeatureInExtent
forEachFeatureIntersectingExtent
get
getAttributions
getClosestFeatureToCoordinate
getDistance
getExtent
getFeatureById
getFeatures
getFeaturesAtCoordinate
getFeaturesCollection
getFeaturesInExtent
getFormat
getKeys
getLogo
getProjection
getProperties
getRevision
getSource
getState
getUrl
on
once
refresh
removeFeature
set
setAttributions
setDistance
setProperties
un
unset
Fires
addfeature
change
changefeature
clear
propertychange
removefeature
ol.source.Image
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
on
once
refresh
set
setAttributions
setProperties
un
unset
Fires
change
propertychange
ol.source.Image.Event
Members
image
target
type
Methods
preventDefault
stopPropagation
ol.source.ImageArcGISRest
Methods
changed
dispatchEvent
get
getAttributions
getImageLoadFunction
getKeys
getLogo
getParams
getProjection
getProperties
getRevision
getState
getUrl
on
once
refresh
set
setAttributions
setImageLoadFunction
setProperties
setUrl
un
unset
updateParams
Fires
change
imageloadend
imageloaderror
imageloadstart
propertychange
ol.source.ImageCanvas
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
on
once
refresh
set
setAttributions
setProperties
un
unset
Fires
change
propertychange
ol.source.ImageMapGuide
Methods
changed
dispatchEvent
get
getAttributions
getImageLoadFunction
getKeys
getLogo
getParams
getProjection
getProperties
getRevision
getState
on
once
refresh
set
setAttributions
setImageLoadFunction
setProperties
un
unset
updateParams
Fires
change
imageloadend
imageloaderror
imageloadstart
propertychange
ol.source.ImageStatic
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
on
once
refresh
set
setAttributions
setProperties
un
unset
Fires
change
propertychange
ol.source.ImageVector
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getSource
getState
getStyle
getStyleFunction
on
once
refresh
set
setAttributions
setProperties
setStyle
un
unset
Fires
change
propertychange
ol.source.ImageWMS
Methods
changed
dispatchEvent
get
getAttributions
getGetFeatureInfoUrl
getImageLoadFunction
getKeys
getLogo
getParams
getProjection
getProperties
getRevision
getState
getUrl
on
once
refresh
set
setAttributions
setImageLoadFunction
setProperties
setUrl
un
unset
updateParams
Fires
change
imageloadend
imageloaderror
imageloadstart
propertychange
ol.source.OSM
Members
ATTRIBUTION
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getTileGrid
getTileLoadFunction
getTileUrlFunction
getUrls
on
once
refresh
set
setAttributions
setProperties
setRenderReprojectionEdges
setTileGridForProjection
setTileLoadFunction
setTileUrlFunction
setUrl
setUrls
un
unset
Fires
change
propertychange
tileloadend
tileloaderror
tileloadstart
ol.source.Raster
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
on
once
refresh
set
setAttributions
setOperation
setProperties
un
unset
Fires
afteroperations
beforeoperations
change
propertychange
ol.source.Raster.Event
Members
data
extent
resolution
target
type
Methods
preventDefault
stopPropagation
ol.source.Source
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
on
once
refresh
set
setAttributions
setProperties
un
unset
Fires
change
propertychange
ol.source.Stamen
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getTileGrid
getTileLoadFunction
getTileUrlFunction
getUrls
on
once
refresh
set
setAttributions
setProperties
setRenderReprojectionEdges
setTileGridForProjection
setTileLoadFunction
setTileUrlFunction
setUrl
setUrls
un
unset
Fires
change
propertychange
tileloadend
tileloaderror
tileloadstart
ol.source.Tile
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getTileGrid
on
once
refresh
set
setAttributions
setProperties
un
unset
Fires
change
propertychange
ol.source.Tile.Event
Members
target
tile
type
Methods
preventDefault
stopPropagation
ol.source.TileArcGISRest
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getParams
getProjection
getProperties
getRevision
getState
getTileGrid
getTileLoadFunction
getTileUrlFunction
getUrls
on
once
refresh
set
setAttributions
setProperties
setRenderReprojectionEdges
setTileGridForProjection
setTileLoadFunction
setTileUrlFunction
setUrl
setUrls
un
unset
updateParams
Fires
change
propertychange
tileloadend
tileloaderror
tileloadstart
ol.source.TileDebug
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getTileGrid
on
once
refresh
set
setAttributions
setProperties
un
unset
Fires
change
propertychange
ol.source.TileImage
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getTileGrid
getTileLoadFunction
getTileUrlFunction
getUrls
on
once
refresh
set
setAttributions
setProperties
setRenderReprojectionEdges
setTileGridForProjection
setTileLoadFunction
setTileUrlFunction
setUrl
setUrls
un
unset
Fires
change
propertychange
tileloadend
tileloaderror
tileloadstart
ol.source.TileJSON
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getTileGrid
getTileJSON
getTileLoadFunction
getTileUrlFunction
getUrls
on
once
refresh
set
setAttributions
setProperties
setRenderReprojectionEdges
setTileGridForProjection
setTileLoadFunction
setTileUrlFunction
setUrl
setUrls
un
unset
Fires
change
propertychange
tileloadend
tileloaderror
tileloadstart
ol.source.TileUTFGrid
Methods
changed
dispatchEvent
forDataAtCoordinateAndResolution
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getTemplate
getTileGrid
on
once
refresh
set
setAttributions
setProperties
un
unset
Fires
change
propertychange
ol.source.TileWMS
Methods
changed
dispatchEvent
get
getAttributions
getGetFeatureInfoUrl
getKeys
getLogo
getParams
getProjection
getProperties
getRevision
getState
getTileGrid
getTileLoadFunction
getTileUrlFunction
getUrls
on
once
refresh
set
setAttributions
setProperties
setRenderReprojectionEdges
setTileGridForProjection
setTileLoadFunction
setTileUrlFunction
setUrl
setUrls
un
unset
updateParams
Fires
change
propertychange
tileloadend
tileloaderror
tileloadstart
ol.source.UrlTile
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getTileGrid
getTileLoadFunction
getTileUrlFunction
getUrls
on
once
refresh
set
setAttributions
setProperties
setTileLoadFunction
setTileUrlFunction
setUrl
setUrls
un
unset
Fires
tileloadstart
tileloadend
tileloaderror
propertychange
change
ol.source.Vector
Methods
addFeature
addFeatures
changed
clear
dispatchEvent
forEachFeature
forEachFeatureInExtent
forEachFeatureIntersectingExtent
get
getAttributions
getClosestFeatureToCoordinate
getExtent
getFeatureById
getFeatures
getFeaturesAtCoordinate
getFeaturesCollection
getFeaturesInExtent
getFormat
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getUrl
on
once
refresh
removeFeature
set
setAttributions
setProperties
un
unset
Fires
addfeature
change
changefeature
clear
propertychange
removefeature
ol.source.Vector.Event
Members
feature
target
type
Methods
preventDefault
stopPropagation
ol.source.VectorTile
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getTileGrid
getTileLoadFunction
getTileUrlFunction
getUrls
on
once
refresh
set
setAttributions
setProperties
setTileLoadFunction
setTileUrlFunction
setUrl
setUrls
un
unset
Fires
change
propertychange
tileloadend
tileloaderror
tileloadstart
ol.source.WMTS
Methods
optionsFromCapabilities
changed
dispatchEvent
get
getAttributions
getDimensions
getFormat
getKeys
getLayer
getLogo
getMatrixSet
getProjection
getProperties
getRequestEncoding
getRevision
getState
getStyle
getTileGrid
getTileLoadFunction
getTileUrlFunction
getUrls
getVersion
on
once
refresh
set
setAttributions
setProperties
setRenderReprojectionEdges
setTileGridForProjection
setTileLoadFunction
setTileUrlFunction
setUrl
setUrls
un
unset
updateDimensions
Fires
change
propertychange
tileloadend
tileloaderror
tileloadstart
ol.source.XYZ
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getTileGrid
getTileLoadFunction
getTileUrlFunction
getUrls
on
once
refresh
set
setAttributions
setProperties
setRenderReprojectionEdges
setTileGridForProjection
setTileLoadFunction
setTileUrlFunction
setUrl
setUrls
un
unset
Fires
change
propertychange
tileloadend
tileloaderror
tileloadstart
ol.source.Zoomify
Methods
changed
dispatchEvent
get
getAttributions
getKeys
getLogo
getProjection
getProperties
getRevision
getState
getTileGrid
getTileLoadFunction
getTileUrlFunction
getUrls
on
once
refresh
set
setAttributions
setProperties
setRenderReprojectionEdges
setTileGridForProjection
setTileLoadFunction
setTileUrlFunction
setUrl
setUrls
un
unset
Fires
change
propertychange
tileloadend
tileloaderror
tileloadstart
ol.style
Typedefs
IconAnchorUnits
IconOrigin
ol.style.AtlasManager
ol.style.Circle
Methods
clone
getAnchor
getAngle
getFill
getImage
getOpacity
getOrigin
getPoints
getRadius
getRadius2
getRotateWithView
getRotation
getScale
getSize
getSnapToPixel
getStroke
setOpacity
setRadius
setRotation
setScale
ol.style.Fill
Methods
clone
getColor
setColor
ol.style.Icon
Methods
clone
getAnchor
getColor
getImage
getOpacity
getOrigin
getRotateWithView
getRotation
getScale
getSize
getSnapToPixel
getSrc
load
setOpacity
setRotation
setScale
ol.style.Image
Methods
getOpacity
getRotateWithView
getRotation
getScale
getSnapToPixel
setOpacity
setRotation
setScale
ol.style.RegularShape
Methods
clone
getAnchor
getAngle
getFill
getImage
getOpacity
getOrigin
getPoints
getRadius
getRadius2
getRotateWithView
getRotation
getScale
getSize
getSnapToPixel
getStroke
setOpacity
setRotation
setScale
ol.style.Stroke
Methods
clone
getColor
getLineCap
getLineDash
getLineDashOffset
getLineJoin
getMiterLimit
getWidth
setColor
setLineCap
setLineDash
setLineDashOffset
setLineJoin
setMiterLimit
setWidth
ol.style.Style
Methods
clone
getFill
getGeometry
getGeometryFunction
getImage
getStroke
getText
getZIndex
setFill
setGeometry
setImage
setStroke
setText
setZIndex
ol.style.Text
Methods
clone
getFill
getFont
getOffsetX
getOffsetY
getRotateWithView
getRotation
getScale
getStroke
getText
getTextAlign
getTextBaseline
setFill
setFont
setOffsetX
setOffsetY
setRotation
setScale
setStroke
setText
setTextAlign
setTextBaseline
ol.tilegrid
Methods
createXYZ
ol.tilegrid.TileGrid
Methods
forEachTileCoord
getMaxZoom
getMinZoom
getOrigin
getResolution
getResolutions
getTileCoordExtent
getTileCoordForCoordAndResolution
getTileCoordForCoordAndZ
getTileSize
getZForResolution
ol.tilegrid.WMTS
Methods
createFromCapabilitiesMatrixSet
forEachTileCoord
getMatrixIds
getMaxZoom
getMinZoom
getOrigin
getResolution
getResolutions
getTileCoordExtent
getTileCoordForCoordAndResolution
getTileCoordForCoordAndZ
getTileSize
getZForResolution
ol.webgl.Context
Methods
getGL
useProgram
Namespace: renderer
×
This documentation is for OpenLayers v
4.2.0
. The
latest
is v
.
ol
.
renderer
Type Definitions
ol.renderer.Type
{string}
Available renderers:
'canvas'
or
'webgl'
.
OpenLayers