Class DebugSource

Base class for all image sources. The ImageSource produces images to be consumed by clients, such as map layers.

Hierarchy (View Summary)

ImageSource
- DebugSource

Index

Constructors

constructor

new DebugSource(
    options: {
        color?: Color | ((options: GetImageOptions) => Color);
        containsFn?: CustomContainsFn;
        delay?: number | (() => number);
        extent: Extent;
        opacity?: number;
        subdivisions?: number;
    },
): DebugSource
Parameters
- options: {
      color?: Color | ((options: GetImageOptions) => Color);
      containsFn?: CustomContainsFn;
      delay?: number | (() => number);
      extent: Extent;
      opacity?: number;
      subdivisions?: number;
  }
  options
  - Optionalcolor?: Color | ((options: GetImageOptions) => Color)
    The color of the images.
  - OptionalcontainsFn?: CustomContainsFn
    The custom function to test if a given extent is contained in this source.
  - Optionaldelay?: number | (() => number)
    The delay before loading the images, in milliseconds.
  - extent: Extent
    The extent.
  - Optionalopacity?: number
    The opacity of the images.
  - Optionalsubdivisions?: number
    How many images per tile are served.
Returns DebugSource
Overrides ImageSource.constructor
- Defined in sources/DebugSource.ts:30

Properties

`Readonly`containsFn

containsFn: CustomContainsFn | undefined

datatype

datatype: TextureDataType

Gets the datatype of images generated by this source.

`Readonly`flipY

flipY: boolean

Gets whether images generated from this source should be flipped vertically.

`Readonly`isDebugSource

isDebugSource: boolean = ...

`Readonly`isImageSource

isImageSource: boolean = ...

`Readonly`isMemoryUsage

isMemoryUsage: true = ...

Readonly flag to indicate that his object implements MemoryUsage.

`Readonly`priority

priority: RequestPriority = 'auto'

`Readonly`synchronous

synchronous: boolean = false

If true, this source can immediately generate images without any delay.

`Readonly`transparent

transparent: boolean

`Readonly`type

type: "DebugSource" = ...

Accessors

colorSpace

get colorSpace(): ColorSpace
Gets the color space of the textures generated by this source.

Returns ColorSpace
Inherited from ImageSource.colorSpace
- Defined in sources/ImageSource.ts:201

Methods

adjustExtentAndPixelSize

adjustExtentAndPixelSize(
    requestExtent: Extent,
    requestWidth: number,
    requestHeight: 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.
Returns GridExtent | null
The adjusted parameters.
Overrides ImageSource.adjustExtentAndPixelSize
- Defined in sources/DebugSource.ts:66

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
Inherited from ImageSource.contains
- Defined in sources/ImageSource.ts:267

dispose

dispose(): void
Disposes unmanaged resources of this source.

Returns void
Inherited from ImageSource.dispose
- Defined in sources/ImageSource.ts:322

getCrs

getCrs(): CoordinateSystem
Returns the CRS of this source.

Returns CoordinateSystem
The CRS.
Overrides ImageSource.getCrs
- Defined in sources/DebugSource.ts:108

getExtent

getExtent(): Extent
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
The extent of the source, if any.
Overrides ImageSource.getExtent
- Defined in sources/DebugSource.ts:112

getImages

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.
Overrides ImageSource.getImages
- Defined in sources/DebugSource.ts:116

getMemoryUsage

getMemoryUsage(_context: GetMemoryUsageContext): void
Returns an approximation of the memory used by this object, in bytes.
Parameters
- _context: GetMemoryUsageContext
Returns void
Inherited from ImageSource.getMemoryUsage
- Defined in sources/ImageSource.ts:194

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.
Inherited from ImageSource.initialize
- Defined in sources/ImageSource.ts:301

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.
Inherited from ImageSource.intersects
- Defined in sources/ImageSource.ts:284

update

update(extent?: Extent): void
Raises an event to reload the source.
Parameters
- Optionalextent: Extent
Returns void
Inherited from ImageSource.update
- Defined in sources/ImageSource.ts:253

Class DebugSource

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optionalcolor?: Color | ((options: GetImageOptions) => Color)

OptionalcontainsFn?: CustomContainsFn

Optionaldelay?: number | (() => number)

extent: Extent

Optionalopacity?: number

Optionalsubdivisions?: number

Returns DebugSource

Properties

ReadonlycontainsFn

datatype

ReadonlyflipY

ReadonlyisDebugSource

ReadonlyisImageSource

ReadonlyisMemoryUsage

Readonlypriority

Readonlysynchronous

Readonlytransparent

Readonlytype

Accessors

colorSpace

Returns ColorSpace

Methods

adjustExtentAndPixelSize

Parameters

Returns GridExtent | null

contains

Parameters

Returns boolean

dispose

Returns void

getCrs

Returns CoordinateSystem

getExtent

Returns Extent

getImages

Parameters

Returns ImageResponse[]

getMemoryUsage

Parameters

Returns void

initialize

Parameters

targetProjection: CoordinateSystem

Returns Promise<void>

intersects

Parameters

Returns boolean

update

Parameters

Returns void

Settings

On This Page

`Optional`color?: Color | ((options: GetImageOptions) => Color)

`Optional`containsFn?: CustomContainsFn

`Optional`delay?: number | (() => number)

`Optional`opacity?: number

`Optional`subdivisions?: number

`Readonly`containsFn

`Readonly`flipY

`Readonly`isDebugSource

`Readonly`isImageSource

`Readonly`isMemoryUsage

`Readonly`priority

`Readonly`synchronous

`Readonly`transparent

`Readonly`type