Class ColorLayer<UserData>

A layer that produces color images, such as vector data, or satellite imagery.

Index

Constructors

constructor

Properties

backgroundColor colorMap computeMinMax extent frozen id interpretation isColorLayer isLayer isMemoryUsage isPickableFeatures name noDataOptions resolutionFactor showEmptyTextures showTileBorders source type userData

Accessors

blendingMode brightness colorimetry contrast elevationRange instance loading opacity progress ready saturation visible

Constructors

constructor

new ColorLayer<UserData>(options): ColorLayer<UserData>
Creates a color layer. See the example for more information on layer creation.
Type Parameters
- UserData extends LayerUserData = LayerUserData
Parameters
- options: ColorLayerOptions
  The layer options.
Returns ColorLayer<UserData>
Overrides Layer.constructor
- Defined in core/layer/ColorLayer.ts:83

Properties

backgroundColor

backgroundColor: Color

`Readonly`colorMap

colorMap: null | ColorMap = null

The colormap of this layer

`Readonly`computeMinMax

computeMinMax: boolean

`Readonly`extent

extent: null | Extent = null

The extent of this layer

frozen

frozen: boolean = false

Disables automatic updates of this layer. Useful for debugging purposes.

`Readonly`id

id: string

The unique identifier of this layer.

`Readonly`interpretation

interpretation: Interpretation

`Readonly`isColorLayer

isColorLayer: boolean = true

Read-only flag to check if a given object is of type ColorLayer.

`Readonly`isLayer

isLayer: boolean = true

Read-only flag to check if a given object is of type Layer.

`Readonly`isMemoryUsage

isMemoryUsage: true = ...

Readonly flag to indicate that his object implements MemoryUsage.

`Readonly`isPickableFeatures

isPickableFeatures = true

`Readonly`name

name: undefined | string

Optional name of this layer.

`Readonly`noDataOptions

noDataOptions: NoDataOptions

`Readonly`resolutionFactor

resolutionFactor: number

The resolution factor applied to the textures generated by this layer.

`Readonly`showEmptyTextures

showEmptyTextures: boolean

`Readonly`showTileBorders

showTileBorders: boolean

`Readonly`source

source: ImageSource<ImageSourceEvents>

The source of this layer

type

type: string

`Readonly`userData

userData: UserData

An object that can be used to store custom data about the Layer.

Accessors

blendingMode

get blendingMode(): BlendingMode
Gets or sets the blending mode of this layer.

Returns BlendingMode
- Defined in core/layer/ColorLayer.ts:109
set blendingMode(v): void
Parameters
- v: BlendingMode
Returns void
- Defined in core/layer/ColorLayer.ts:113

brightness

get brightness(): number
Gets or sets the brightness of this layer.

Returns number
- Defined in core/layer/ColorLayer.ts:144
set brightness(v): void
Parameters
- v: number
Returns void
- Defined in core/layer/ColorLayer.ts:148

colorimetry

get colorimetry(): ColorimetryOptions
Gets the colorimetry parameters of this layer.

Returns ColorimetryOptions
- Defined in core/layer/ColorLayer.ts:137

contrast

get contrast(): number
Gets or sets the contrast of this layer.

Returns number
- Defined in core/layer/ColorLayer.ts:158
set contrast(v): void
Parameters
- v: number
Returns void
- Defined in core/layer/ColorLayer.ts:162

elevationRange

get elevationRange(): null | ElevationRange
Gets the elevation range of this layer, if any.

Returns null | ElevationRange
- Defined in core/layer/ColorLayer.ts:94
set elevationRange(range): void
Sets the elevation range of this layer. Setting it to null removes the elevation range.
Parameters
- range: null | ElevationRange
Returns void
- Defined in core/layer/ColorLayer.ts:101

`Protected`instance

get instance(): Instance
Returns Instance
Inherited from Layer.instance
- Defined in core/layer/Layer.ts:625

loading

get loading(): boolean
Gets whether the object is currently performing an asynchronous operation.

Returns boolean
Inherited from Layer.loading
- Defined in core/layer/Layer.ts:577

opacity

get opacity(): number
Gets or sets the opacity of this layer.

Returns number
- Defined in core/layer/ColorLayer.ts:123
set opacity(v): void
Parameters
- v: number
Returns void
- Defined in core/layer/ColorLayer.ts:127

progress

get progress(): number
Returns the percentage of progress, in normalized value (i.e in the [0, 1] range), of the asynchronous operations that are scheduled to run on this object. 1 means that all operations have finished.

Returns number
Inherited from Layer.progress
- Defined in core/layer/Layer.ts:581

ready

get ready(): boolean
Returns boolean
Inherited from Layer.ready
- Defined in core/layer/Layer.ts:442

saturation

get saturation(): number
Gets or sets the saturation of this layer.

Returns number
- Defined in core/layer/ColorLayer.ts:172
set saturation(v): void
Parameters
- v: number
Returns void
- Defined in core/layer/ColorLayer.ts:176

visible

get visible(): boolean
Gets or sets the visibility of this layer.

Returns boolean
Inherited from Layer.visible
- Defined in core/layer/Layer.ts:565
set visible(v): void
Parameters
- v: boolean
Returns void
Inherited from Layer.visible
- Defined in core/layer/Layer.ts:569

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends
      | "dispose"
      | "visible-property-changed"
      | "node-complete"
      | "opacity-property-changed"
      | "brightness-property-changed"
      | "contrast-property-changed"
      | "saturation-property-changed"
      | "elevationRange-property-changed"
      | "blendingMode-property-changed"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<(ColorLayerEvents & LayerEvents)[T], T, ColorLayer<UserData>>
  The function that gets called when the event is fired.
Returns void
Inherited from Layer.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:52

`Protected`adjustExtent

adjustExtent(extent): Extent
Parameters
- extent: Extent
Returns Extent
Inherited from Layer.adjustExtent
- Defined in core/layer/Layer.ts:925

`Protected`adjustExtentAndPixelSize

adjustExtentAndPixelSize(originalExtent, originalWidth, originalHeight): {
    extent: Extent;
    height: number;
    width: number;
}
Adjusts the extent to avoid visual artifacts.
Parameters
- originalExtent: Extent
  The original extent.
- originalWidth: number
  The width, in pixels, of the original extent.
- originalHeight: number
  The height, in pixels, of the original extent.
Returns {
    extent: Extent;
    height: number;
    width: number;
}
And object containing the adjusted extent, as well as adjusted pixel size.
- extent: Extent
- height: number
- width: number
Inherited from Layer.adjustExtentAndPixelSize
- Defined in core/layer/Layer.ts:937

`Protected`applyEmptyTextureToNode

applyEmptyTextureToNode(target): void
Parameters
- target: Target
Returns void
Overrides Layer.applyEmptyTextureToNode
- Defined in core/layer/ColorLayer.ts:231

`Protected`applyInterimTexture

applyInterimTexture(target): void
Immediately applies a temporary texture to the target while the actual texture is being asynchronously processed, to avoid displaying a black texture.
Parameters
- target: Target
Returns void
Inherited from Layer.applyInterimTexture
- Defined in core/layer/Layer.ts:1146

`Protected`applyTextureToNode

applyTextureToNode(result, target): void
Parameters
- result: TextureAndPitch
- target: Target
Returns void
Overrides Layer.applyTextureToNode
- Defined in core/layer/ColorLayer.ts:221

clear

clear(extent?): void
Resets all render targets to a blank state and repaint all the targets.
Parameters
- Optionalextent: Extent
  An optional extent to limit the region to clear.
Returns void
Inherited from Layer.clear
- Defined in core/layer/Layer.ts:536

contains

contains(extent): boolean
Parameters
- extent: Extent
  The extent to test.
Returns boolean
true if this layer contains the specified extent, false otherwise.
Inherited from Layer.contains
- Defined in core/layer/Layer.ts:1418

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends
      | "dispose"
      | "visible-property-changed"
      | "node-complete"
      | "opacity-property-changed"
      | "brightness-property-changed"
      | "contrast-property-changed"
      | "saturation-property-changed"
      | "elevationRange-property-changed"
      | "blendingMode-property-changed"
Parameters
- event: BaseEvent<T> & (ColorLayerEvents & LayerEvents)[T]
  The event that gets fired.
Returns void
Inherited from Layer.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:81

dispose

dispose(): void
Disposes the layer. This releases all resources held by this layer.

Returns void
Inherited from Layer.dispose
- Defined in core/layer/Layer.ts:1527

getExtent

getExtent(): undefined | Extent
Returns the final extent of this layer. If this layer has its own extent defined, this will be used. Otherwise, will return the source extent (if any). May return undefined if not pre-processed yet.

Returns undefined | Extent
The layer final extent.
Inherited from Layer.getExtent
- Defined in core/layer/Layer.ts:677

getMemoryUsage

getMemoryUsage(context): void
Returns an approximation of the memory used by this object, in bytes.
Parameters
- context: GetMemoryUsageContext
  The graphics context.
Returns void
Inherited from Layer.getMemoryUsage
- Defined in core/layer/Layer.ts:446

getRenderTargetDataType

getRenderTargetDataType(): TextureDataType
Returns TextureDataType
Overrides Layer.getRenderTargetDataType
- Defined in core/layer/ColorLayer.ts:198

getRenderTargetPixelFormat

getRenderTargetPixelFormat(): PixelFormat
Returns PixelFormat
Overrides Layer.getRenderTargetPixelFormat
- Defined in core/layer/ColorLayer.ts:207

getVectorFeaturesAtCoordinate

getVectorFeaturesAtCoordinate(coordinate, options?): Feature<Geometry>[]
Returns all features at some coordinates, with an optional hit tolerance radius.
Parameters
- coordinate: Coordinates
  Coordinates
- Optionaloptions: {
      radius?: number;
      xTileRes?: number;
      yTileRes?: number;
  }
  Options
  - Optionalradius?: number
    Radius in pixels. Pixels inside the radius around the given coordinates will be checked for features.
  - OptionalxTileRes?: number
    Tile resolution (m/px) - only required if radius is greater than 0
  - OptionalyTileRes?: number
    Tile resolution (m/px) - only required if radius is greater than 0
Returns Feature<Geometry>[]
Array of features at coordinates (can be empty)
- Defined in core/layer/ColorLayer.ts:269

getVectorFeaturesInExtent

getVectorFeaturesInExtent(extent): Feature<Geometry>[]
Get all features whose bounding box intersects the provided extent. Note that this returns an array of all features intersecting the given extent in random order (so it may include features whose geometries do not intersect the extent).
Parameters
- extent: Extent
  Extent
Returns Feature<Geometry>[]
Array of features intersecting the extent (can be empty)
- Defined in core/layer/ColorLayer.ts:360

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends
      | "dispose"
      | "visible-property-changed"
      | "node-complete"
      | "opacity-property-changed"
      | "brightness-property-changed"
      | "contrast-property-changed"
      | "saturation-property-changed"
      | "elevationRange-property-changed"
      | "blendingMode-property-changed"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<(ColorLayerEvents & LayerEvents)[T], T, ColorLayer<UserData>>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Layer.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:62

isLoaded

isLoaded(nodeId): boolean
Returns true if this layer has loaded data for this node.
Parameters
- nodeId: number
Returns boolean
Inherited from Layer.isLoaded
- Defined in core/layer/Layer.ts:1508

loadFallbackImages

loadFallbackImages(): Promise<void>
Returns Promise<void>
Inherited from Layer.loadFallbackImages
- Defined in core/layer/Layer.ts:741

loadFallbackImagesInternal

loadFallbackImagesInternal(): Promise<void>
Returns Promise<void>
Inherited from Layer.loadFallbackImagesInternal
- Defined in core/layer/Layer.ts:686

`Protected`onInitialized

onInitialized(): Promise<void>
Called when the layer has finished initializing.

Returns Promise<void>
Inherited from Layer.onInitialized
- Defined in core/layer/Layer.ts:757

onRenderingContextLost

onRenderingContextLost(): void
Called when the rendering context has been lost.

Returns void
Inherited from Layer.onRenderingContextLost
- Defined in core/layer/Layer.ts:524

onRenderingContextRestored

onRenderingContextRestored(): void
Called when the rendering context has been restored.

Returns void
Inherited from Layer.onRenderingContextRestored
- Defined in core/layer/Layer.ts:528

`Protected`onTextureCreated

onTextureCreated(texture): void
Parameters
- texture: Texture
Returns void
Inherited from Layer.onTextureCreated
- Defined in core/layer/Layer.ts:726

pickFeaturesFrom

pickFeaturesFrom(pickedResult, options?): VectorPickFeature[]
Given a PickResult, returns and assigns its features.

Implementations must set pickedResult.features to the returned result.
Parameters
- pickedResult: MapPickResult<unknown>
  Picked result
- Optionaloptions: PickOptions
  Options
Returns VectorPickFeature[]
Features
Implementation of PickableFeatures.pickFeaturesFrom
- Defined in core/layer/ColorLayer.ts:235

postUpdate

postUpdate(): void
Returns void
Inherited from Layer.postUpdate
- Defined in core/layer/Layer.ts:1484

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends
      | "dispose"
      | "visible-property-changed"
      | "node-complete"
      | "opacity-property-changed"
      | "brightness-property-changed"
      | "contrast-property-changed"
      | "saturation-property-changed"
      | "elevationRange-property-changed"
      | "blendingMode-property-changed"
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<(ColorLayerEvents & LayerEvents)[T], T, ColorLayer<UserData>>
  The listener function that gets removed.
Returns void
Inherited from Layer.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:72

unregisterNode

unregisterNode(node): void
Removes the node from this layer.
Parameters
- node: LayerNode
  The disposed node.
Returns void
Overrides Layer.unregisterNode
- Defined in core/layer/ColorLayer.ts:211

update

update(context, node): void
Updates the provided node with content from this layer.
Parameters
- context: Context
  the context
- node: LayerNode
  the node to update
Returns void
Inherited from Layer.update
- Defined in core/layer/Layer.ts:1343

`Protected`updateMaterial

updateMaterial(material): void
Parameters
- material: LayerNodeMaterial
Returns void
Overrides Layer.updateMaterial
- Defined in core/layer/ColorLayer.ts:183

Class ColorLayer<UserData>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ColorLayer<UserData>

Properties

backgroundColor

ReadonlycolorMap

ReadonlycomputeMinMax

Readonlyextent

frozen

Readonlyid

Readonlyinterpretation

ReadonlyisColorLayer

ReadonlyisLayer

ReadonlyisMemoryUsage

ReadonlyisPickableFeatures

Readonlyname

ReadonlynoDataOptions

ReadonlyresolutionFactor

ReadonlyshowEmptyTextures

ReadonlyshowTileBorders

Readonlysource

type

ReadonlyuserData

Accessors

blendingMode

Returns BlendingMode

Parameters

Returns void

brightness

Returns number

Parameters

Returns void

colorimetry

Returns ColorimetryOptions

contrast

Returns number

Parameters

Returns void

elevationRange

Returns null | ElevationRange

Parameters

Returns void

Protectedinstance

Returns Instance

loading

Returns boolean

opacity

Returns number

Parameters

Returns void

progress

Returns number

ready

Returns boolean

saturation

Returns number

Parameters

Returns void

visible

Returns boolean

Parameters

Returns void

Methods

addEventListener

Type Parameters

Parameters

Returns void

ProtectedadjustExtent

Parameters

`Readonly`colorMap

`Readonly`computeMinMax

`Readonly`extent

`Readonly`id

`Readonly`interpretation

`Readonly`isColorLayer

`Readonly`isLayer

`Readonly`isMemoryUsage

`Readonly`isPickableFeatures

`Readonly`name

`Readonly`noDataOptions

`Readonly`resolutionFactor

`Readonly`showEmptyTextures

`Readonly`showTileBorders

`Readonly`source

`Readonly`userData

`Protected`instance

`Protected`adjustExtent

`Protected`adjustExtentAndPixelSize

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

`Protected`applyEmptyTextureToNode

`Protected`applyInterimTexture

`Protected`applyTextureToNode

`Optional`radius?: number

`Optional`xTileRes?: number

`Optional`yTileRes?: number

`Protected`onInitialized

`Protected`onTextureCreated