`CSqlRelationalTableModel`

Models and views · extends CSqlTableModel

SQL table model that displays foreign keys through related tables.

import { CSqlRelationalTableModel } from "canvas-toolkit-lib";

Declared members

static readonly RelationFetchSize = 1000;

constructor(adapter: CSqlTableAdapter);

setRelation(column: number, relation: CSqlRelation | null): void;

Assigns or removes the relation for a model column.

relation(column: number): CSqlRelation | null;

Returns the relation assigned to a column.

relationRows(column: number): readonly CSqlRow[];

Returns independent copies of the loaded records for a relation.

relationDisplayValues(column: number): string[];

Returns display values in the same order as relationRows().

relationKeyAt(column: number, row: number): unknown;

Returns a relation key by its loaded row position.

rawData(index: CModelIndex): unknown;

Returns the unformatted value stored by CSqlTableModel.

data(index: CModelIndex): unknown;

setItemData(index: CModelIndex, value: unknown): boolean;

select(): Promise<boolean>;

Loads the main table and all configured relation tables.