Skip to main content

OLLayerOptions

Configuration for a 2D raster (image) layer visualization in OpenLayers. The inherited crs and proj4 options describe the rectilinear Zarr source grid, independently of the OpenLayers view projection.

Extends​

  • ZarrTileOptions

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.

Inherited from​

ZarrTileOptions.cache

colormap?​

colormap?: string;

Inherited from​

ZarrTileOptions.colormap

crs?​

crs?: string | null;

Inherited from​

ZarrTileOptions.crs

dimensionNames?​

dimensionNames?: DimensionNamesProps;

Inherited from​

ZarrTileOptions.dimensionNames

id​

id: string;

latIsAscending?​

latIsAscending?: boolean;

Inherited from​

ZarrTileOptions.latIsAscending

maxZoom?​

maxZoom?: number;

Inherited from​

ZarrTileOptions.maxZoom

multiscaleFormat?​

multiscaleFormat?: MultiscaleFormat;

Inherited from​

ZarrTileOptions.multiscaleFormat

noDataMax?​

noDataMax?: number;

Inherited from​

ZarrTileOptions.noDataMax

noDataMin?​

noDataMin?: number;

Inherited from​

ZarrTileOptions.noDataMin

onAuthError?​

onAuthError?: OnAuthError;

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

Inherited from​

ZarrTileOptions.onAuthError

opacity?​

opacity?: number;

proj4?​

proj4?: CRSDefinition;

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

Inherited from​

ZarrTileOptions.proj4

renderTarget?​

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

Rendering convention used by the consuming map framework.

Inherited from​

ZarrTileOptions.renderTarget

requestOverrides?​

requestOverrides?: RequestOverrides;

Inherited from​

ZarrTileOptions.requestOverrides

scale?​

scale?: [number, number];

Inherited from​

ZarrTileOptions.scale

selectors?​

selectors?: ZarrSelectors;

Inherited from​

ZarrTileOptions.selectors

store?​

store?: Readable;

Custom Zarrita-compatible store, such as an IcechunkStore.

Inherited from​

ZarrTileOptions.store

tileSize?​

tileSize?: number;

Inherited from​

ZarrTileOptions.tileSize

transformRequest?​

transformRequest?: TransformRequest;

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

Inherited from​

ZarrTileOptions.transformRequest

url?​

url?: string;

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

Inherited from​

ZarrTileOptions.url

variable​

variable: string;

Inherited from​

ZarrTileOptions.variable

zarrVersion?​

zarrVersion?: 2 | 3 | null;

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

Inherited from​

ZarrTileOptions.zarrVersion