Skip to main content

VelocityOptions

Properties​

bounds?​

bounds?: BoundsProps;

Geographic subset shared by U/V. When omitted, source coverage is derived.

colormap?​

colormap?: string;

crs?​

crs?: string | null;

dimensionNames?​

dimensionNames?: DimensionNamesProps;

elevationMode?​

elevationMode?: ElevationMode;

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

flipElevation?​

flipElevation?: boolean;

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

latIsAscending?​

latIsAscending?: boolean;

Whether latitude coordinate values increase with their array index.

multiscaleFormat?​

multiscaleFormat?: MultiscaleFormat;

multiscaleLevel?​

multiscaleLevel?: number;

noDataMax?​

noDataMax?: number;

Maximum valid decoded component value; larger U/V values are no-data.

noDataMin?​

noDataMin?: number;

Minimum valid decoded component value; smaller U/V values are no-data.

onAuthError?​

onAuthError?: OnAuthError;

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

opacity?​

opacity?: number;

proj4?​

proj4?: string | Record<string, unknown>;

Proj4, WKT2, or PROJJSON definition shared by the U and V source grids.

requestOverrides?​

requestOverrides?: RequestOverrides;

Static fetch options shared by URL-backed U and V stores.

scale?​

scale?: [number, number];

selectors?​

selectors?: Record<string, ZarrSelectorsProps>;

sliceSpacing?​

sliceSpacing?: number;

stores?​

stores?: object;

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

u?​

u?: Readable;

v?​

v?: Readable;

transformRequest?​

transformRequest?: TransformRequest;

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

urls?​

urls?: object;

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

u?​

u?: string;

v?​

v?: string;

variables​

variables: object;

u​

u: string;

v​

v: string;

verticalExaggeration?​

verticalExaggeration?: number;

windOptions?​

windOptions?: VelocityWindOptions;

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

zarrVersion?​

zarrVersion?: 3 | 2 | null;

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