OpenLayers Class: ol.Map

new Map

Parameters:

Name	Type	Description
`mapOptions`	olx.MapOptions	Map options.

Source:

map.js, line 121

Extends

ol.Object

Members

changed

Inherited From:

ol.Object#changed

Source:

object.js, line 147

<protected> logger :goog.debug.Logger

Source:

map.js, line 130

setValues

Inherited From:

ol.Object#setValues

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:

ol.Object#bindTo

Source:

object.js, line 126

canRotate

Source:

map.js, line 283

Returns:

Can rotate.

Type: boolean

<static> createOptionsInternal

Parameters:

Name	Type	Description
`mapOptions`	olx.MapOptions	Map options.

Source:

map.js, line 969

Returns:

Map options.

Type: ol.MapOptionsInternal

fitExtent

Parameters:

Name	Type	Description
`extent`	ol.Extent	Extent.

Source:

map.js, line 291

fitUserExtent

Parameters:

Name	Type	Description
`userExtent`	ol.Extent	Extent in user projection.

Source:

map.js, line 307

freezeRendering

Freeze rendering.

Source:

map.js, line 315

get

Parameters:

Name	Type	Description
`key`	string	Key.

Inherited From:

ol.Object#get

Source:

object.js, line 154

Returns:

Value.

Type: *

getBackgroundColor

Source:

map.js, line 323

Returns:

Background color.

Type: ol.Color | undefined

getCenter

Source:

map.js, line 336

Returns:

Center.

Type: ol.Coordinate | undefined

getControls

Source:

map.js, line 356

Returns:

Controls.

Type: ol.Collection

getCoordinateFromPixel

Parameters:

Name	Type	Description
`pixel`	ol.Pixel	Pixel.

Source:

map.js, line 365

Returns:

Coordinate.

Type: ol.Coordinate

getExtent

Source:

map.js, line 373

Returns:

Extent.

Type: ol.Extent | undefined

getInteractions

Source:

map.js, line 392

Returns:

Interactions.

Type: ol.Collection

getLayers

Source:

map.js, line 404

Returns:

Layers.

Type: ol.Collection

getOverlayContainer

Source:

map.js, line 563

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 413

Returns:

Pixel.

Type: ol.Pixel | undefined

getProjection

Source:

map.js, line 425

Returns:

Projection.

Type: ol.Projection | undefined

getResolution

Source:

map.js, line 437

Returns:

Resolution.

Type: number | undefined

getResolutionForExtent

Parameters:

Name	Type	Description
`extent`	ol.Extent	Extent.

Source:

map.js, line 450

Returns:

Resolution.

Type: number | undefined

getRotatedExtent

Source:

map.js, line 465

Returns:

Rotated extent.

Type: ol.Extent

getRotation

Source:

map.js, line 490

Returns:

Rotation.

Type: number

getSize

Source:

map.js, line 502

Returns:

Size.

Type: ol.Size | undefined

getTarget

Source:

map.js, line 348

Returns:

Container.

Type: Element

getUserCenter

Source:

map.js, line 514

Returns:

Center in user projection.

Type: ol.Coordinate | undefined

getUserExtent

Source:

map.js, line 527

Returns:

Extent in user projection.

Type: ol.Extent | undefined

getUserProjection

Source:

map.js, line 540

Returns:

Projection.

Type: ol.Projection | undefined

getViewport

Source:

map.js, line 553

Returns:

Viewport.

Type: Element

handleBrowserEvent

Parameters:

Name	Type	Description
`browserEvent`	goog.events.BrowserEvent	Browser event.
`type`	string=	(Optional) Type.

Source:

map.js, line 572

<protected> handleBrowserWindowResize

Source:

map.js, line 634

handleMapBrowserEvent

Parameters:

Name	Type	Description
`mapBrowserEvent`	ol.MapBrowserEvent	The event to handle.

Source:

map.js, line 602

<protected> handleProjectionChanged

Source:

map.js, line 618

<protected> handleUserProjectionChanged

Source:

map.js, line 626

isAnimating

Source:

map.js, line 643

Returns:

Is animating.

Type: boolean

isDef

Source:

map.js, line 651

Returns:

Is defined.

Type: boolean

notify

Parameters:

Name	Type	Description
`key`	string	Key.

Inherited From:

ol.Object#notify

Source:

object.js, line 175

onAnimationFrame

Source:

map.js, line 661

render

Render.

Source:

map.js, line 691

rotate

Parameters:

Name	Type	Description
`rotation`	number \| undefined	Rotation.
`delta`	number	Delta.

Source:

map.js, line 730

set

Parameters:

Name	Type	Description
`key`	string	Key.
`value`	*	Value.

Inherited From:

ol.Object#set

Source:

object.js, line 202

setBackgroundColor

Parameters:

Name	Type	Description
`backgroundColor`	ol.Color	Background color.

Source:

map.js, line 739

setCenter

Parameters:

Name	Type	Description
`center`	ol.Coordinate \| undefined	Center.

Source:

map.js, line 751

setInteractions

Parameters:

Name	Type	Description
`interactions`	ol.Collection	Interactions.

Source:

map.js, line 763

setLayers

Parameters:

Name	Type	Description
`layers`	ol.Collection	Layers.

Source:

map.js, line 775

setOptions

Parameters:

Name	Type	Description
`options`	Object.<string, *>	Options.

Inherited From:

ol.Object#setOptions

Source:

object.js, line 224

setProjection

Parameters:

Name	Type	Description
`projection`	ol.Projection	Projection.

Source:

map.js, line 787

setResolution

Parameters:

Name	Type	Description
`resolution`	number \| undefined	Resolution.

Source:

map.js, line 799

setRotation

Parameters:

Name	Type	Description
`rotation`	number \| undefined	Rotation.

Source:

map.js, line 811

setSize

Parameters:

Name	Type	Description
`size`	ol.Size	Size.

Source:

map.js, line 823

setUserCenter

Parameters:

Name	Type	Description
`userCenter`	ol.Coordinate	Center in user projection.

Source:

map.js, line 835

setUserProjection

Parameters:

Name	Type	Description
`userProjection`	ol.Projection	User projection.

Source:

map.js, line 847

startAnimating

Start animating.

Source:

map.js, line 859

stopAnimating

Stop animating.

Source:

map.js, line 872

unbind

Parameters:

Name	Type	Description
`key`	string	Key.

Inherited From:

ol.Object#unbind

Source:

object.js, line 245

unbindAll

Removes all bindings.

Inherited From:

ol.Object#unbindAll

Source:

object.js, line 262

unfreezeRendering

Unfreeze rendering.

Source:

map.js, line 886

withFrozenRendering

Parameters:

Name	Type	Description
`f`	function(this: T)	Function.
`obj`	T=	(Optional) Object.

Source:

map.js, line 901

zoom

Parameters:

Name	Type	Description
`delta`	number	Delta from previous zoom level.
`anchor`	ol.Coordinate=	(Optional) Anchor coordinate.

Source:

map.js, line 938

zoomToResolution

Parameters:

Name	Type	Description
`resolution`	number \| undefined	Resolution to go to.
`anchor`	ol.Coordinate=	(Optional) Anchor coordinate.

Source:

map.js, line 948