Class ImageSource<Events>Abstract

constructor

• new ImageSource<Events extends ImageSourceEvents = ImageSourceEvents>(
      options?: ImageSourceOptions,
  ): ImageSource<Events>

  Type Parameters

  • Events extends ImageSourceEvents = ImageSourceEvents

  Parameters

  • options: ImageSourceOptions = {}

    Options.

  Returns ImageSource<Events>

ReadonlycontainsFn

datatype

ReadonlyflipY

ReadonlyisImageSource

ReadonlyisMemoryUsage

Readonlypriority

Readonlysynchronous

Readonlytransparent

Readonlytype

colorSpace

• get colorSpace(): ColorSpace

  Gets the color space of the textures generated by this source.

  Returns ColorSpace

adjustExtentAndPixelSize

• adjustExtentAndPixelSize(
      requestExtent: Extent,
      requestWidth: number,
      requestHeight: number,
      margin?: number,
  ): GridExtent | null

  Returns an adjusted extent, width and height so that request pixels are aligned with source pixels, and requests do not oversample the source.

  Parameters

  • requestExtent: Extent

    The request extent.

  • requestWidth: number

    The width, in pixels, of the request extent.

  • requestHeight: number

    The height, in pixels, of the request extent.

  • margin: number = 0

    The margin, in pixels, around the initial extent.

  Returns GridExtent | null

  The adjusted parameters.

contains

• contains(extent: Extent): boolean

  Gets whether this source contains the specified extent. If a custom contains function is provided, it will be used. Otherwise, intersects is used.

  This method is mainly used to discard non-relevant requests (i.e don't process regions that are not relevant to this source).

  Parameters

  • extent: Extent

    The extent to test.

  Returns boolean

dispose

• dispose(): void

  Disposes unmanaged resources of this source.

  Returns void

AbstractgetCrs

• getCrs(): CoordinateSystem

  Returns the CRS of this source.

  Returns CoordinateSystem

  The CRS.

AbstractgetExtent

• getExtent(): Extent | null

  Returns the extent of this source expressed in the CRS of the source. Might be null if the extent of the source is not known.

  Returns Extent | null

  The extent of the source, if any.

AbstractgetImages

• getImages(options: GetImageOptions): ImageResponse[]

  Gets the images for the specified extent and pixel size.

  Parameters

  • options: GetImageOptions

    The options.

  Returns ImageResponse[]

  An array containing the functions to generate the images asynchronously.

getMemoryUsage

• getMemoryUsage(_context: GetMemoryUsageContext): void

  Returns an approximation of the memory used by this object, in bytes.

  Parameters

  • _context: GetMemoryUsageContext

  Returns void

initialize

• initialize(options: { targetProjection: CoordinateSystem }): Promise<void>

  Initializes the source.

  Parameters

  • options: { targetProjection: CoordinateSystem }

    Options.

    • targetProjection: CoordinateSystem

      The target projection. Only useful for sources that are able to reproject their data on the fly (typically vector sources).

  Returns Promise<void>

  A promise that resolves when the source is initialized.

intersects

• intersects(extent: Extent): boolean

  Test the intersection between the specified extent and this source's extent. This method may be overriden to perform special logic.

  Parameters

  • extent: Extent

    The extent to test.

  Returns boolean

  true if the extent and this source extent intersects, false otherwise.

update

• update(extent?: Extent): void

  Raises an event to reload the source.

  Parameters

  • Optionalextent: Extent

  Returns void