Class ImageSource<Events>`Abstract`

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

Index

Constructors

constructor

Properties

containsFn datatype flipY isImageSource isMemoryUsage priority synchronous type

Accessors

colorSpace

Methods

addEventListener adjustExtentAndPixelSize contains dispatchEvent dispose getCrs getExtent getImages getMemoryUsage hasEventListener initialize intersects removeEventListener update

Constructors

constructor

new ImageSource<Events>(options?): ImageSource<Events>
Type Parameters
- Events extends ImageSourceEvents = ImageSourceEvents
Parameters
- options: ImageSourceOptions = {}
  Options.
Returns ImageSource<Events>
Overrides EventDispatcher.constructor
- Defined in sources/ImageSource.ts:155

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

type: string

Accessors

colorSpace

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

Returns ColorSpace
- Defined in sources/ImageSource.ts:178

Methods

addEventListener

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

adjustExtentAndPixelSize

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

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
- Defined in sources/ImageSource.ts:244

dispatchEvent

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

dispose

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

Returns void
- Defined in sources/ImageSource.ts:299

`Abstract`getCrs

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

Returns string
The CRS.
- Defined in sources/ImageSource.ts:218

`Abstract`getExtent

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

Returns Extent
The extent of the source.
- Defined in sources/ImageSource.ts:225

`Abstract`getImages

getImages(options): 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.
- Defined in sources/ImageSource.ts:293

getMemoryUsage

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

hasEventListener

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

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.
- Defined in sources/ImageSource.ts:278

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.
- Defined in sources/ImageSource.ts:261

removeEventListener

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

update

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

Class ImageSource<Events>Abstract

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ImageSource<Events>

Properties

ReadonlycontainsFn

datatype

ReadonlyflipY

ReadonlyisImageSource

ReadonlyisMemoryUsage

Readonlypriority

Readonlysynchronous

Readonlytype

Accessors

colorSpace

Returns ColorSpace

Methods

addEventListener

Type Parameters

Parameters

Returns void

adjustExtentAndPixelSize

Parameters

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

contains

Parameters

Returns boolean

dispatchEvent

Type Parameters

Parameters

Returns void

dispose

Returns void

AbstractgetCrs

Returns string

AbstractgetExtent

Returns Extent

AbstractgetImages

Parameters

Returns ImageResponse[]

getMemoryUsage

Parameters

Returns void

hasEventListener

Type Parameters

Parameters

Returns boolean

initialize

Parameters

targetProjection: string

Returns Promise<void>

intersects

Parameters

Returns boolean

removeEventListener

Type Parameters

Parameters

Returns void

update

Parameters

Returns void

Settings

On This Page

Class ImageSource<Events>`Abstract`

`Readonly`containsFn

`Readonly`flipY

`Readonly`isImageSource

`Readonly`isMemoryUsage

`Readonly`priority

`Readonly`synchronous

`Readonly`type

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

`Abstract`getCrs

`Abstract`getExtent

`Abstract`getImages