Skip to main content

identifyDimensionIndices()

function identifyDimensionIndices(
dimNames,
dimensionNames?,
coordinates?): DimIndicesProps;

Identify the indices of common dimensions (lat, lon, time, elevation) in a Zarr array, optionally using CF-compliant standard names or custom dimension mappings.

Parameters

ParameterTypeDescription
dimNamesstring[]Names of the array dimensions.
dimensionNames?DimensionNamesPropsOptional explicit mapping of dimension names (see DimensionNamesProps).
coordinates?Record<string, any>Optional coordinate variable dictionary.

Returns

DimIndicesProps

A DimIndicesProps object describing each dimension’s index and name.