Skip to main content

LeafletLayerOptions

Configuration for a 2D raster (image) layer visualization in Leaflet.

Extends​

  • ZarrTileOptions

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.

Inherited from​

ZarrTileOptions.cache

colormap?​

optional colormap: string;

Inherited from​

ZarrTileOptions.colormap

crs?​

optional crs: CRS | null;

Inherited from​

ZarrTileOptions.crs

dimensionNames?​

optional dimensionNames: DimensionNamesProps;

Inherited from​

ZarrTileOptions.dimensionNames

id​

id: string;

latIsAscending?​

optional latIsAscending: boolean;

Inherited from​

ZarrTileOptions.latIsAscending

maxZoom?​

optional maxZoom: number;

Inherited from​

ZarrTileOptions.maxZoom

multiscaleFormat?​

optional multiscaleFormat: MultiscaleFormat;

Inherited from​

ZarrTileOptions.multiscaleFormat

noDataMax?​

optional noDataMax: number;

Inherited from​

ZarrTileOptions.noDataMax

noDataMin?​

optional noDataMin: number;

Inherited from​

ZarrTileOptions.noDataMin

onAuthError?​

optional onAuthError: OnAuthError;

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

Inherited from​

ZarrTileOptions.onAuthError

opacity?​

optional opacity: number;

renderTarget?​

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

Rendering convention used by the consuming map framework.

Inherited from​

ZarrTileOptions.renderTarget

requestOverrides?​

optional requestOverrides: RequestOverrides;

Inherited from​

ZarrTileOptions.requestOverrides

scale?​

optional scale: [number, number];

Inherited from​

ZarrTileOptions.scale

selectors?​

optional selectors: ZarrSelectors;

Inherited from​

ZarrTileOptions.selectors

store?​

optional store: Readable;

Custom Zarrita-compatible store, such as an IcechunkStore.

Inherited from​

ZarrTileOptions.store

tileSize?​

optional tileSize: number;

Inherited from​

ZarrTileOptions.tileSize

transformRequest?​

optional transformRequest: TransformRequest;

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

Inherited from​

ZarrTileOptions.transformRequest

url?​

optional url: string;

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

Inherited from​

ZarrTileOptions.url

variable​

variable: string;

Inherited from​

ZarrTileOptions.variable

zarrVersion?​

optional zarrVersion: 2 | 3;

Inherited from​

ZarrTileOptions.zarrVersion