Interface: GristDocAPI#

grist-plugin-api.GristDocAPI

Allows getting information from and nteracting with the Grist document to which a plugin or widget is attached.

Table of contents#

Methods#

• applyUserActions
• fetchTable
• getDocName
• listTables

Methods#

applyUserActions#

▸ applyUserActions(actions, options?): Promise<any>

Applies an array of user actions. TODO: return type should be Promise, but this requires importing modules from app/common which is not currently supported by the build.

Parameters#

Name	Type
actions	any[][]
options?	any

Returns#

Promise<any>

---

fetchTable#

▸ fetchTable(tableId): Promise<any>

Returns a complete table of data in the format {colId: [values]}, including the ‘id’ column. Do not modify the returned arrays in-place, especially if used directly (not over RPC). TODO: return type is Promise{[colId: string]: CellValue[]}> but cannot be specified because ts-interface-builder does not properly support index-signature.

Parameters#

Name	Type
tableId	string

Returns#

Promise<any>

---

getDocName#

▸ getDocName(): Promise<string>

Returns an identifier for the document.

Returns#

Promise<string>

---

listTables#

▸ listTables(): Promise<string[]>

Returns a sorted list of table IDs.

Returns#

Promise<string[]>