Class ImageCanvas

loading

on

once

un

addChangeListener

• addChangeListener(key, listener): void

• Parameters

  • key: string

    Key name.
  • listener: Listener

    Listener.

  Returns void

addEventListener

• addEventListener(type, listener): void

• Parameters

  • type: string

    Type.
  • listener: Listener

    Listener.

  Returns void

changed

• changed(): void

• Increases the revision counter and dispatches a 'change' event.

  Returns void

  Api

dispatchEvent

• dispatchEvent(event): undefined | 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 | BaseEvent

    Event object.

  Returns undefined | boolean

  false if anyone called preventDefault on the event object or if any of the listeners returned false.

  Api

dispose

• dispose(): void

• Clean up.

  Returns void

get

• get(key): any

• Gets a value.

  Parameters

  • key: string

    Key name.

  Returns any

  Value.

  Api

getAttributions

• getAttributions(): null | Attribution

• Get the attribution function for the source.

  Returns null | Attribution

  Attribution function.

  Api

getAttributionsCollapsible

• getAttributionsCollapsible(): boolean

• Returns boolean

  Attributions are collapsible.

  Api

getImage

• getImage(extent, resolution, pixelRatio, projection): external.ol.Image

• Parameters

  • extent: Extent

    Extent.
  • resolution: number

    Resolution.
  • pixelRatio: number

    Pixel ratio.
  • projection: Projection

    Projection.

  Returns external.ol.Image

  Single image.

getInterpolate

• getInterpolate(): boolean

• Returns boolean

  Use linear interpolation when resampling.

getKeys

• getKeys(): string[]

• Get a list of object property names.

  Returns string[]

  List of property names.

  Api

getListeners

• getListeners(type): undefined | Listener[]

• Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

  Parameters

  • type: string

    Type.

  Returns undefined | Listener[]

  Listeners.

getProjection

• getProjection(): null | Projection

• Get the projection of the source.

  Returns null | Projection

  Projection.

  Api

getProperties

• getProperties(): {
      [x: string]: any;
  }

• Get an object of all property names and values.

  Returns {
      [x: string]: any;
  }

  Object.

  • [x: string]: any

  Api

getPropertiesInternal

• getPropertiesInternal(): null | {
      [x: string]: any;
  }

• Get an object of all property names and values.

  Returns null | {
      [x: string]: any;
  }

  Object.

getResolutions

• getResolutions(): null | number[]

• Returns null | number[]

  Resolutions.

getRevision

• getRevision(): number

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

  Returns number

  Revision.

  Api

getState

• getState(): State

• Get the state of the source, see import("./Source.js").State for possible states.

  Returns State

  State.

  Api

getView

• getView(): Promise<ViewOptions>

• Returns Promise<ViewOptions>

  A promise for view-related properties.

getWrapX

• getWrapX(): undefined | boolean

• Returns undefined | boolean

  Wrap X.

hasListener

• hasListener(type?): boolean

• Parameters

  • Optional type: string

    Type. If not provided, true will be returned if this event target has any listeners.

  Returns boolean

  Has listeners.

hasProperties

• hasProperties(): boolean

• Returns boolean

  The object has properties.

notify

• notify(key, oldValue): void

• Parameters

  • key: string

    Key name.
  • oldValue: any

    Old value.

  Returns void

refresh

• refresh(): void

• Refreshes the source. The source will be cleared, and data from the server will be reloaded.

  Returns void

  Api

removeChangeListener

• removeChangeListener(key, listener): void

• Parameters

  • key: string

    Key name.
  • listener: Listener

    Listener.

  Returns void

removeEventListener

• removeEventListener(type, listener): void

• Parameters

  • type: string

    Type.
  • listener: Listener

    Listener.

  Returns void

set

• set(key, value, silent?): void

• Sets a value.

  Parameters

  • key: string

    Key name.
  • value: any

    Value.
  • Optional silent: boolean

    Update without triggering an event.

  Returns void

  Api

setAttributions

• setAttributions(attributions): void

• Set the attributions of the source.

  Parameters

  • attributions: undefined | AttributionLike

    Attributions. Can be passed as string, Array<string>, module:ol/source/Source~Attribution, or undefined.

  Returns void

  Api

setProperties

• setProperties(values, silent?): 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: {
        [x: string]: any;
    }

    Values.

    • [x: string]: any

  • Optional silent: boolean

    Update without triggering an event.

  Returns void

  Api

setResolutions

• setResolutions(resolutions): void

• Parameters

  • resolutions: null | number[]

    Resolutions.

  Returns void

setState

• setState(state): void

• Set the state of the source.

  Parameters

  • state: State

    State.

  Returns void

unset

• unset(key, silent?): void

• Unsets a property.

  Parameters

  • key: string

    Key name.
  • Optional silent: boolean

    Unset without triggering an event.

  Returns void

  Api