API Reference

Classes

Class	Description
ZarrCubeProvider	Provides rendering of volumetric (3D) Zarr datasets as Cesium primitives.
ZarrCubeVelocityProvider	Provider responsible for loading and rendering 3D velocity fields (U and V components) from Zarr datasets as animated Cesium WindLayers.
ZarrImageryLayer	Custom Cesium imagery layer for Zarr datasets.
ZarrLayerProvider	Imagery provider for rendering Zarr datasets as Cesium imagery tiles.

Interfaces

Interface	Description
BoundsProps	Geographic bounding box definition (degrees).
ColorMapInfo	Structure of the global color map registry.
ColorScaleProps	Describes a numerical-to-color mapping for visualizing scalar fields.
CubeOptions	Configuration for a 3D cube visualization (volumetric rendering).
CubeVelocityProps	Represents the in-memory structure of a velocity field slice.
DataSliceProps	Describes a slice of a multidimensional array.
DimensionNamesProps	Describes the mapping between dataset dimensions and their standardized names.
DimensionValues	Mapping of dimension names to their corresponding coordinate arrays.
DimIndicesProps	Maps dimension keys to their indices and associated coordinate arrays.
LayerOptions	Configuration for a 2D raster (image) layer visualization.
VelocityOptions	Configuration for a vector (velocity) visualization layer.
XYLimits	Describes the XY coordinate boundaries of a dataset.
XYLimitsProps	Alias of XYLimits with explicit type name for Zarr coordinate bounds.
ZarrLevelMetadata	Metadata for a single multiscale level in a Zarr dataset.
ZarrSelectorsProps	Describes a selector for a Zarr dataset dimension.

Functions

Function	Description
calculateElevationSlice	Determines the index range of the elevation axis to load from a Zarr cube.
calculateHeightMeters	Converts elevation index to Cesium height (meters), applying vertical exaggeration and optional below-sea-level offset.
calculateNearestIndex	Finds the index of the value in values nearest to target.
calculateSliceArgs	Constructs Zarr slice arguments for extracting a subregion of a multidimensional array.
calculateSliceArgsRequestImage	Constructs Zarr slice arguments for extracting a subregion of a multidimensional array.
calculateXYFromBounds	Converts geographic bounds (lat/lon) to pixel-space indices for slicing Zarr arrays. Supports both EPSG:4326 and EPSG:3857 projections.
colormapBuilder	Builds a color ramp (discrete or continuous) from a specified colormap.
colorScaleByName	Returns a color scale function for a given colormap name.
createColorRampTexture	Creates a flexible 1D color-ramp texture supporting either normalized (0–1) or integer (0–255) color definitions.
createProgram	Creates and links a WebGL program using the specified vertex and fragment shaders.
createShader	Creates and compiles a WebGL shader from source code.
deriveRectangleAndScheme	Computes a Cesium Rectangle and TilingScheme for a Zarr dataset.
detectBrowser	Detects the current browser based on the user agent string.
detectCRS	Detects the coordinate reference system (CRS) of a Zarr dataset based on metadata or coordinate range. Defaults to EPSG:4326 (WGS84) if uncertain.
extractNoDataMetadata	Extracts no-data related metadata from a Zarr array's attributes.
getCubeDimensions	Computes cube dimension ordering and strides based on dimension indices. Useful for reshaping 3D Zarr arrays into Cesium-renderable layouts.
getXYLimits	Retrieve the geographic coordinate limits (min/max latitude/longitude) for a Zarr array.
identifyDimensionIndices	Identify the indices of common dimensions (lat, lon, time, elevation) in a Zarr array, optionally using CF-compliant standard names or custom dimension mappings.
initZarrDataset	Opens a Zarr variable (single-scale or multiscale pyramid) and prepares its metadata.
latDegToMercY	Converts a latitude value (in degrees) to Web Mercator Y coordinate (in meters).
loadDimensionValues	Loads the coordinate values for a specific dimension.
lonDegToMercX	Converts a longitude in degrees into a Web Mercator X coordinate (meters).
openLevelArray	Opens and caches a specific multiscale level array. Keeps a small LRU-style cache of up to three levels.
resolveNoDataRange	Resolves the no-data value range for masking dataset values.
updateImgData	Updates an ImageData object with a new pixel color derived from a numeric value and a ColorScaleProps colormap.
validateBounds	Validates whether geographic bounds are logically consistent.

Type Aliases

Type Alias	Description
BrowserName	Supported browser names for compatibility checks.
CalendarDate	Represents a date in a calendar system.
CFCalendar	Supported CF calendar types.
ColorMapName	Type representing valid color map names. The values are derived from the allColorScales array imported from the jsColormaps module and are based on matplotlib colormap (https://matplotlib.org/stable/users/explain/colors/colormaps.html).
CRS	Supported Coordinate Reference Systems.
SliceArgs	Represents a multidimensional slice argument for Zarr array indexing.