Class Ds<T>

A generic dataset manager.

Type Parameters

T extends object
The type of the data structure managed by this instance.

Hierarchy (View Summary)

Ds
- Dsm

Constructors

constructor

new Ds<T extends object>(params: { core: DsCore<T>; useClone?: boolean }): Ds<T>
Creates an instance of Ds.
Type Parameters
- T extends object
Parameters
- params: { core: DsCore<T>; useClone?: boolean }
  The initialization parameters.
  - core: DsCore<T>
    The core instance managing data operations.
  - OptionaluseClone?: boolean
    Whether to use structuredClone() when handling data.
Returns Ds<T>
- Defined in ds.ts:32

Accessors

rowCnt

get rowCnt(): undefined | number
Gets the row count of the first table. tables[0], useful for single table case

Returns undefined | number
The number of rows in the first table or undefined if no tables exist.
- Defined in ds.ts:158

rowSel

get rowSel(): undefined | Loc
Gets the selected row location if only one row is selected. Row loc of rowsSel[0], useful for single selection case

Returns undefined | Loc
The selected row location or undefined if multiple or no rows are selected.
- Defined in ds.ts:195

rowSelRef

get rowSelRef(): undefined | T
Gets the reference to the selected row if only one row is selected. Row reference of rowsSel[0], useful for single selection case

Returns undefined | T
The selected row or undefined if multiple or no rows are selected.
- Defined in ds.ts:206

rowsSel

get rowsSel(): Loc[]
Gets the selected row locations.

Returns Loc[]
An array of selected row locations.
- Defined in ds.ts:128

rowsSelRef

get rowsSelRef(): T[]
Gets references to the selected rows.

Returns T[]
An array of selected row values.
- Defined in ds.ts:136

table

get table(): undefined | T[]
Gets the first table from the core tables. tables[0], useful for single table case

Returns undefined | T[]
The first table or undefined if no tables exist.
- Defined in ds.ts:149

tables

get tables(): T[][]
Gets all tables in the dataset.

Returns T[][]
A two-dimensional array representing the tables.
- Defined in ds.ts:88

tablesCnt

get tablesCnt(): number
Gets the total number of tables in the dataset.

Returns number
The number of tables.
- Defined in ds.ts:96

tableSel

get tableSel(): undefined | number
Gets the selected table index if only one table is selected. table tid of tablesSel[0], useful for single selection case

Returns undefined | number
The selected table index or undefined if multiple or no tables are selected.
- Defined in ds.ts:169

tableSelRef

get tableSelRef(): T[]
Gets the reference to the selected table if only one table is selected. table reference of tablesSel[0], useful for single selection case

Returns T[]
The selected table or an empty array if multiple or no tables are selected.
- Defined in ds.ts:180

tablesSel

get tablesSel(): number[]
Gets the selected table indices.

Returns number[]
An array of selected table indices.
- Defined in ds.ts:108

tablesSelRef

get tablesSelRef(): T[][]
Gets references to the selected tables.

Returns T[][]
A two-dimensional array of selected tables.
- Defined in ds.ts:116

Methods

clickRow

clickRow(
    row: Loc | T,
    e: MouseEvent,
    sort?: "reverse" | "forward",
): { success: boolean }
Handles row selection on mouse click with support for multi-selection modes. Only intended for frontend usage.
Parameters
- row: Loc | T
  The row reference or location.
- e: MouseEvent
  The mouse event triggering the selection.
- Optionalsort: "reverse" | "forward"
  The sorting direction.
Returns { success: boolean }
An object indicating whether the selection was successful.
- Defined in ds.ts:409

clickTable

clickTable(
    table: number | T[],
    e: MouseEvent,
    sort?: "reverse" | "forward",
): { success: boolean }
Handles table selection on mouse click with support for multi-selection modes. Only intended for frontend usage.
Parameters
- table: number | T[]
  The table reference or index.
- e: MouseEvent
  The mouse event triggering the selection.
- Optionalsort: "reverse" | "forward"
  The sorting direction.
Returns { success: boolean }
An object indicating whether the selection was successful.
- Defined in ds.ts:387

deselectAll

deselectAll(): void
Deselects all selected tables and rows.

Returns void
- Defined in ds.ts:445

deselectAllRow

deselectAllRow(): void
Deselects all selected rows.

Returns void
- Defined in ds.ts:437

deselectAllTable

deselectAllTable(): void
Deselects all selected tables.

Returns void
- Defined in ds.ts:429

hasRow

hasRow(loc: Loc): { found: boolean; rowRef: undefined | T }
Find row if a row exists at the given location(loc).
Parameters
- loc: Loc
  The location of the row, containing table and row indices.
Returns { found: boolean; rowRef: undefined | T }
An object indicating whether the row exists and its reference if found.
- Defined in ds.ts:229

hasRowRef

hasRowRef(rowRef: T): { found: boolean; loc: Loc; row?: T }
Find row if a given row reference exists in any table.
Parameters
- rowRef: T
  The reference to the row.
Returns { found: boolean; loc: Loc; row?: T }
An object indicating whether the row reference exists, its location if found, and the row itself.
- Defined in ds.ts:251

hasTable

hasTable(t: number): { found: boolean; tableRef: undefined | T[] }
Find table if a table exists at the given index(tid).
Parameters
- t: number
  The index of the table.
Returns { found: boolean; tableRef: undefined | T[] }
An object indicating whether the table exists and its reference if found.
- Defined in ds.ts:219

hasTableRef

hasTableRef(tableRef: T[]): { found: boolean; tid: number }
Find table if a given table reference exists in the core tables.
Parameters
- tableRef: T[]
  The reference to the table.
Returns { found: boolean; tid: number }
An object indicating whether the table reference exists and its index if found.
- Defined in ds.ts:241

isSelected

isSelected(index: number | Loc): boolean
Checks if a table or row (by index or location) is selected.
Parameters
- index: number | Loc
  The table index or row location.
Returns boolean
True if the table or row is selected, otherwise false.
- Defined in ds.ts:495

isSelectedRow

isSelectedRow(loc: Loc): boolean
Checks if a row at the given location is selected.
Parameters
- loc: Loc
  The row location.
Returns boolean
True if the row is selected, otherwise false.
- Defined in ds.ts:466

isSelectedRowRef

isSelectedRowRef(rowRef: T): boolean
Checks if a row reference is selected.
Parameters
- rowRef: T
  The row reference.
Returns boolean
True if the row is selected, otherwise false.
- Defined in ds.ts:485

isSelectedTable

isSelectedTable(tid: number): boolean
Checks if a table with the given index is selected.
Parameters
- tid: number
  The table index.
Returns boolean
True if the table is selected, otherwise false.
- Defined in ds.ts:457

isSelectedTableRef

isSelectedTableRef(tableRef: T[]): boolean
Checks if a table reference is selected.
Parameters
- tableRef: T[]
  The table reference.
Returns boolean
True if the table is selected, otherwise false.
- Defined in ds.ts:475

isValidLocs

isValidLocs(locs: Loc[]): boolean
Checks if all given row locations are valid.
Parameters
- locs: Loc[]
  The array of row locations.
Returns boolean
True if all row locations are valid, otherwise false.
- Defined in ds.ts:517

isValidTids

isValidTids(tids: number[]): boolean
Checks if all given table IDs are valid.
Parameters
- tids: number[]
  The array of table IDs.
Returns boolean
True if all table IDs are valid, otherwise false.
- Defined in ds.ts:507

rows

rows(
    source?: T[],
    target?: {
        changeSel?: boolean;
        place?: "above" | "replace" | "below";
        select?: number[] | Loc[] | "tables" | "rows";
        useClone?: boolean;
        which?: "top" | "all" | "bottom";
    },
): { success: boolean }
Manipulates rows based on selection and placement rules.
Parameters
- Optionalsource: T[]
- Optionaltarget: {
      changeSel?: boolean;
      place?: "above" | "replace" | "below";
      select?: number[] | Loc[] | "tables" | "rows";
      useClone?: boolean;
      which?: "top" | "all" | "bottom";
  }
Returns { success: boolean }
See
rows (full documentation in main implementation)
- Defined in ds.ts:526
rows(
    source: T[],
    target?: {
        changeSel?: boolean;
        place?: "newTableAbove" | "newTableBelow";
        select?: number[] | "tables";
        useClone?: boolean;
        which?: "top" | "all" | "bottom";
    },
): { success: boolean }
Modifies rows or creates new tables based on placement rules.
Parameters
- source: T[]
- Optionaltarget: {
      changeSel?: boolean;
      place?: "newTableAbove" | "newTableBelow";
      select?: number[] | "tables";
      useClone?: boolean;
      which?: "top" | "all" | "bottom";
  }
Returns { success: boolean }
See
rows (full documentation in main implementation)
- Defined in ds.ts:541

rowsToLocs

rowsToLocs(rows: T[]): { foundAll: boolean; locs: Loc[] }
Converts row references to their corresponding locations.
Parameters
- rows: T[]
  An array of row references.
Returns { foundAll: boolean; locs: Loc[] }
An object indicating whether all rows were found and their corresponding locations.
- Defined in ds.ts:282

selectRow

selectRow(
row: Loc | T,
option?: { multiMode?: MultiMode; sort?: "reverse" | "forward" },
): { success: boolean }
Selects a row by its reference or location.
Parameters
- row: Loc | T
  The row reference or location.
- Optionaloption: { multiMode?: MultiMode; sort?: "reverse" | "forward" }
  Selection options, including multi-selection mode and sorting direction.
Returns { success: boolean }
An object indicating whether the selection was successful.
- Defined in ds.ts:354

selectTable

selectTable(
table: number | T[],
option?: { multiMode?: MultiMode; sort?: "reverse" | "forward" },
): { success: boolean }
Selects a table by its reference or index(tid).
Parameters
- table: number | T[]
  The table reference or index.
- Optionaloption: { multiMode?: MultiMode; sort?: "reverse" | "forward" }
  Selection options, including multi-selection mode and sorting direction.
Returns { success: boolean }
An object indicating whether the selection was successful.
- Defined in ds.ts:325

sortRowsSel

sortRowsSel(direction?: "reverse" | "forward"): void
Sorts the selected rows based on table and row indices in the specified direction.
Parameters
- Optionaldirection: "reverse" | "forward"
  The sorting direction, defaults to "forward".
Returns void
- Defined in ds.ts:310

sortTablesSel

sortTablesSel(direction?: "reverse" | "forward"): void
Sorts the selected table indices in the specified direction.
Parameters
- Optionaldirection: "reverse" | "forward"
  The sorting direction, defaults to "forward".
Returns void
- Defined in ds.ts:299

tablesToTids

tablesToTids(tables: T[][]): { foundAll: boolean; tids: number[] }
Converts table references to their corresponding table indices.
Parameters
- tables: T[][]
  An array of table references.
Returns { foundAll: boolean; tids: number[] }
An object indicating whether all tables were found and their corresponding indices.
- Defined in ds.ts:267

Class Ds<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

core: DsCore<T>

OptionaluseClone?: boolean

Returns Ds<T>

Accessors

rowCnt

Returns undefined | number

rowSel

Returns undefined | Loc

rowSelRef

Returns undefined | T

rowsSel

Returns Loc[]

rowsSelRef

Returns T[]

table

Returns undefined | T[]

tables

Returns T[][]

tablesCnt

Returns number

tableSel

Returns undefined | number

tableSelRef

Returns T[]

tablesSel

Returns number[]

tablesSelRef

Returns T[][]

Methods

clickRow

Parameters

Returns { success: boolean }

clickTable

Parameters

Returns { success: boolean }

deselectAll

Returns void

deselectAllRow

Returns void

deselectAllTable

Returns void

hasRow

Parameters

Returns { found: boolean; rowRef: undefined | T }

hasRowRef

Parameters

Returns { found: boolean; loc: Loc; row?: T }

hasTable

Parameters

Returns { found: boolean; tableRef: undefined | T[] }

hasTableRef

Parameters

Returns { found: boolean; tid: number }

isSelected

Parameters

Returns boolean

isSelectedRow

Parameters

Returns boolean

isSelectedRowRef

Parameters

Returns boolean

isSelectedTable

Parameters

Returns boolean

isSelectedTableRef

Parameters

Returns boolean

isValidLocs

`Optional`useClone?: boolean