oceanum-js

@oceanum/datamesh

---

@oceanum/datamesh / index / DataVar

Class: DataVar<S>

Defined in: packages/datamesh/src/lib/datamodel.ts:440

Represents a data variable within a dataset.

Type Parameters

S

S extends TempZarr | HttpZarr

Constructors

Constructor

new DataVar<S>(id, dimensions, attributes, arr): DataVar<DType, S>

Defined in: packages/datamesh/src/lib/datamodel.ts:458

Parameters

id

string

dimensions

string[]

attributes

Record<string, unknown>

arr

S extends TempZarr ? Array<DType, Mutable> : Array<DType, AsyncReadable<unknown>>

Returns

DataVar<DType, S>

Properties

arr

arr: S extends TempZarr ? Array<DType, Mutable> : Array<DType, AsyncReadable<unknown>>

Defined in: packages/datamesh/src/lib/datamodel.ts:455

---

attributes

attributes: Record<string, unknown>

Defined in: packages/datamesh/src/lib/datamodel.ts:454

---

dimensions

dimensions: string[]

Defined in: packages/datamesh/src/lib/datamodel.ts:453

---

id

id: string

Defined in: packages/datamesh/src/lib/datamodel.ts:452

Creates an instance of DataVar.

Param

The identifier for the data variable.

Param

The dimensions associated with the data variable.

Param

The attributes of the data variable, represented as a record of key-value pairs.

Param

The zarr array associated with the data variable.

Methods

get()

get(index?): Promise<Data>

Defined in: packages/datamesh/src/lib/datamodel.ts:479

Retrieves the data from the zarr array. If the data is already cached, it returns the cached data.

Parameters

index?

string[] | SliceDef

Optional slice parameters to retrieve specific data from the zarr array.

Returns

Promise<Data>

A promise that resolves to the data of the zarr array.

This site is open source. Improve this page.