Classdesc

Base class for image sources where a canvas element is the image.

Api

Hierarchy (view full)

Constructors

Properties

disposed: boolean

The object has already been disposed.

loader: Loader
loading: boolean

This source is currently loading data. Sources that defer loading to the map's tile queue never set this to true.

on: ImageSourceOnSignature<EventsKey>
once: ImageSourceOnSignature<EventsKey>
projection: null | Projection
un: ImageSourceOnSignature<void>
viewRejector: ((arg0) => void)

Type declaration

    • (arg0): void
    • Parameters

      • arg0: Error

      Returns void

viewResolver: ((arg0) => void)

Type declaration

    • (arg0): void
    • Parameters

      • arg0: ViewOptions

      Returns void

Methods

  • Parameters

    • key: string

      Key name.

    • listener: Listener

      Listener.

    Returns void

  • Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

  • Protected

    Apply any properties from another object without triggering events.

    Parameters

    • source: Object

      The source object.

    Returns void

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

    Returns void

    Api

  • 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

  • Clean up.

    Returns void

  • Protected

    Extension point for disposable objects.

    Returns void

  • Protected

    Parameters

    • resolution: number

      Resolution.

    Returns number

    Resolution.

  • Gets a value.

    Parameters

    • key: string

      Key name.

    Returns any

    Value.

    Api

  • Get the attribution function for the source.

    Returns null | Attribution

    Attribution function.

    Api

  • Returns boolean

    Attributions are collapsible.

    Api

  • Parameters

    • extent: Extent

      Extent.

    • resolution: number

      Resolution.

    • pixelRatio: number

      Pixel ratio.

    • projection: Projection

      Projection.

    Returns external.ol.Image

    Single image.

  • Parameters

    • extent: Extent

      Extent.

    • resolution: number

      Resolution.

    • pixelRatio: number

      Pixel ratio.

    • projection: Projection

      Projection.

    Returns external.ol.ImageCanvas

    Single image.

  • Returns boolean

    Use linear interpolation when resampling.

  • Get a list of object property names.

    Returns string[]

    List of property names.

    Api

  • 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.

  • Get the projection of the source.

    Returns null | Projection

    Projection.

    Api

  • Get an object of all property names and values.

    Returns {
        [x: string]: any;
    }

    Object.

    • [x: string]: any

    Api

  • Get an object of all property names and values.

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

    Object.

  • Returns null | number[]

    Resolutions.

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

    Returns number

    Revision.

    Api

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

    Returns State

    State.

    Api

  • Returns Promise<ViewOptions>

    A promise for view-related properties.

  • Returns undefined | boolean

    Wrap X.

  • Protected

    Handle image change events.

    Parameters

    • event: BaseEvent

      Event.

    Returns void

  • Parameters

    • Optional type: string

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

    Returns boolean

    Has listeners.

  • Returns boolean

    The object has properties.

  • Parameters

    • key: string

      Key name.

    • oldValue: any

      Old value.

    Returns void

  • Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: ((arg0) => unknown)

      Listener.

        • (arg0): unknown
        • Parameters

          • arg0: Event | BaseEvent

          Returns unknown

    Returns EventsKey | EventsKey[]

    Event key.

  • Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: ((arg0) => unknown)

      Listener.

        • (arg0): unknown
        • Parameters

          • arg0: Event | BaseEvent

          Returns unknown

    Returns EventsKey | EventsKey[]

    Event key.

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

    Returns void

    Api

  • Parameters

    • key: string

      Key name.

    • listener: Listener

      Listener.

    Returns void

  • Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

  • Sets a value.

    Parameters

    • key: string

      Key name.

    • value: any

      Value.

    • Optional silent: boolean

      Update without triggering an event.

    Returns void

    Api

  • 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

  • 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

  • Parameters

    • resolutions: null | number[]

      Resolutions.

    Returns void

  • Set the state of the source.

    Parameters

    • state: State

      State.

    Returns void

  • Protected

    Unlisten for a certain type of event.

    Parameters

    • type: string | string[]

      Type.

    • listener: ((arg0) => unknown)

      Listener.

        • (arg0): unknown
        • Parameters

          • arg0: Event | BaseEvent

          Returns unknown

    Returns void

  • Unsets a property.

    Parameters

    • key: string

      Key name.

    • Optional silent: boolean

      Unset without triggering an event.

    Returns void

    Api