Interface: InteractionOptionsRequest#

grist-plugin-api.InteractionOptionsRequest

Initial message sent by the CustomWidget with initial requirements.

Table of contents#

Properties#

• allowSelectBy
• columns
• hasCustomOptions
• requiredAccess

Properties#

allowSelectBy#

• Optional allowSelectBy: boolean

Show widget as linking source.

---

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.

---

hasCustomOptions#

• Optional hasCustomOptions: boolean

Instructs Grist to show additional menu options that will trigger onEditOptions callback, that Widget can use to show custom options screen.

---

requiredAccess#

• Optional requiredAccess: string

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