gristlabs_grist-core/app/plugin/GristAPI-ti.ts
Jarosław Sadziński b6a431dd58 (core) Cursor in custom widgets
Summary:
Adding a new method `setCursorPos` in the widget API, and a new configuration option for the ready message `allowSelectBy` that exposes custom widgets in the `Select by` dropdown.
With this, a custom widget can control the position of the linked widgets and is able to change the column in the creator panel.

Test Plan: Added new test. Existing tests should pass.

Reviewers: JakubSerafin

Reviewed By: JakubSerafin

Subscribers: JakubSerafin

Differential Revision: https://phab.getgrist.com/D3993
2023-08-29 09:19:52 +02:00

62 lines
1.9 KiB
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 UIRowId = t.union("number", t.lit('new'));
export const CursorPos = t.iface([], {
"rowId": t.opt("UIRowId"),
"rowIndex": t.opt("number"),
"fieldIndex": t.opt("number"),
"sectionId": t.opt("number"),
});
export const ComponentKind = t.union(t.lit("safeBrowser"), t.lit("safePython"), t.lit("unsafeNode"));
export const GristAPI = t.iface([], {
"render": t.func("number", t.param("path", "string"), t.param("target", "RenderTarget"), t.param("options", "RenderOptions", true)),
"dispose": t.func("void", t.param("procId", "number")),
"subscribe": t.func("void", t.param("tableId", "string")),
"unsubscribe": t.func("void", t.param("tableId", "string")),
});
export const GristDocAPI = t.iface([], {
"getDocName": t.func("string"),
"listTables": t.func(t.array("string")),
"fetchTable": t.func("any", t.param("tableId", "string")),
"applyUserActions": t.func("any", t.param("actions", t.array(t.array("any"))), t.param("options", "any", true)),
"getAccessToken": t.func("AccessTokenResult", t.param("options", "AccessTokenOptions")),
});
export const GristView = t.iface([], {
"fetchSelectedTable": t.func("any"),
"fetchSelectedRecord": t.func("any", t.param("rowId", "number")),
"allowSelectBy": t.func("void"),
"setSelectedRows": t.func("void", t.param("rowIds", t.union(t.array("number"), "null"))),
"setCursorPos": t.func("void", t.param("pos", "CursorPos")),
});
export const AccessTokenOptions = t.iface([], {
"readOnly": t.opt("boolean"),
});
export const AccessTokenResult = t.iface([], {
"token": "string",
"baseUrl": "string",
"ttlMsecs": "number",
});
const exportedTypeSuite: t.ITypeSuite = {
UIRowId,
CursorPos,
ComponentKind,
GristAPI,
GristDocAPI,
GristView,
AccessTokenOptions,
AccessTokenResult,
};
export default exportedTypeSuite;