Class FormulaAssist

The formula input of the cell editor (prompt 013 stage 6, tableOptions.cellFormulas): pointing (arrow keys, Shift

arrow keys, a click or a drag insert references while the caret stands at an insertion point), F4 ($), colored references in the text (a mirror behind the transparent text of the input) with frames around the referenced cells, function suggestions (an ARIA combobox with a listbox) and the argument hint (a tooltip). Created by the CellEditorService for a text field in a formula column.

Since

1.1.99

Hierarchy

FormulaAssist

Index

Constructors

Methods

destroy getOwnedIds onKeyDown onPointerDown update

Constructors

constructor

new FormulaAssist(scope, sheet, input, container, editedCell, changed, idPrefix): FormulaAssist
Parameters
- scope: TableScope
- sheet: TableSheet
- input: HTMLInputElement
- container: HTMLDivElement
- editedCell: (() => [number, number])
  - - (): [number, number]
    - Returns [number, number]
- changed: (() => void)
  - - (): void
    - Returns void
- idPrefix: string
Returns FormulaAssist
- Defined in src/lib/table/sheet-editing/formula-assist.ts:52

Methods

destroy

destroy(): void
Removes everything (the editor closes).

Returns void
- Defined in src/lib/table/sheet-editing/formula-assist.ts:196

getOwnedIds

getOwnedIds(): string[]
Returns string[]
the ids of the suggestion list and the hint (owned by the edited cell, aria-owns)
- Defined in src/lib/table/sheet-editing/formula-assist.ts:186

onKeyDown

onKeyDown(evt, mode): boolean
A key in the editor: the suggestion list, F4 and pointing. True if it was used (the caller stops it).
Parameters
- evt: KeyboardEvent
  the key
- mode: CellEditMode
  "enter" (typing) or "edit" (F2: arrow keys move the caret)
Returns boolean
true if handled
- Defined in src/lib/table/sheet-editing/formula-assist.ts:115

onPointerDown

onPointerDown(evt): boolean
A pointer press outside the editor: while pointing is possible, a body cell is inserted as reference (Shift: a range from the last pointed cell) and dragging spans a range. True if it was used – the click then neither commits nor moves the selection.
Parameters
- evt: PointerEvent
  the press
Returns boolean
true if handled
- Defined in src/lib/table/sheet-editing/formula-assist.ts:168

update

update(): void
Places the frames and the popups (after every render pass and on changes).

Returns void
- Defined in src/lib/table/sheet-editing/formula-assist.ts:191