Warning

Nous commençons tout juste à traduire la documentation pour cette langue, désolé !

Nous affichons des pages traduites partiellement afin de suivre l’avancement.

Cette page n’est pas encore traduite. Mais la bonne nouvelle est que vous pouvez rejoindre la communauté de traduction pour nous aider 👋.

Interface: FetchSelectedOptions

grist-plugin-api.FetchSelectedOptions

Options for functions which fetch data from the selected table or record:

• onRecords
• onRecord
• fetchSelectedRecord
• fetchSelectedTable
• GristView.fetchSelectedRecord
• GristView.fetchSelectedTable

The different methods have different default values for keepEncoded and format.

Table of contents

Properties

• cellFormat
• expandRefs
• format
• includeColumns
• keepEncoded

Properties

cellFormat

• Optional cellFormat: CellFormatType

How each cell’s value is represented. See CellFormatType.

---

expandRefs

• Optional expandRefs: boolean

• true (default): the returned data will show the contents of references, not their rowIds
• false: the returned data will only display rowIds for references

Setting cellFormat: "typed" changes the default to false.

---

format

• Optional format: "columns" | "rows"

• rows, the returned data will be an array of objects, one per row, with column names as keys.
• columns, the returned data will be an object with column names as keys, and arrays of values.

---

includeColumns

• Optional includeColumns: "normal" | "shown" | "all"

• shown (default): return only columns that are explicitly shown in the right panel configuration of the widget. This is the only value that doesn’t require full access.
• normal: return all ‘normal’ columns, regardless of whether the user has shown them.
• all: also return special invisible columns like manualSort and display helper columns.

---

keepEncoded

• Optional keepEncoded: boolean

• true: the returned data will contain raw CellValue’s.
• false: the values will be decoded, replacing e.g. ['D', timestamp] with a moment date.