Class: ol.Map

ol.Map

new Map

Parameters:
Name Type Description
container Element Container.
mapOptionsLiteral ol.MapOptionsLiteral Map options literal.
Source:
  • map.js, line 82

Extends

Members

changed

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

<protected> logger :goog.debug.Logger

Source:
  • map.js, line 91

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 213
Returns:
Can rotate.
Type
boolean

fitExtent

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

fitUserExtent

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

freezeRendering

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

get

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

getBackgroundColor

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

getCenter

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

getContainer

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

getCoordinateFromPixel

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

getExtent

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

getInteractions

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

getLayers

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

getPixelFromCoordinate

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

getProjection

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

getResolution

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

getResolutionForExtent

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

getRotatedExtent

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

getRotation

Source:
  • map.js, line 416
Returns:
Rotation.
Type
number | undefined

getSize

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

getUserCenter

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

getUserExtent

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

getUserProjection

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

getViewport

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

handleBrowserEvent

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

<protected> handleBrowserWindowResize

Source:
  • map.js, line 530

handleMapBrowserEvent

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

<protected> handleProjectionChanged

Source:
  • map.js, line 514

<protected> handleUserProjectionChanged

Source:
  • map.js, line 522

isAnimating

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

isDef

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

render

Render.
Source:
  • map.js, line 588

rotate

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

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 636

setCenter

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

setInteractions

Parameters:
Name Type Description
interactions ol.Collection Interactions.
Source:
  • map.js, line 660

setLayers

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

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 684

setResolution

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

setRotation

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

setSize

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

setUserCenter

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

setUserProjection

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

startAnimating

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

stopAnimating

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

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 783

withFrozenRendering

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

zoom

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

zoomToResolution

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