Skip to main content

Class: CSVTableData

Defined in: @tissuumaps-storage/src/csv/CSVTableData.ts:8

Implements​

  • TableData

Constructors​

Constructor​

new CSVTableData(n, ids, names, columns, columnValues): CSVTableData

Defined in: @tissuumaps-storage/src/csv/CSVTableData.ts:15

Parameters​

n​

number

ids​

number[] | undefined

names​

string[] | undefined

columns​

string[]

columnValues​

Map<string, string[] | TypedArray>

Returns​

CSVTableData

Methods​

close()​

close(): void

Defined in: @tissuumaps-storage/src/csv/CSVTableData.ts:120

Releases all resources held by this data object

Returns​

void

Implementation of​

TableData.close

getIds()​

getIds(): number[]

Defined in: @tissuumaps-storage/src/csv/CSVTableData.ts:29

Returns an array of item IDs

Returns​

number[]

Implementation of​

TableData.getIds

getNames()​

getNames(): string[] | undefined

Defined in: @tissuumaps-storage/src/csv/CSVTableData.ts:41

Returns the item names if available, otherwise undefined

Returns​

string[] | undefined

Implementation of​

TableData.getNames

getSize()​

getSize(): number

Defined in: @tissuumaps-storage/src/csv/CSVTableData.ts:37

Returns the total number of items

Returns​

number

Implementation of​

TableData.getSize

loadUniqueValues()​

loadUniqueValues<T>(column, options?): Promise<GenericArray<T>>

Defined in: @tissuumaps-storage/src/csv/CSVTableData.ts:80

Load a column's unique values as a typed array-like

Type Parameters​

T​

T

Element type of the returned array

Parameters​

column​

string

The column name

options?​

Optional abort signal and progress callback

onProgress?​

ProgressCallback

signal?​

AbortSignal

Returns​

Promise<GenericArray<T>>

The unique column values

Implementation of​

TableData.loadUniqueValues

loadValueRange()​

loadValueRange(column, options?): Promise<[number, number] | undefined>

Defined in: @tissuumaps-storage/src/csv/CSVTableData.ts:92

Load a column's minimum and maximum values

Parameters​

column​

string

The column name

options?​

Optional abort signal and progress callback

onProgress?​

ProgressCallback

signal?​

AbortSignal

Returns​

Promise<[number, number] | undefined>

The numeric [min, max] value range of the column, or undefined if not numeric

Implementation of​

TableData.loadValueRange

loadValues()​

loadValues<T>(column, options?): Promise<GenericArray<T>>

Defined in: @tissuumaps-storage/src/csv/CSVTableData.ts:67

Loads a column's values as a typed array-like

Type Parameters​

T​

T

Element type of the returned array

Parameters​

column​

string

The column name

options?​

Optional abort signal and progress callback

onProgress?​

ProgressCallback

signal?​

AbortSignal

Returns​

Promise<GenericArray<T>>

The column values

Implementation of​

TableData.loadValues

resolveColumnQuery()​

resolveColumnQuery(query, options?): Promise<string | null>

Defined in: @tissuumaps-storage/src/csv/CSVTableData.ts:57

Resolves a query to an exact column name

Parameters​

query​

string

The column query

options?​

Optional abort signal

signal?​

AbortSignal

Returns​

Promise<string | null>

The resolved column name, or null if no match is found

Implementation of​

TableData.resolveColumnQuery

suggestColumnQueries()​

suggestColumnQueries(currentQuery, options?): Promise<string[]>

Defined in: @tissuumaps-storage/src/csv/CSVTableData.ts:45

Returns column name suggestions matching the current query

Parameters​

currentQuery​

string

The partial column name to autocomplete

options?​

Optional abort signal

signal?​

AbortSignal

Returns​

Promise<string[]>

A list of suggested column queries matching the current one

Implementation of​

TableData.suggestColumnQueries