Interface: CursorPos#

grist-plugin-api.CursorPos

Represents the position of an active cursor on a page.

Table of contents#

Properties#

• fieldIndex
• linkingRowIds
• rowId
• rowIndex
• sectionId

Properties#

fieldIndex#

• Optional fieldIndex: number

The index of the selected field in the current view.

---

linkingRowIds#

• Optional linkingRowIds: UIRowId[]

When in a linked section, CursorPos may include which rows in the controlling sections are selected: the rowId in the linking-source section, in that section’s linking source, etc.

---

rowId#

• Optional rowId: UIRowId

The rowId (value of the id column) of the current cursor position, or ‘new’ if the cursor is on a new row.

---

rowIndex#

• Optional rowIndex: number

The index of the current row in the current view.

---

sectionId#

• Optional sectionId: number

The id of a section that this cursor is in. Ignored when setting a cursor position for a particular view.