Interface: ReadyPayload#
grist-plugin-api.ReadyPayload
Options when initializing connection to Grist.
Hierarchy#
Omit<InteractionOptionsRequest,"hasCustomOptions">
↳ ReadyPayload
Table of contents#
Properties#
Properties#
allowSelectBy#
• Optional allowSelectBy: boolean
Show widget as linking source.
Inherited from#
Omit.allowSelectBy
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#
• Optional onEditOptions: () => unknown
Type declaration#
▸ (): unknown
Handler that will be called by Grist to open additional configuration panel inside the Custom Widget.
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