Skip to main content

core

Classes

ClassDescription
ZarrLayerLeaflet Zarr tile layer using the shared ZarrLayerProvider.
ZarrLayerProviderProvides Zarr dataset access and rendering capabilities for map layers.

Interfaces

InterfaceDescription
BoundsPropsGeographic bounding box definition (degrees).
ColorMapInfoStructure of the global color map registry.
ColorScalePropsDescribes a numerical-to-color mapping for visualizing scalar fields.
DataSlicePropsDescribes a slice of a multidimensional array.
DimensionNamesPropsDescribes the mapping between dataset dimensions and their standardized names.
DimensionValuesMapping of dimension names to their corresponding coordinate arrays.
DimIndicesPropsMaps dimension keys to their indices and associated coordinate arrays.
XYLimitsDescribes the XY coordinate boundaries of a dataset.
XYLimitsPropsAlias of XYLimits with explicit type name for Zarr coordinate bounds.
ZarrLevelMetadataMetadata for a single multiscale level in a Zarr dataset.
ZarrSelectorsDescribes a selector for a Zarr dataset dimension.
ZarrSelectorsProps-

Functions

FunctionDescription
calculateNearestIndexFinds the index of the value in values nearest to target.
calculateSliceArgsConstructs Zarr slice arguments for extracting a subregion of a multidimensional array.
colormapBuilderBuilds a color ramp (discrete or continuous) from a specified colormap.
colorScaleByNameReturns a color scale function for a given colormap name.
createColorRampTextureCreates a flexible 1D color-ramp texture supporting either normalized (0–1) or integer (0–255) color definitions.
createProgramCreates and links a WebGL program using the specified vertex and fragment shaders.
createShaderCreates and compiles a WebGL shader from source code.
decodeCFTimeDecodes CF-compliant time coordinate values into ISO date strings.
detectCRSDetects the coordinate reference system (CRS) of a Zarr dataset based on metadata or coordinate range. Defaults to EPSG:4326 (WGS84) if uncertain.
extractNoDataMetadataExtracts no-data related metadata from a Zarr array's attributes.
getXYLimitsRetrieve the geographic coordinate limits (min/max latitude/longitude) for a Zarr array.
identifyDimensionIndicesIdentify the indices of common dimensions (lat, lon, time, elevation) in a Zarr array, optionally using CF-compliant standard names or custom dimension mappings.
initZarrDatasetOpens a Zarr variable (single-scale or multiscale pyramid) and prepares its metadata.
latDegToMercY-
loadDimensionValuesLoads the coordinate values for a specific dimension.
lonDegToMercX-
openLevelArrayOpens and caches a specific multiscale level array. Keeps a small LRU-style cache of up to three levels.
parseCFUnitsParses a CF-compliant units string into its components.
resolveNoDataRangeResolves the no-data value range for masking dataset values.

Type Aliases

Type AliasDescription
CalendarDateRepresents a date in a calendar system.
CFCalendarSupported CF calendar types.
ColorMapNameType 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).
CRSSupported Coordinate Reference Systems.
SliceArgsRepresents a multidimensional slice argument for Zarr array indexing.