Archives/gristlabs_grist-core
1
0
Fork 0
mirror of https://github.com/gristlabs/grist-core.git synced 2026-03-02 04:09:24 +00:00
Code Issues Projects Releases Wiki Activity

(core) Update Plugin API documentation

Browse Source 
Summary: Updates to Plugin API documentation.

Test Plan: Tested manually in grist-help.

Reviewers: jarek

Reviewed By: jarek

Subscribers: jarek

Differential Revision: https://phab.getgrist.com/D3447
This commit is contained in:
George Gevoian
2022-05-24 13:22:41 -07:00
parent 3ad2d9212e
commit 3d3a5e334a
6 changed files with 100 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
app/plugin/GristTable.ts
View File

@@ -3,14 +3,13 @@
*/
/**
*
* Metadata and data for a table. This is documenting what is currently returned by the
* core plugins. Could be worth reconciling with:
* https://phab.getgrist.com/w/grist_data_format/
* Capitalization is python-style.
*
* Metadata and data for a table.
*/
export interface GristTable {
// This is documenting what is currently returned by the core plugins. Capitalization
// is python-style.
//
// TODO: could be worth reconciling with: https://phab.getgrist.com/w/grist_data_format/.
table_name: string | null; // currently allow names to be null
column_metadata: GristColumn[];
table_data: any[][];
@@ -21,9 +20,7 @@ export interface GristTables {
}
/**
*
* Metadata about a single column.
*
*/
export interface GristColumn {
id: string;