Class AggregateImageSource

An image source that aggregates several sub-sources. The extent of this source is the union of the extent of all sub-sources.

Overlapping sources are stacked vertically with the sources toward the end of the array being drawn on top of sources at the beginning of the array.

Constraints:

all sub-sources must have the same CRS.
all sub-sources must have the same color space
all sub-sources must have the same flip-Y parameter
all sub-sources must produce textures that have the same datatype (e.g either 8-bit or 32-bit textures, but not both)

Hierarchy (View Summary)

ImageSource
- AggregateImageSource

Index

Constructors

constructor

new AggregateImageSource(
options: { sources: ImageSource<ImageSourceEvents>[] },
): AggregateImageSource
Parameters
- options: { sources: ImageSource<ImageSourceEvents>[] }
  - sources: ImageSource<ImageSourceEvents>[]
    The sub-sources. The order in which they appear in the array will set their z-index (i.e sources at the end of the array will be displayed on top).
Returns AggregateImageSource
Overrides ImageSource.constructor
- Defined in sources/AggregateImageSource.ts:45

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`isAggregateImageSource

isAggregateImageSource: true = ...

`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: "AggregateImageSource" = ...

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

sources

get sources(): readonly ImageSource<ImageSourceEvents>[]
The sources in this source.

Returns readonly ImageSource<ImageSourceEvents>[]
- Defined in sources/AggregateImageSource.ts:81

Methods

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

contains

contains(extent: Extent): boolean
Returns true if the extent intersects with any sub-source's extent.
Parameters
- extent: Extent
Returns boolean
Overrides ImageSource.contains
- Defined in sources/AggregateImageSource.ts:169

dispose

dispose(): void
Disposes all sub-sources.

Returns void
Overrides ImageSource.dispose
- Defined in sources/AggregateImageSource.ts:178

getCrs

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

Returns CoordinateSystem
The CRS.
Overrides ImageSource.getCrs
- Defined in sources/AggregateImageSource.ts:93

getExtent

getExtent(): Extent | null
Returns the union of the extent of all the sub-sources, if possible. If at least one source does not have a known extent, then the entire aggregate extent is undefined.

Returns Extent | null
Overrides ImageSource.getExtent
- Defined in sources/AggregateImageSource.ts:117

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/AggregateImageSource.ts:198

getMemoryUsage

getMemoryUsage(context: GetMemoryUsageContext): void
Returns an approximation of the memory used by this object, in bytes.
Parameters
- context: GetMemoryUsageContext
Returns void
Overrides ImageSource.getMemoryUsage
- Defined in sources/AggregateImageSource.ts:135

initialize

initialize(options: { targetProjection: CoordinateSystem }): Promise<void>
Initializes the source.
Parameters
- options: { targetProjection: CoordinateSystem }
  Options.
Returns Promise<void>
A promise that resolves when the source is initialized.
Overrides ImageSource.initialize
- Defined in sources/AggregateImageSource.ts:85

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

setSourceVisibility

setSourceVisibility(source: ImageSource, visible: boolean): void
Sets the visibility of a sub-source. This will trigger a repaint of the source.
Parameters
- source: ImageSource
  The source to update.
- visible: boolean
  The new visibility.
Returns void
Throws
if the sub-source is not present in this source.
- Defined in sources/AggregateImageSource.ts:103

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 AggregateImageSource

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

sources: ImageSource<ImageSourceEvents>[]

Returns AggregateImageSource

Properties

ReadonlycontainsFn

datatype

ReadonlyflipY

ReadonlyisAggregateImageSource

ReadonlyisImageSource

ReadonlyisMemoryUsage

Readonlypriority

Readonlysynchronous

Readonlytransparent

Readonlytype

Accessors

colorSpace

Returns ColorSpace

sources

Returns readonly ImageSource<ImageSourceEvents>[]

Methods

adjustExtentAndPixelSize

Parameters

Returns GridExtent | null

contains

Parameters

Returns boolean

dispose

Returns void

getCrs

Returns CoordinateSystem

getExtent

Returns Extent | null

getImages

Parameters

Returns ImageResponse[]

getMemoryUsage

Parameters

Returns void

initialize

Parameters

Returns Promise<void>

intersects

Parameters

Returns boolean

setSourceVisibility

Parameters

Returns void

Throws

update

Parameters

Returns void

Settings

On This Page

`Readonly`containsFn

`Readonly`flipY

`Readonly`isAggregateImageSource

`Readonly`isImageSource

`Readonly`isMemoryUsage

`Readonly`priority

`Readonly`synchronous

`Readonly`transparent

`Readonly`type