Class: ol.Map

ol.Map

new Map

Parameters:
Name Type Description
mapOptions ol.MapOptions Map options.
Source:
  • map.js, line 115

Extends

Members

changed

Inherited From:
Source:
  • object.js, line 166

<protected> logger :goog.debug.Logger

Source:
  • map.js, line 124

setValues

Inherited From:
Source:
  • object.js, line 275

Methods

<static> createOptionsInternal

Parameters:
Name Type Description
mapOptions ol.MapOptions Map options.
Source:
  • map.js, line 860
Returns:
Map options.
Type
ol.MapOptionsInternal

addLayer

Parameters:
Name Type Description
layer ol.layer.Layer Layer.
Source:
  • map.js, line 304

addPreRenderFunction

Parameters:
Name Type Description
preRenderFunction ol.PreRenderFunction Pre-render function.
Source:
  • map.js, line 314

addPreRenderFunctions

Parameters:
Name Type Description
preRenderFunctions Array.<ol.PreRenderFunction> Pre-render functions.
Source:
  • map.js, line 324

bindTo

Parameters:
Name Type Argument Description
key string Key.
target ol.Object Target.
targetKey string= <optional>
 (Optional) Target key.
noNotify boolean= <optional>
 (Optional) No notify.
Inherited From:
Source:
  • object.js, line 145

disposeInternal

Source:
  • map.js, line 344

freezeRendering

Freeze rendering.
Source:
  • map.js, line 353

get

Parameters:
Name Type Description
key string Key.
Inherited From:
Source:
  • object.js, line 173
Returns:
Value.
Type
*

getBackgroundColor

Source:
  • map.js, line 361
Returns:
Background color.
Type
ol.Color | undefined

getCoordinateFromPixel

Parameters:
Name Type Description
pixel ol.Pixel Pixel.
Source:
  • map.js, line 391
Returns:
Coordinate.
Type
ol.Coordinate

getInteractions

Source:
  • map.js, line 406
Returns:
Interactions.
Type
ol.Collection

getKeys

Get a list of object property names.
Inherited From:
Source:
  • object.js, line 197
Returns:
List of property names.
Type
Array.<string>

getLayers

Source:
  • map.js, line 414
Returns:
Layers.
Type
ol.Collection

getOverlayContainer

Source:
  • map.js, line 476
Returns:
The map's overlay container. Elements added to this container won't let mousedown and touchstart events through to the map, so clicks and gestures on an overlay don't trigger any MapBrowserEvent.
Type
Element

getPixelFromCoordinate

Parameters:
Name Type Description
coordinate ol.Coordinate Coordinate.
Source:
  • map.js, line 427
Returns:
Pixel.
Type
ol.Pixel

getRenderer

Source:
  • map.js, line 374
Returns:
Renderer.
Type
ol.renderer.Map

getSize

Source:
  • map.js, line 442
Returns:
Size.
Type
ol.Size | undefined

getTarget

Source:
  • map.js, line 382
Returns:
Container.
Type
Element

getTilePriority

Parameters:
Name Type Description
tile ol.Tile Tile.
tileSourceKey string Tile source key.
tileCenter ol.Coordinate Tile center.
Source:
  • map.js, line 487
Returns:
Tile priority.
Type
number

getView

Source:
  • map.js, line 454
Returns:
View.
Type
ol.View

getViewport

Source:
  • map.js, line 466
Returns:
Viewport.
Type
Element

handleBrowserEvent

Parameters:
Name Type Argument Description
browserEvent goog.events.BrowserEvent Browser event.
type string= <optional>
 (Optional) Type.
Source:
  • map.js, line 508

<protected> handleBrowserWindowResize

Source:
  • map.js, line 573

handleMapBrowserEvent

Parameters:
Name Type Description
mapBrowserEvent ol.MapBrowserEvent The event to handle.
Source:
  • map.js, line 523

<protected> handlePostRender

Source:
  • map.js, line 543

isDef

Source:
  • map.js, line 616
Returns:
Is defined.
Type
boolean

notify

Parameters:
Name Type Description
key string Key.
Inherited From:
Source:
  • object.js, line 208

removeLayer

Parameters:
Name Type Description
layer ol.layer.Layer Layer.
Source:
  • map.js, line 656
Returns:
The removed layer or undefined if the layer was not found.
Type
ol.layer.Layer | undefined

removePreRenderFunction

Parameters:
Name Type Description
preRenderFunction ol.PreRenderFunction Pre-render function.
Source:
  • map.js, line 335
Returns:
Whether the preRenderFunction has been found and removed.
Type
boolean

render

Render.
Source:
  • map.js, line 626

requestRenderFrame

Request that renderFrame_ be called some time in the future.
Source:
  • map.js, line 640

set

Parameters:
Name Type Description
key string Key.
value * Value.
Inherited From:
Source:
  • object.js, line 236

setBackgroundColor

Parameters:
Name Type Description
backgroundColor ol.Color Background color.
Source:
  • map.js, line 774

setLayers

Parameters:
Name Type Description
layers ol.Collection Layers.
Source:
  • map.js, line 786

setOptions

Parameters:
Name Type Description
options Object.<string, *> Options.
Inherited From:
Source:
  • object.js, line 258

setSize

Parameters:
Name Type Description
size ol.Size Size.
Source:
  • map.js, line 798

setView

Parameters:
Name Type Description
view ol.IView View.
Source:
  • map.js, line 810

unbind

Parameters:
Name Type Description
key string Key.
Inherited From:
Source:
  • object.js, line 281

unbindAll

Removes all bindings.
Inherited From:
Source:
  • object.js, line 298

unfreezeRendering

Unfreeze rendering.
Source:
  • map.js, line 822

withFrozenRendering

Parameters:
Name Type Argument Description
f function(this: T) Function.
obj T= <optional>
 (Optional) Object.
Source:
  • map.js, line 835