API Reference
Classes
| Class | Description |
|---|---|
| CubeGpuRenderer | Low-level Cesium primitive that keeps cube values and colormapping on the GPU. |
| TileDataCache | A simple LRU cache for tile data. The cache is keyed by a string, which is typically a combination of the layer ID and tile coordinates. |
| ZarrCubeDataProvider | Loads and spatially subsets a three-dimensional Zarr variable without rendering it. |
| 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 | Cesium imagery layer backed by a shared ZarrTileProvider. |
| ZarrLayerProvider | Thin Cesium adapter around the framework-independent Zarr tile renderer. Dataset loading, slicing, styling, caching, and WebGL rendering live in zarr-maps-tiling. This class only translates Cesium tile requests. |
| ZarrTileProvider | Provides Zarr dataset access and rendering capabilities for web-map layers. |
Interfaces
| Interface | Description |
|---|---|
| BoundsProps | Geographic bounding box definition (degrees). |
| ColorMapInfo | Structure of the global color map registry. |
| ColorScaleProps | Numerical range and colors used to render a scalar field. |
| CubeGpuRendererOptions | - |
| CubeOptions | - |
| CubeVelocityProps | - |
| 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. |
| FullTransectResult | A distance-by-elevation transect. Values are indexed [elevation][position]. |
| FullTransectStreamChunk | A streamed full-depth transect chunk. |
| LayerOptions | - |
| QueryBackend | Minimal interface required by the framework-neutral convenience queries. |
| QueryMultiPolygonGeometry | GeoJSON multipolygon geometry, reserved for region-query support. |
| QueryOptions | Controls a shared Zarr data query. |
| QueryPointGeometry | GeoJSON point geometry expressed as WGS84 longitude and latitude. |
| QueryPolygonGeometry | GeoJSON polygon geometry, reserved for region-query support. |
| QueryResult | Values and coordinates returned from a shared Zarr query. |
| QueryStreamOptions | Controls how many coordinates are returned by each streamed query chunk. |
| RequestOverrides | Serializable static fetch options suitable for application state and FetchStore. |
| RequestParameters | - |
| ResolvedCRS | Validated transformation between WGS84 and a rectilinear source grid. |
| ResolvedValueMetadata | Fully resolved packing and no-data metadata for a numeric Zarr variable. |
| TileCacheOptions | Controls the in-memory cache used to recolor tiles without reading Zarr data again. |
| TileCacheStats | Runtime counters for a provider's decoded tile cache. |
| TransectQueryOptions | Sampling controls for one-level and full-depth transects. |
| TransectResult | A one-level transect. Values preserve no-data gaps as null. |
| TransectStreamChunk | A streamed one-level transect chunk. |
| VelocityOptions | - |
| VelocityQueryResult | Values and coordinates returned from a shared Zarr query. |
| XYLimits | Describes the XY coordinate boundaries of a dataset. |
| XYLimitsProps | Alias of XYLimits with explicit type name for Zarr coordinate bounds. |
| ZarrCubeData | - |
| ZarrCubeDataOptions | - |
| ZarrLevelMetadata | Metadata for a single multiscale level in a Zarr dataset. |
| ZarrSelectors | Describes a selector for a Zarr dataset dimension. |
| ZarrSelectorsProps | - |
| ZarrTileOptions | Framework-neutral options for the shared 2D Zarr tile renderer. |
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. |
| colormapBuilder | Builds a color ramp (discrete or continuous) from a specified colormap. |
| createColorRampTexture | Creates a flexible 1D color-ramp texture supporting either normalized (0–1) or integer (0–255) color definitions. |
| createFetchStore | Creates a Zarrita FetchStore with optional static and dynamic request settings. |
| createProgram | Creates and links a WebGL program using the specified vertex and fragment shaders. |
| createShader | Creates and compiles a WebGL shader from source code. |
| createTransformedFetch | Creates a fetch implementation that applies dynamic request configuration. |
| decodeCFTime | Decodes CF-compliant time coordinate values into ISO date strings. |
| defaultTileCacheBytes | Selects a conservative per-layer budget while allowing up to five active layers. deviceMemory is deliberately treated as a hint, not an allowance. |
| 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. |
| getFullTransect | Queries all elevation levels along a line between two WGS84 positions. |
| getTimeSeries | Queries every time coordinate at one point and the selected elevation. |
| getTransect | Queries one scalar level along a line between two WGS84 positions. |
| getVerticalProfile | Queries every elevation coordinate at one point and the selected time. |
| getXYLimits | Retrieve the geographic coordinate limits (min/max latitude/longitude) for a Zarr array. |
| getZarrData | Reads an array with the same Zarrita module instance that opened it. Zarrita 0.7 keeps array decoding context module-local, so consumers must not call a separately resolved copy of zarrita.get on arrays returned here. |
| 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 | - |
| limitStoreRequests | Wrap a Zarrita store so all reads share one request-concurrency budget. |
| loadDimensionValues | Loads the coordinate values for a specific dimension. |
| lonDegToMercX | - |
| openLevelArray | Opens and caches a specific multiscale level array. Keeps a small LRU-style cache of up to three levels. |
| parseCFUnits | Parses a CF-compliant units string into its components. |
| resolveCRS | Resolve an explicit or metadata-declared rectilinear source CRS. |
| resolveNoDataRange | Resolves the no-data value range for masking dataset values. |
| resolveValueMetadata | Resolves numeric packing and no-data metadata from an ordered attribute hierarchy. |
| sampleTransectPositions | Builds evenly spaced WGS84 samples along the shortest longitude path. |
| sourceBoundsToGeographic | Transform a source rectangle to WGS84 by sampling a regular interior grid. |
| streamFullTransect | Streams full-depth transect rows as they are read from the backend. |
| streamTimeSeries | Streams time-series chunks as they are read from the backend. |
| streamTransect | Streams ordered chunks of a one-level transect. |
| streamVerticalProfile | Streams vertical-profile chunks as they are read from the backend. |
| 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 | Browser names used for WebGL compatibility handling. |
| CalendarDate | Represents a date in a calendar system. |
| CesiumHost | - |
| CFCalendar | Supported CF calendar types. |
| ColorMapName | Name of a bundled Matplotlib-inspired colormap. |
| CRS | CRS identifier understood by proj4 (for example EPSG:4326 or EPSG:32630). |
| CRSDefinition | Projection definition accepted by proj4. |
| CubeCrossSectionPoint | - |
| ElevationMode | Controls whether vertical coordinates are interpreted as heights or depths. |
| MultiscaleFormat | Supported conventions for discovering multiscale Zarr levels. |
| OnAuthError | - |
| QueryGeometry | Geometry accepted by the shared query API. Only points are implemented currently. |
| QueryPosition | WGS84 longitude/latitude coordinate used by convenience query APIs. |
| SliceArgs | Represents a multidimensional slice argument for Zarr array indexing. |
| TransformRequest | - |
| VelocityWindOptions | - |