Skip to main content

CubeOptions

Properties​

bounds​

bounds: BoundsProps;

colormap?​

optional colormap: string;

colorScale?​

optional colorScale: [number, number, number][];

crs?​

optional crs: CRS | null;

dimensionNames?​

optional dimensionNames: DimensionNamesProps;

elevationMode?​

optional elevationMode: ElevationMode;

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

flipElevation?​

optional flipElevation: boolean;

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

latIsAscending?​

optional latIsAscending: boolean;

Whether latitude coordinate values increase with their array index.

multiscaleFormat?​

optional multiscaleFormat: MultiscaleFormat;

multiscaleLevel?​

optional multiscaleLevel: number;

onAuthError?​

optional onAuthError: OnAuthError;

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

opacity?​

optional opacity: number;

requestOverrides?​

optional requestOverrides: RequestOverrides;

Static fetch options for URL-backed stores.

scale?​

optional scale: [number, number];

selectors?​

optional selectors: Record<string, ZarrSelectorsProps>;

showHorizontalSlices?​

optional showHorizontalSlices: boolean;

showVerticalSlices?​

optional showVerticalSlices: boolean;

store?​

optional store: Readable;

Custom Zarrita-compatible store, including an IcechunkStore.

transformRequest?​

optional transformRequest: TransformRequest;

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

url?​

optional url: string;

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

variable​

variable: string;

verticalExaggeration?​

optional verticalExaggeration: number;

zarrVersion?​

optional zarrVersion: 3 | 2;