gristlabs_grist-core/app/plugin/GristTable-ti.ts
Paul Fitzpatrick ac5452c89f (core) add grist.onRecord and grist.onRecords event handlers
Summary:
This simplifies writing custom widgets that access selected
data.  To access the record at which the cursor is set, and
get any future changes to it as the cursor moves or data
changes, it suffices now to do:

```
grist.ready();
grist.onRecord(record => /* render */);
```

Similarly to access the set of selected records, and get any
changes, it suffices now to do:

```
grist.ready();
grist.onRecords(records => /* render */);
```

The `records` argument will be a list of objects, each of which
is a single record.  This is distinct from the column-based
representation favored in Grist up ontil now.  That remains
how methods like `fetchTable` or `fetchSelectedTable` represent
their results.  In the future, methods named like `fetchRecords`
or `fetchSelectedRecords` could be added that return lists.

Test Plan: extended tests

Reviewers: dsagal

Reviewed By: dsagal

Differential Revision: https://phab.getgrist.com/D2583
2020-08-13 14:34:23 -04:00

36 lines
775 B
TypeScript

/**
* This module was automatically generated by `ts-interface-builder`
*/
import * as t from "ts-interface-checker";
// tslint:disable:object-literal-key-quotes
export const GristTable = t.iface([], {
"table_name": t.union("string", "null"),
"column_metadata": t.array("GristColumn"),
"table_data": t.array(t.array("any")),
});
export const GristTables = t.iface([], {
"tables": t.array("GristTable"),
});
export const GristColumn = t.iface([], {
"id": "string",
"type": "string",
});
export const APIType = t.enumtype({
"ImportSourceAPI": 0,
"ImportProcessorAPI": 1,
"ParseOptionsAPI": 2,
"ParseFileAPI": 3,
});
const exportedTypeSuite: t.ITypeSuite = {
GristTable,
GristTables,
GristColumn,
APIType,
};
export default exportedTypeSuite;