Class ImageSource`Abstract`

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

Hierarchy

EventDispatcher<ImageSourceEvents>
- ImageSource

Index

Constructors

constructor

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

Properties

`Private` `Readonly` _customColorSpace

_customColorSpace: ColorSpace

`Readonly` containsFn

containsFn: 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 = true

type

type: string

version

version: number

Accessors

colorSpace

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

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

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, ImageSource>
  
  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
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, ImageSource>
Returns void
Inherited from EventDispatcher.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
- Defined in sources/ImageSource.ts:169

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

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 EventDispatcher.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:84

dispose

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

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

`Abstract` getCrs

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

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

`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:195

`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:263

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, ImageSource>
  
  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:63
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, ImageSource>
Returns boolean
Inherited from EventDispatcher.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.
- Defined in sources/ImageSource.ts:248

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

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, ImageSource>
  
  The listener function that gets removed.
Returns void
Inherited from EventDispatcher.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, ImageSource>
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:78

update

update(): void
Raises an event to reload the source.

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

Class ImageSourceAbstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: ImageSourceOptions = {}

Returns ImageSource

Properties

Private Readonly _customColorSpace

Readonly containsFn

datatype

Readonly flipY

Readonly isImageSource

type

version

Accessors

colorSpace

Returns ColorSpace

Methods

addEventListener

Type Parameters

T extends "updated"

Parameters

type: T

listener: EventListener<ImageSourceEvents[T], T, ImageSource>

Returns void

Type Parameters

T extends string

Parameters

type: T

listener: EventListener<{}, T, ImageSource>

Returns void

adjustExtentAndPixelSize

Parameters

requestExtent: Extent

requestWidth: number

requestHeight: number

margin: number = 0

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

extent: Extent

height: number

width: number

contains

Parameters

extent: Extent

Returns boolean

dispatchEvent

Type Parameters

T extends "updated"

Parameters

event: BaseEvent<T> & ImageSourceEvents[T]

Returns void

dispose

Returns void

Abstract getCrs

Returns string

Abstract getExtent

Returns Extent

Abstract getImages

Parameters

options: GetImageOptions

Returns ImageResponse[]

hasEventListener

Type Parameters

T extends "updated"

Parameters

type: T

listener: EventListener<ImageSourceEvents[T], T, ImageSource>

Returns boolean

Type Parameters

T extends string

Parameters

type: T

listener: EventListener<{}, T, ImageSource>

Returns boolean

Class ImageSource`Abstract`

`Private` `Readonly` _customColorSpace

`Readonly` containsFn

`Readonly` flipY

`Readonly` isImageSource

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

`Abstract` getCrs

`Abstract` getExtent

`Abstract` getImages

options: {
targetProjection: string;
}