Class TiledImageSource

An image source powered by OpenLayers to load tiled images. Supports all subclasses of the OpenLayers TileSource.

If the tiles of the source are in a format that is not supported directly by the browser, i.e not JPG/PNG/WebP, then you must pass a decoder with the format constructor option.

To filter out no-data pixels, you may pass the noDataValue option in the constructor.

Example

// To create a source based on the Stamen OpenLayers source, with the 'toner' style.
const source = new TiledImageSource({
     source: new Stamen({ layer: 'toner' })
});

// To create a WMS source that downloads TIFF images, eliminating all pixels that have the
// value -9999 and replacing them with transparent pixels.
const source = new TiledImageSource({
     source: new TileWMS({
         url: 'http://example.com/wms',
         params: {
             LAYERS: 'theLayer',
             FORMAT: 'image/tiff',
         },
         projection: 'EPSG:3946',
         crossOrigin: 'anonymous',
         version: '1.3.0',
     }),
     format: new GeoTIFFFormat(),
     noDataValue: -9999,
});

Hierarchy (view full)

ImageSource
- TiledImageSource
  - WmsSource
  - WmtsSource

Constructors

constructor

new TiledImageSource(options): TiledImageSource
Parameters
- options: TiledImageSourceOptions
  The options.
Returns TiledImageSource
Overrides ImageSource.constructor
- Defined in sources/TiledImageSource.ts:123

Properties

`Readonly`containsFn

containsFn: undefined | CustomContainsFn

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

format: undefined | ImageFormat

`Readonly`isImageSource

isImageSource: boolean = true

`Readonly`isMemoryUsage

isMemoryUsage: true = ...

Readonly flag to indicate that his object implements MemoryUsage.

`Readonly`isTiledImageSource

isTiledImageSource: true = ...

`Readonly`noDataValue

noDataValue: undefined | number

`Readonly`olprojection

olprojection: Projection

`Readonly`source

source: UrlTile

`Readonly`synchronous

synchronous: boolean = false

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

`Readonly`type

type: "TiledImageSource" = ...

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:170

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends "updated"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<ImageSourceEvents[T], T, TiledImageSource>
  The function that gets called when the event is fired.
Returns void
Inherited from ImageSource.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:52
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, TiledImageSource>
Returns void
Inherited from ImageSource.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:56

adjustExtentAndPixelSize

adjustExtentAndPixelSize(requestExtent, requestWidth, requestHeight, margin?): {
    extent: Extent;
    height: number;
    width: number;
}
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 {
    extent: Extent;
    height: number;
    width: number;
}
The adjusted parameters.
- extent: Extent
- height: number
- width: number
Overrides ImageSource.adjustExtentAndPixelSize
- Defined in sources/TiledImageSource.ts:163

contains

contains(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:236

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends "updated"
Parameters
- event: BaseEvent<T> & ImageSourceEvents[T]
  The event that gets fired.
Returns void
Inherited from ImageSource.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:84

dispose

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

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

getCrs

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

Returns string
The CRS.
Overrides ImageSource.getCrs
- Defined in sources/TiledImageSource.ts:159

getExtent

getExtent(): Extent
Returns the extent of this source expressed in the CRS of the source.

Returns Extent
The extent of the source.
Overrides ImageSource.getExtent
- Defined in sources/TiledImageSource.ts:155

getImages

getImages(options): {
id: string;
request: (() => Promise<ImageResult>);
}[]
Gets the images for the specified extent and pixel size.
Parameters
- options: GetImageOptions
  The options.
Returns {
id: string;
request: (() => Promise<ImageResult>);
}[]
An array containing the functions to generate the images asynchronously.
Overrides ImageSource.getImages
- Defined in sources/TiledImageSource.ts:246

getMemoryUsage

getMemoryUsage(_context): 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:163

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends "updated"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<ImageSourceEvents[T], T, TiledImageSource>
  The function that gets called when the event is fired.
Returns boolean
Inherited from ImageSource.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:63
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, TiledImageSource>
Returns boolean
Inherited from ImageSource.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:67

initialize

initialize(options): Promise<void>
Initializes the source.
Parameters
- options: {
  targetProjection: string;
  }
  Options.
  - targetProjection: string
    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:270

intersects

intersects(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:253

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends "updated"
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<ImageSourceEvents[T], T, TiledImageSource>
  The listener function that gets removed.
Returns void
Inherited from ImageSource.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:74
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, TiledImageSource>
Returns void
Inherited from ImageSource.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:78

update

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

Class TiledImageSource

Example

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TiledImageSource

Properties

ReadonlycontainsFn

datatype

ReadonlyflipY

Readonlyformat

ReadonlyisImageSource

ReadonlyisMemoryUsage

ReadonlyisTiledImageSource

ReadonlynoDataValue

Readonlyolprojection

Readonlysource

Readonlysynchronous

Readonlytype

Accessors

colorSpace

Returns ColorSpace

Methods

addEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

adjustExtentAndPixelSize

Parameters

Returns { extent: Extent; height: number; width: number; }

extent: Extent

height: number

width: number

contains

Parameters

Returns boolean

dispatchEvent

Type Parameters

Parameters

Returns void

dispose

Returns void

getCrs

Returns string

getExtent

Returns Extent

getImages

Parameters

Returns { id: string; request: (() => Promise<ImageResult>); }[]

getMemoryUsage

Parameters

Returns void

hasEventListener

Type Parameters

Parameters

Returns boolean

Type Parameters

Parameters

Returns boolean

initialize

Parameters

targetProjection: string

Returns Promise<void>

intersects

Parameters

Returns boolean

removeEventListener

Type Parameters

Parameters

Returns void

Type Parameters

`Readonly`containsFn

`Readonly`flipY

`Readonly`format

`Readonly`isImageSource

`Readonly`isMemoryUsage

`Readonly`isTiledImageSource

`Readonly`noDataValue

`Readonly`olprojection

`Readonly`source

`Readonly`synchronous

`Readonly`type

Returns {
extent: Extent;
height: number;
width: number;
}

Returns {
id: string;
request: (() => Promise<ImageResult>);
}[]