ZarrLayerProvider

Imagery provider for rendering Zarr datasets as Cesium imagery tiles.

Remarks

This class implements the Cesium ImageryProvider interface and manages reading, slicing, and WebGL rendering of Zarr-based raster data.

Example

const provider = new ZarrLayerProvider({
  url: 'https://example.com/my.zarr',
  variable: 'temperature',
  scale: [0, 40],
  colormap: 'jet'
});
const imageryLayer = new ZarrImageryLayer(provider);
viewer.imageryLayers.add(imageryLayer);

See

ZarrImageryLayer

Implements

• ImageryProvider

Accessors

credit

Get Signature

get credit(): Credit;

Credit information for the imagery provider.

Returns

Credit

Implementation of

ImageryProvider.credit

---

hasAlphaChannel

Get Signature

get hasAlphaChannel(): boolean;

Indicates whether the imagery has an alpha channel.

Returns

boolean

Implementation of

ImageryProvider.hasAlphaChannel

---

maximumLevel

Get Signature

get maximumLevel(): number;

Maximum zoom level supported by the provider.

Returns

number

Implementation of

ImageryProvider.maximumLevel

---

minimumLevel

Get Signature

get minimumLevel(): number;

Minimum zoom level supported by the provider.

Returns

number

Implementation of

ImageryProvider.minimumLevel

---

ready

Get Signature

get ready(): boolean;

Indicates whether the provider is fully initialized and ready.

Returns

boolean

---

readyPromise

Get Signature

get readyPromise(): Promise<boolean>;

Promise that resolves when the provider is fully initialized.

Returns

Promise<boolean>

---

rectangle

Get Signature

get rectangle(): Rectangle;

Geographic coverage rectangle of the imagery provider.

Returns

Rectangle

Implementation of

ImageryProvider.rectangle

---

tileHeight

Get Signature

get tileHeight(): number;

Height of each tile, in pixels.

Returns

number

Implementation of

ImageryProvider.tileHeight

---

tileWidth

Get Signature

get tileWidth(): number;

Width of each tile, in pixels.

Returns

number

Implementation of

ImageryProvider.tileWidth

---

tilingScheme

Get Signature

get tilingScheme(): TilingScheme;

Tiling scheme used by the imagery provider.

Returns

TilingScheme

Implementation of

ImageryProvider.tilingScheme

Constructors

Constructor

new ZarrLayerProvider(options): ZarrLayerProvider;

Parameters

Parameter	Type
options	LayerOptions

Returns

ZarrLayerProvider

Methods

destroy()

destroy(): void;

Cleans up resources used by the imagery provider.

Returns

void

---

getTileCredits()

getTileCredits(
   x, 
   y, 
   level): Credit[];

Retrieves the credits for a specific tile.

Parameters

Parameter	Type	Description
x	number	Tile x coordinate.
y	number	Tile y coordinate.
level	number	Zoom level.

Returns

Credit[]

An array of credits associated with the tile.

Implementation of

ImageryProvider.getTileCredits

---

pickFeatures()

pickFeatures(): undefined;

Picks features at a given geographic location.

Returns

undefined

Implementation of

ImageryProvider.pickFeatures

---

requestImage()

requestImage(
   x, 
   y, 
level): Promise<HTMLCanvasElement | ImageBitmap>;

Requests a rendered image tile from the Zarr dataset.

Parameters

Parameter	Type	Description
x	number	Tile x coordinate.
y	number	Tile y coordinate.
level	number	Zoom level.

Returns

Promise<HTMLCanvasElement | ImageBitmap>

A rendered tile as an HTMLCanvasElement or ImageBitmap.

Implementation of

ImageryProvider.requestImage

---

updateSelectors()

updateSelectors(selectors): boolean;

Updates the selectors for slicing dimensions.

Parameters

Parameter	Type	Description
selectors	{ [key: string]: ZarrSelectorsProps; }	New selectors mapping. See ZarrSelectorsProps.

Returns

boolean

true if any changes were applied, otherwise false.

---

updateStyle()

updateStyle(options): boolean;

Updates the visualization style for the imagery provider.

Parameters

Parameter	Type	Description
options	{ colormap?: string; scale?: [number, number]; }	Parameters to update.
options.colormap?	string	New colormap name. See ColorMapName.
options.scale?	[number, number]	New [min, max] scale range.

Returns

boolean

true if any changes were applied, otherwise false.

---

createLayer()

static createLayer(viewer, options): Promise<ZarrImageryLayer>;

Creates a Cesium imagery layer from the given viewer and Zarr options.

Parameters

Parameter	Type	Description
viewer	Viewer	Cesium viewer instance.
options	LayerOptions	Layer options (see LayerOptions).

Returns

Promise<ZarrImageryLayer>

A promise that resolves to a ZarrImageryLayer.

Properties

dimensionValues

dimensionValues: DimensionValues = {};

Values of the data coordinate dimensions (latitude, longitude, elevation, etc.).

---

errorEvent

errorEvent: Event<(...args) => void>;

Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing to the event, you will be notified of the error and can potentially recover from it. Event listeners are passed an instance of TileProviderError.

Implementation of

ImageryProvider.errorEvent

---

proxy

proxy: DefaultProxy;

Gets the proxy used by this provider.

Implementation of

ImageryProvider.proxy

---

selectors

selectors: object;

User-defined selectors for slicing dimensions.

Index Signature

[key: string]: ZarrSelectorsProps

---

tileDiscardPolicy

tileDiscardPolicy: NeverTileDiscardPolicy;

Gets the tile discard policy. If not undefined, the discard policy is responsible for filtering out "missing" tiles via its shouldDiscardImage function. If this function returns undefined, no tiles are filtered.

Implementation of

ImageryProvider.tileDiscardPolicy