Types
Load Types
Dataset
Dataset
interface Dataset {
title: string;
unitFormat: UnitFormat;
attribution: string;
datetimeRange: OpenDatetimeISOStringRange;
datetimes: DatetimeISOString[]; // deprecated, use `loadDatasetSlice` instead
palette: Palette;
}
Dataset metadata.
DatasetSlice
DatasetSlice
interface DatasetSlice {
datetimes: DatetimeISOString[];
}
Dataset slice with available datetimes in the requested datetime range.
DatasetData
DatasetData
interface DatasetData {
datetime: DatetimeISOString;
referenceDatetime: DatetimeISOString;
horizon: DurationISOString;
image: TextureData;
datetime2: DatetimeISOString | null;
referenceDatetime2: DatetimeISOString | null;
horizon2: DurationISOString | null;
image2: TextureData | null;
imageWeight: number;
imageType: ImageType;
imageUnscale: [number, number] | null;
bounds: [number, number, number, number];
}
Dataset data.
datetime
- closest start forecast datetime <= requested datetimereferenceDatetime
- reference datetime ofdatetime
, i.e. datetime of model runhorizon
- duration betweenreferenceDatetime
anddatetime
, e.g.PT6H
for a 6-hour forecastimage
- image atdatetime
datetime2
* - closest end forecast datetime >= requested datetimereferenceDatetime2
* - reference datetime ofdatetime2
, i.e. datetime of model runhorizon2
* - duration betweenreferenceDatetime2
anddatetime2
, e.g.PT6H
for a 6-hour forecastimage2
* - image atdatetime2
imageWeight
* - interpolation weight betweenimage
andimage2
imageType
- image type, scalar or vectorimageUnscale
- original data value bounds, used to unscale the data if the original data are scaled (quantized)bounds
- original data bounding box
* applicable only if datetimeInterpolate
is enabled
TextureData
TextureData
interface TextureData {
data: Uint8Array | Uint8ClampedArray | Float32Array;
width: number;
height: number;
}
Texture data to be used as input to raster rendering layers.
UnitSystem
UnitSystem
enum UnitSystem {
METRIC = 'METRIC',
METRIC_KILOMETERS = 'METRIC_KILOMETERS',
IMPERIAL = 'IMPERIAL',
NAUTICAL = 'NAUTICAL',
}
Unit system for unit format definition.
UnitFormat
UnitFormat
interface UnitFormat {
unit: string;
scale?: number;
offset?: number;
decimals?: number;
}
Format definition to be used for formatting raw values with units.
Datetime Types
DatetimeISOString
DatetimeISOString
type DatetimeISOString = string;
Valid ISO 8601 datetime.
DatetimeISOStringRange
DatetimeISOStringRange
type DatetimeISOStringRange = [start: DatetimeISOString, end: DatetimeISOString];
Valid ISO 8601 datetime range.
OpenDatetimeISOStringRange
OpenDatetimeISOStringRange
type OpenDatetimeISOStringRange = [start: DatetimeISOString | null, end: DatetimeISOString | null];
Valid ISO 8601 datetime range. Null start/end represent an open end.
DurationISOString
DurationISOString
type DurationISOString = string;
Valid ISO 8601 duration.
Last updated