Skip to main content

VelocityOptions

Properties​

bounds​

bounds: BoundsProps;

colormap?​

optional colormap: string;

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 shared by URL-backed U and V stores.

scale?​

optional scale: [number, number];

selectors?​

optional selectors: Record<string, ZarrSelectorsProps>;

sliceSpacing?​

optional sliceSpacing: number;

stores?​

optional stores: object;

Custom Zarrita-compatible stores for U and V, including IcechunkStore instances.

u?​

optional u: Readable;

v?​

optional v: Readable;

transformRequest?​

optional transformRequest: TransformRequest;

Dynamically transform U and V requests for authentication, proxies, or signed URLs.

urls?​

optional urls: object;

URLs for the U and V stores. Each may be omitted when its custom store is supplied.

u?​

optional u: string;

v?​

optional v: string;

variables​

variables: object;

u​

u: string;

v​

v: string;

verticalExaggeration?​

optional verticalExaggeration: number;

windOptions?​

optional windOptions: VelocityWindOptions;

Particle styling; height is derived from the selected Zarr elevation.

zarrVersion?​

optional zarrVersion: 3 | 2;