Class: ol.Map

ol.Map

new Map

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

Extends

Members

changed

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

<protected> logger :goog.debug.Logger

Source:
  • map.js, line 129

setValues

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

Methods

<static> createOptionsInternal

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

addPreRenderFunction

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

addPreRenderFunctions

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

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 135

disposeInternal

Source:
  • map.js, line 321

freezeRendering

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

get

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

getBackgroundColor

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

getControls

Source:
  • map.js, line 359
Returns:
Controls.
Type
ol.Collection

getCoordinateFromPixel

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

getInteractions

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

getLayers

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

getOverlayContainer

Source:
  • map.js, line 449
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 400
Returns:
Pixel.
Type
ol.Pixel

getSize

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

getTarget

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

getTilePriority

Parameters:
Name Type Description
tile ol.Tile Tile.
tileCenter ol.Coordinate Tile center.
tileResolution number Tile resolution.
Source:
  • map.js, line 460
Returns:
Tile priority.
Type
number | undefined

getView

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

getViewport

Source:
  • map.js, line 439
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 476

<protected> handleBrowserWindowResize

Source:
  • map.js, line 541

handleMapBrowserEvent

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

<protected> handlePostRender

Source:
  • map.js, line 525

isDef

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

notify

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

render

Render.
Source:
  • map.js, line 560

requestRenderFrame

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

set

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

setBackgroundColor

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

setLayers

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

setOptions

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

setSize

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

setView

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

unbind

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

unbindAll

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

unfreezeRendering

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

withFrozenRendering

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