Interface: ReadyPayload#

grist-plugin-api.ReadyPayload

Options when initializing connection to Grist.

Hierarchy#

ReadyPayload

Table of contents#

Properties#

Properties#

columns#

Optional columns: ColumnsToMap

Tells Grist what columns Custom Widget expects and allows user to map between existing column names and those requested by Custom Widget.

Inherited from#

Omit.columns


onEditOptions#

onEditOptions: () => unknown

Handler that will be called by Grist to open additional configuration panel inside the Custom Widget.

Type declaration#

▸ (): unknown

Returns#

unknown


requiredAccess#

Optional requiredAccess: string

Required access level. If it wasn’t granted already, Grist will prompt user to change the current access level.

Inherited from#

Omit.requiredAccess