Skip to main content

ZarrTileOptions

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

Properties​

cache?​

optional 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?​

optional colormap: string;

crs?​

optional crs: CRS | null;

dimensionNames?​

optional dimensionNames: DimensionNamesProps;

latIsAscending?​

optional latIsAscending: boolean;

maxZoom?​

optional maxZoom: number;

multiscaleFormat?​

optional multiscaleFormat: MultiscaleFormat;

noDataMax?​

optional noDataMax: number;

noDataMin?​

optional noDataMin: number;

onAuthError?​

optional onAuthError: OnAuthError;

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

renderTarget?​

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

Rendering convention used by the consuming map framework.

requestOverrides?​

optional requestOverrides: RequestOverrides;

scale?​

optional scale: [number, number];

selectors?​

optional selectors: ZarrSelectors;

store?​

optional store: Readable;

Custom Zarrita-compatible store, such as an IcechunkStore.

tileSize?​

optional tileSize: number;

transformRequest?​

optional transformRequest: TransformRequest;

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

url?​

optional url: string;

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

variable​

variable: string;

zarrVersion?​

optional zarrVersion: 2 | 3;