Skip to main content

ZarrTileOptions

Framework-neutral options for the shared 2D Zarr tile renderer.

Properties​

cache?​

cache?: boolean | TileCacheOptions;

Decoded numeric tile cache. Enabled by default. Pass false to disable it, or an options object to configure its per-provider byte budget.

colormap?​

colormap?: string;

crs?​

crs?: string | null;

dimensionNames?​

dimensionNames?: DimensionNamesProps;

latIsAscending?​

latIsAscending?: boolean;

maxZoom?​

maxZoom?: number;

multiscaleFormat?​

multiscaleFormat?: MultiscaleFormat;

noDataMax?​

noDataMax?: number;

noDataMin?​

noDataMin?: number;

onAuthError?​

onAuthError?: OnAuthError;

Called once when a transformed request returns an expired-credential status.

proj4?​

proj4?: CRSDefinition;

Proj4, WKT2, or PROJJSON definition for a CRS not registered by proj4.

renderTarget?​

renderTarget?: "cesium" | "web-map";

Rendering convention used by the consuming map framework.

requestOverrides?​

requestOverrides?: RequestOverrides;

scale?​

scale?: [number, number];

selectors?​

selectors?: ZarrSelectors;

store?​

store?: Readable;

Custom Zarrita-compatible store, such as an IcechunkStore.

tileSize?​

tileSize?: number;

transformRequest?​

transformRequest?: TransformRequest;

Dynamically transform each FetchStore request (for auth, proxies, or signed URLs).

url?​

url?: string;

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

variable​

variable: string;

zarrVersion?​

zarrVersion?: 3 | 2 | null;

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