Options
All
  • Public
  • Public/Protected
  • All
Menu

地图对象接口

Hierarchy

  • OlMap
    • IMap

Index

Properties

$owner

$owner: WebMap

Protected controls

controls: default<default>

Protected disposed

disposed: boolean

The object has already been disposed.

Protected interactions

interactions: default<default>

Methods

addControl

  • addControl(control: default): void
  • Add the given control to the map.

    Parameters

    • control: default

    Returns void

addEventListener

  • addEventListener(type: string, listener: Listener): void
  • Parameters

    • type: string
    • listener: Listener

    Returns void

addInteraction

  • addInteraction(interaction: default): void
  • Add the given interaction to the map. If you want to add an interaction at another point of the collection use getInteraction() and the methods available on {@link module:ol/Collection~Collection}. This can be used to stop the event propagation from the handleEvent function. The interactions get to handle the events in the reverse order of this collection.

    Parameters

    • interaction: default

    Returns void

addLayer

  • addLayer(layer: default): void
  • Adds the given layer to the top of this map. If you want to add a layer elsewhere in the stack, use getLayers() and the methods available on {@link module:ol/Collection~Collection}.

    Parameters

    • layer: default

    Returns void

addOverlay

  • addOverlay(overlay: default): void
  • Add the given overlay to the map.

    Parameters

    • overlay: default

    Returns void

changed

  • changed(): void
  • Increases the revision counter and dispatches a 'change' event.

    Returns void

createRenderer

  • createRenderer(): default
  • Returns default

dispatchEvent

  • dispatchEvent(event: string | default): boolean
  • Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

    Parameters

    • event: string | default

    Returns boolean

dispose

  • dispose(): void
  • Clean up.

    Returns void

disposeInternal

  • disposeInternal(): void
  • Clean up.

    Returns void

forEachFeatureAtPixel

  • forEachFeatureAtPixel<S, T>(pixel: Pixel, callback: (p0: FeatureLike, p1: default<default>) => T, opt_options?: AtPixelOptions): T
  • Detect features that intersect a pixel on the viewport, and execute a callback with each intersecting feature. Layers included in the detection can be configured through the layerFilter option in opt_options.

    Type parameters

    • S

    • T

    Parameters

    • pixel: Pixel
    • callback: (p0: FeatureLike, p1: default<default>) => T
        • (p0: FeatureLike, p1: default<default>): T
        • Parameters

          • p0: FeatureLike
          • p1: default<default>

          Returns T

    • Optional opt_options: AtPixelOptions

    Returns T

forEachLayerAtPixel

  • forEachLayerAtPixel<S, T>(pixel: Pixel, callback: (p0: default<default>, p1: Uint8ClampedArray | Uint8Array) => T, opt_options?: AtPixelOptions): T
  • Detect layers that have a color value at a pixel on the viewport, and execute a callback with each matching layer. Layers included in the detection can be configured through opt_layerFilter. Note: this may give false positives unless the map layers have had different className properties assigned to them.

    Type parameters

    • S

    • T

    Parameters

    • pixel: Pixel
    • callback: (p0: default<default>, p1: Uint8ClampedArray | Uint8Array) => T
        • (p0: default<default>, p1: Uint8ClampedArray | Uint8Array): T
        • Parameters

          • p0: default<default>
          • p1: Uint8ClampedArray | Uint8Array

          Returns T

    • Optional opt_options: AtPixelOptions

    Returns T

get

  • get(key: string): any
  • Gets a value.

    Parameters

    • key: string

    Returns any

getControls

  • getControls(): default<default>
  • Get the map controls. Modifying this collection changes the controls associated with the map.

    Returns default<default>

getCoordinateFromPixel

  • getCoordinateFromPixel(pixel: Pixel): Coordinate
  • Get the coordinate for a given pixel. This returns a coordinate in the user projection.

    Parameters

    • pixel: Pixel

    Returns Coordinate

getCoordinateFromPixelInternal

  • getCoordinateFromPixelInternal(pixel: Pixel): Coordinate
  • Get the coordinate for a given pixel. This returns a coordinate in the map view projection.

    Parameters

    • pixel: Pixel

    Returns Coordinate

getEventCoordinate

  • getEventCoordinate(event: MouseEvent): Coordinate
  • Returns the coordinate in user projection for a browser event.

    Parameters

    • event: MouseEvent

    Returns Coordinate

getEventCoordinateInternal

  • getEventCoordinateInternal(event: MouseEvent): Coordinate
  • Returns the coordinate in view projection for a browser event.

    Parameters

    • event: MouseEvent

    Returns Coordinate

getEventPixel

  • getEventPixel(event: UIEvent): Pixel
  • Returns the map pixel position for a browser event relative to the viewport.

    Parameters

    • event: UIEvent

    Returns Pixel

getFeaturesAtPixel

  • getFeaturesAtPixel(pixel: Pixel, opt_options?: AtPixelOptions): FeatureLike[]
  • Get all features that intersect a pixel on the viewport.

    Parameters

    • pixel: Pixel
    • Optional opt_options: AtPixelOptions

    Returns FeatureLike[]

getInteractions

  • getInteractions(): default<default>
  • Get the map interactions. Modifying this collection changes the interactions associated with the map. Interactions are used for e.g. pan, zoom and rotate.

    Returns default<default>

getKeys

  • getKeys(): string[]
  • Get a list of object property names.

    Returns string[]

getLayerGroup

  • getLayerGroup(): default
  • Get the layergroup associated with this map.

    Returns default

getLayers

  • getLayers(): default<default>
  • Get the collection of layers associated with this map.

    Returns default<default>

getListeners

  • getListeners(type: string): Listener[]
  • Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

    Parameters

    • type: string

    Returns Listener[]

getLoading

  • getLoading(): boolean
  • Returns boolean

getOverlayById

  • getOverlayById(id: string | number): default
  • Get an overlay by its identifier (the value returned by overlay.getId()). Note that the index treats string and numeric identifiers as the same. So map.getOverlayById(2) will return an overlay with id '2' or 2.

    Parameters

    • id: string | number

    Returns default

getOverlayContainer

  • getOverlayContainer(): HTMLElement
  • Get the element that serves as the container for overlays. Elements added to this container will let mousedown and touchstart events through to the map, so clicks and gestures on an overlay will trigger {@link module:ol/MapBrowserEvent~MapBrowserEvent} events.

    Returns HTMLElement

getOverlayContainerStopEvent

  • getOverlayContainerStopEvent(): HTMLElement
  • Get the element that serves as a container for overlays that don't allow event propagation. 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 {@link module:ol/MapBrowserEvent~MapBrowserEvent}.

    Returns HTMLElement

getOverlays

  • getOverlays(): default<default>
  • Get the map overlays. Modifying this collection changes the overlays associated with the map.

    Returns default<default>

getPixelFromCoordinate

  • getPixelFromCoordinate(coordinate: Coordinate): Pixel
  • Get the pixel for a coordinate. This takes a coordinate in the user projection and returns the corresponding pixel.

    Parameters

    • coordinate: Coordinate

    Returns Pixel

getPixelFromCoordinateInternal

  • getPixelFromCoordinateInternal(coordinate: Coordinate): Pixel
  • Get the pixel for a coordinate. This takes a coordinate in the map view projection and returns the corresponding pixel.

    Parameters

    • coordinate: Coordinate

    Returns Pixel

getProperties

  • getProperties(): {}
  • Get an object of all property names and values.

    Returns {}

    • [key: string]: any

getRenderer

  • getRenderer(): default
  • Get the map renderer.

    Returns default

getRevision

  • getRevision(): number
  • Get the version number for this object. Each time the object is modified, its version number will be incremented.

    Returns number

getSize

  • getSize(): Size
  • Get the size of this map.

    Returns Size

getTarget

  • getTarget(): string | HTMLElement
  • Get the target in which this map is rendered. Note that this returns what is entered as an option or in setTarget: if that was an element, it returns an element; if a string, it returns that.

    Returns string | HTMLElement

getTargetElement

  • getTargetElement(): HTMLElement
  • Get the DOM element into which this map is rendered. In contrast to getTarget this method always return an Element, or null if the map has no target.

    Returns HTMLElement

getTilePriority

  • getTilePriority(tile: default, tileSourceKey: string, tileCenter: Coordinate, tileResolution: number): number
  • Parameters

    • tile: default
    • tileSourceKey: string
    • tileCenter: Coordinate
    • tileResolution: number

    Returns number

getView

  • getView(): default
  • Get the view associated with this map. A view manages properties such as center and resolution.

    Returns default

getViewport

  • getViewport(): HTMLElement
  • Get the element that serves as the map viewport.

    Returns HTMLElement

handleBrowserEvent

  • handleBrowserEvent(browserEvent: UIEvent, opt_type?: string): void
  • Parameters

    • browserEvent: UIEvent
    • Optional opt_type: string

    Returns void

handleMapBrowserEvent

  • handleMapBrowserEvent(mapBrowserEvent: default<UIEvent>): void
  • Parameters

    • mapBrowserEvent: default<UIEvent>

    Returns void

Protected handlePostRender

  • handlePostRender(): void
  • Returns void

hasFeatureAtPixel

  • hasFeatureAtPixel(pixel: Pixel, opt_options?: AtPixelOptions): boolean
  • Detect if features intersect a pixel on the viewport. Layers included in the detection can be configured through opt_layerFilter.

    Parameters

    • pixel: Pixel
    • Optional opt_options: AtPixelOptions

    Returns boolean

hasListener

  • hasListener(opt_type?: string): boolean
  • Parameters

    • Optional opt_type: string

    Returns boolean

hasProperties

  • hasProperties(): boolean
  • Returns boolean

isRendered

  • isRendered(): boolean
  • Returns boolean

notify

  • notify(key: string, oldValue: any): void
  • Parameters

    • key: string
    • oldValue: any

    Returns void

on

  • on(type: string | string[], listener: (p0: any) => any): EventsKey | EventsKey[]
  • on(type: "change", listener: (evt: default) => void): EventsKey
  • on(type: "change:layerGroup", listener: (evt: ObjectEvent) => void): EventsKey
  • on(type: "change:size", listener: (evt: ObjectEvent) => void): EventsKey
  • on(type: "change:target", listener: (evt: ObjectEvent) => void): EventsKey
  • on(type: "change:view", listener: (evt: ObjectEvent) => void): EventsKey
  • on(type: "click", listener: (evt: default<UIEvent>) => void): EventsKey
  • on(type: "dblclick", listener: (evt: default<UIEvent>) => void): EventsKey
  • on(type: "error", listener: (evt: default) => void): EventsKey
  • on(type: "moveend", listener: (evt: default) => void): EventsKey
  • on(type: "movestart", listener: (evt: default) => void): EventsKey
  • on(type: "pointerdrag", listener: (evt: default<UIEvent>) => void): EventsKey
  • on(type: "pointermove", listener: (evt: default<UIEvent>) => void): EventsKey
  • on(type: "postcompose", listener: (evt: default) => void): EventsKey
  • on(type: "postrender", listener: (evt: default) => void): EventsKey
  • on(type: "precompose", listener: (evt: default) => void): EventsKey
  • on(type: "propertychange", listener: (evt: ObjectEvent) => void): EventsKey
  • on(type: "rendercomplete", listener: (evt: default) => void): EventsKey
  • on(type: "singleclick", listener: (evt: default<UIEvent>) => void): EventsKey
  • Parameters

    • type: string | string[]
    • listener: (p0: any) => any
        • (p0: any): any
        • Parameters

          • p0: any

          Returns any

    Returns EventsKey | EventsKey[]

  • Parameters

    • type: "change"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "change:layerGroup"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns EventsKey

  • Parameters

    • type: "change:size"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns EventsKey

  • Parameters

    • type: "change:target"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns EventsKey

  • Parameters

    • type: "change:view"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns EventsKey

  • Parameters

    • type: "click"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns EventsKey

  • Parameters

    • type: "dblclick"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns EventsKey

  • Parameters

    • type: "error"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "moveend"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "movestart"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "pointerdrag"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns EventsKey

  • Parameters

    • type: "pointermove"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns EventsKey

  • Parameters

    • type: "postcompose"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "postrender"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "precompose"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "propertychange"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns EventsKey

  • Parameters

    • type: "rendercomplete"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "singleclick"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns EventsKey

once

  • once(type: string | string[], listener: (p0: any) => any): EventsKey | EventsKey[]
  • once(type: "change", listener: (evt: default) => void): EventsKey
  • once(type: "change:layerGroup", listener: (evt: ObjectEvent) => void): EventsKey
  • once(type: "change:size", listener: (evt: ObjectEvent) => void): EventsKey
  • once(type: "change:target", listener: (evt: ObjectEvent) => void): EventsKey
  • once(type: "change:view", listener: (evt: ObjectEvent) => void): EventsKey
  • once(type: "click", listener: (evt: default<UIEvent>) => void): EventsKey
  • once(type: "dblclick", listener: (evt: default<UIEvent>) => void): EventsKey
  • once(type: "error", listener: (evt: default) => void): EventsKey
  • once(type: "moveend", listener: (evt: default) => void): EventsKey
  • once(type: "movestart", listener: (evt: default) => void): EventsKey
  • once(type: "pointerdrag", listener: (evt: default<UIEvent>) => void): EventsKey
  • once(type: "pointermove", listener: (evt: default<UIEvent>) => void): EventsKey
  • once(type: "postcompose", listener: (evt: default) => void): EventsKey
  • once(type: "postrender", listener: (evt: default) => void): EventsKey
  • once(type: "precompose", listener: (evt: default) => void): EventsKey
  • once(type: "propertychange", listener: (evt: ObjectEvent) => void): EventsKey
  • once(type: "rendercomplete", listener: (evt: default) => void): EventsKey
  • once(type: "singleclick", listener: (evt: default<UIEvent>) => void): EventsKey
  • Parameters

    • type: string | string[]
    • listener: (p0: any) => any
        • (p0: any): any
        • Parameters

          • p0: any

          Returns any

    Returns EventsKey | EventsKey[]

  • Parameters

    • type: "change"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "change:layerGroup"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns EventsKey

  • Parameters

    • type: "change:size"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns EventsKey

  • Parameters

    • type: "change:target"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns EventsKey

  • Parameters

    • type: "change:view"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns EventsKey

  • Parameters

    • type: "click"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns EventsKey

  • Parameters

    • type: "dblclick"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns EventsKey

  • Parameters

    • type: "error"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "moveend"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "movestart"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "pointerdrag"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns EventsKey

  • Parameters

    • type: "pointermove"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns EventsKey

  • Parameters

    • type: "postcompose"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "postrender"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "precompose"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "propertychange"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns EventsKey

  • Parameters

    • type: "rendercomplete"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns EventsKey

  • Parameters

    • type: "singleclick"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns EventsKey

redrawText

  • redrawText(): void
  • Redraws all text after new fonts have loaded

    Returns void

removeControl

  • removeControl(control: default): default
  • Remove the given control from the map.

    Parameters

    • control: default

    Returns default

removeEventListener

  • removeEventListener(type: string, listener: Listener): void
  • Parameters

    • type: string
    • listener: Listener

    Returns void

removeInteraction

  • removeInteraction(interaction: default): default
  • Remove the given interaction from the map.

    Parameters

    • interaction: default

    Returns default

removeLayer

  • removeLayer(layer: default): default
  • Removes the given layer from the map.

    Parameters

    • layer: default

    Returns default

removeOverlay

  • removeOverlay(overlay: default): default
  • Remove the given overlay from the map.

    Parameters

    • overlay: default

    Returns default

render

  • render(): void
  • Request a map rendering (at the next animation frame).

    Returns void

renderSync

  • renderSync(): void
  • Requests an immediate render in a synchronous manner.

    Returns void

set

  • set(key: string, value: any, opt_silent?: boolean): void
  • Sets a value.

    Parameters

    • key: string
    • value: any
    • Optional opt_silent: boolean

    Returns void

setLayerGroup

  • setLayerGroup(layerGroup: default): void
  • Sets the layergroup of this map.

    Parameters

    • layerGroup: default

    Returns void

setProperties

  • setProperties(values: {}, opt_silent?: boolean): void
  • Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

    Parameters

    • values: {}
      • [key: string]: any
    • Optional opt_silent: boolean

    Returns void

setSize

  • setSize(size: Size): void
  • Set the size of this map.

    Parameters

    • size: Size

    Returns void

setTarget

  • setTarget(target: string | HTMLElement): void
  • Set the target element to render this map into.

    Parameters

    • target: string | HTMLElement

    Returns void

setView

  • setView(view: default): void
  • Set the view for this map.

    Parameters

    • view: default

    Returns void

un

  • un(type: string | string[], listener: (p0: any) => any): void
  • un(type: "change", listener: (evt: default) => void): void
  • un(type: "change:layerGroup", listener: (evt: ObjectEvent) => void): void
  • un(type: "change:size", listener: (evt: ObjectEvent) => void): void
  • un(type: "change:target", listener: (evt: ObjectEvent) => void): void
  • un(type: "change:view", listener: (evt: ObjectEvent) => void): void
  • un(type: "click", listener: (evt: default<UIEvent>) => void): void
  • un(type: "dblclick", listener: (evt: default<UIEvent>) => void): void
  • un(type: "error", listener: (evt: default) => void): void
  • un(type: "moveend", listener: (evt: default) => void): void
  • un(type: "movestart", listener: (evt: default) => void): void
  • un(type: "pointerdrag", listener: (evt: default<UIEvent>) => void): void
  • un(type: "pointermove", listener: (evt: default<UIEvent>) => void): void
  • un(type: "postcompose", listener: (evt: default) => void): void
  • un(type: "postrender", listener: (evt: default) => void): void
  • un(type: "precompose", listener: (evt: default) => void): void
  • un(type: "propertychange", listener: (evt: ObjectEvent) => void): void
  • un(type: "rendercomplete", listener: (evt: default) => void): void
  • un(type: "singleclick", listener: (evt: default<UIEvent>) => void): void
  • Parameters

    • type: string | string[]
    • listener: (p0: any) => any
        • (p0: any): any
        • Parameters

          • p0: any

          Returns any

    Returns void

  • Parameters

    • type: "change"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns void

  • Parameters

    • type: "change:layerGroup"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns void

  • Parameters

    • type: "change:size"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns void

  • Parameters

    • type: "change:target"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns void

  • Parameters

    • type: "change:view"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns void

  • Parameters

    • type: "click"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns void

  • Parameters

    • type: "dblclick"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns void

  • Parameters

    • type: "error"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns void

  • Parameters

    • type: "moveend"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns void

  • Parameters

    • type: "movestart"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns void

  • Parameters

    • type: "pointerdrag"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns void

  • Parameters

    • type: "pointermove"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns void

  • Parameters

    • type: "postcompose"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns void

  • Parameters

    • type: "postrender"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns void

  • Parameters

    • type: "precompose"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns void

  • Parameters

    • type: "propertychange"
    • listener: (evt: ObjectEvent) => void
        • (evt: ObjectEvent): void
        • Parameters

          • evt: ObjectEvent

          Returns void

    Returns void

  • Parameters

    • type: "rendercomplete"
    • listener: (evt: default) => void
        • (evt: default): void
        • Parameters

          • evt: default

          Returns void

    Returns void

  • Parameters

    • type: "singleclick"
    • listener: (evt: default<UIEvent>) => void
        • (evt: default<UIEvent>): void
        • Parameters

          • evt: default<UIEvent>

          Returns void

    Returns void

unset

  • unset(key: string, opt_silent?: boolean): void
  • Unsets a property.

    Parameters

    • key: string
    • Optional opt_silent: boolean

    Returns void

updateSize

  • updateSize(): void
  • Force a recalculation of the map viewport size. This should be called when third-party code changes the size of the map viewport.

    Returns void

Generated using TypeDoc