Skip to main content

CubeOptions

Properties​

bounds?​

bounds?: BoundsProps;

Geographic subset. When omitted, coverage is derived from the source X/Y axes.

colormap?​

colormap?: string;

colorScale?​

colorScale?: [number, number, number][];

crs?​

crs?: string | null;

dimensionNames?​

dimensionNames?: DimensionNamesProps;

elevationMode?​

elevationMode?: ElevationMode;

Render positive vertical coordinates above sea level or as depths below it.

flipElevation?​

flipElevation?: boolean;

Reverse vertical data-plane placement without changing source elevation indices.

latIsAscending?​

latIsAscending?: boolean;

Whether latitude coordinate values increase with their array index.

multiscaleFormat?​

multiscaleFormat?: MultiscaleFormat;

multiscaleLevel?​

multiscaleLevel?: number;

noDataMax?​

noDataMax?: number;

Maximum valid decoded value; larger values are treated as no-data.

noDataMin?​

noDataMin?: number;

Minimum valid decoded value; smaller values are treated as no-data.

onAuthError?​

onAuthError?: OnAuthError;

Called once when a transformed request returns HTTP 400 or 401.

opacity?​

opacity?: number;

proj4?​

proj4?: string | Record<string, unknown>;

Proj4, WKT2, or PROJJSON definition for an arbitrary rectilinear source CRS.

requestOverrides?​

requestOverrides?: RequestOverrides;

Static fetch options for URL-backed stores.

scale?​

scale?: [number, number];

selectors?​

selectors?: Record<string, ZarrSelectorsProps>;

showHorizontalSlices?​

showHorizontalSlices?: boolean;

showVerticalSlices?​

showVerticalSlices?: boolean;

store?​

store?: Readable;

Custom Zarrita-compatible store, including an IcechunkStore.

transformRequest?​

transformRequest?: TransformRequest;

Dynamically transform requests for authentication, proxies, or signed URLs.

url?​

url?: string;

URL to a Zarr store. Required unless store is provided.

variable​

variable: string;

verticalExaggeration?​

verticalExaggeration?: number;

zarrVersion?​

zarrVersion?: 3 | 2 | null;

Zarr version. Defaults to null and is detected by trying v3 before v2.