Class: ol.Map

ol.Map

new Map

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

Extends

Members

changed

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

<protected> logger :goog.debug.Logger

Source:
  • map.js, line 130

setValues

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

Methods

bindTo

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

canRotate

Source:
  • map.js, line 289
Returns:
Can rotate.
Type
boolean

<static> createOptionsInternal

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

disposeInternal

Source:
  • map.js, line 298

fitExtent

Parameters:
Name Type Description
extent ol.Extent Extent.
Source:
  • map.js, line 307

fitUserExtent

Parameters:
Name Type Description
userExtent ol.Extent Extent in user projection.
Source:
  • map.js, line 323

freezeRendering

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

get

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

getBackgroundColor

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

getCenter

Source:
  • map.js, line 352
Returns:
Center.
Type
ol.Coordinate | undefined

getControls

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

getCoordinateFromPixel

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

getExtent

Source:
  • map.js, line 389
Returns:
Extent.
Type
ol.Extent | undefined

getInteractions

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

getLayers

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

getOverlayContainer

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

getProjection

Source:
  • map.js, line 437
Returns:
Projection.
Type
ol.Projection | undefined

getResolution

Source:
  • map.js, line 449
Returns:
Resolution.
Type
number | undefined

getResolutionForExtent

Parameters:
Name Type Description
extent ol.Extent Extent.
Source:
  • map.js, line 462
Returns:
Resolution.
Type
number | undefined

getRotatedExtent

Source:
  • map.js, line 477
Returns:
Rotated extent.
Type
ol.Extent

getRotation

Source:
  • map.js, line 502
Returns:
Rotation.
Type
number

getSize

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

getTarget

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

getUserCenter

Source:
  • map.js, line 526
Returns:
Center in user projection.
Type
ol.Coordinate | undefined

getUserExtent

Source:
  • map.js, line 539
Returns:
Extent in user projection.
Type
ol.Extent | undefined

getUserProjection

Source:
  • map.js, line 552
Returns:
Projection.
Type
ol.Projection | undefined

getViewport

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

handleBrowserEvent

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

<protected> handleBrowserWindowResize

Source:
  • map.js, line 649

handleMapBrowserEvent

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

<protected> handleProjectionChanged

Source:
  • map.js, line 633

<protected> handleUserProjectionChanged

Source:
  • map.js, line 641

isAnimating

Source:
  • map.js, line 658
Returns:
Is animating.
Type
boolean

isDef

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

notify

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

onAnimationFrame

Source:
  • map.js, line 676

render

Render.
Source:
  • map.js, line 706

rotate

Parameters:
Name Type Description
rotation number | undefined Rotation.
delta number Delta.
Source:
  • map.js, line 745

set

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

setBackgroundColor

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

setCenter

Parameters:
Name Type Description
center ol.Coordinate | undefined Center.
Source:
  • map.js, line 766

setLayers

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

setOptions

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

setProjection

Parameters:
Name Type Description
projection ol.Projection Projection.
Source:
  • map.js, line 790

setResolution

Parameters:
Name Type Description
resolution number | undefined Resolution.
Source:
  • map.js, line 802

setRotation

Parameters:
Name Type Description
rotation number | undefined Rotation.
Source:
  • map.js, line 814

setSize

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

setUserCenter

Parameters:
Name Type Description
userCenter ol.Coordinate Center in user projection.
Source:
  • map.js, line 838

setUserProjection

Parameters:
Name Type Description
userProjection ol.Projection User projection.
Source:
  • map.js, line 850

startAnimating

Start animating.
Source:
  • map.js, line 862

stopAnimating

Stop animating.
Source:
  • map.js, line 875

unbind

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

unbindAll

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

unfreezeRendering

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

withFrozenRendering

Parameters:
Name Type Description
f function(this: T) Function.
obj T= (Optional) Object.
Source:
  • map.js, line 904

zoom

Parameters:
Name Type Description
delta number Delta from previous zoom level.
anchor ol.Coordinate= (Optional) Anchor coordinate.
Source:
  • map.js, line 941

zoomToResolution

Parameters:
Name Type Description
resolution number | undefined Resolution to go to.
anchor ol.Coordinate= (Optional) Anchor coordinate.
Source:
  • map.js, line 951