Interface: CustomSectionAPI#

grist-plugin-api.CustomSectionAPI

Interface for the mapping of a custom widget.

Table of contents#

Methods#

Methods#

configure#

configure(customOptions): Promise<void>

Initial request from a Custom Widget that wants to declare its requirements.

Parameters#

Name Type
customOptions InteractionOptionsRequest

Returns#

Promise<void>


mappings#

mappings(): Promise<null | WidgetColumnMap>

Returns current widget configuration (if requested through configuration method).

Returns#

Promise<null | WidgetColumnMap>