Skip to main content

Interface: ColumnToggleContext

Defined in: model/field.ts:68

What a toggle column's onToggle receives: the Entry, the Field, and the value a default toggle would write.

Properties​

announceEdit​

announceEdit: () => void

Defined in: model/field.ts:79

Tells entryEdit listeners that this switch wrote. Call it once, after your own write, also after an async write such as a confirm dialog. It reads from (the value beforeEntryEdit saw) and to (the value the Entry holds now), so it takes no argument. It announces even when to equals from, as the built-in editor does. A second call does nothing. It does nothing after the Entry leaves the Dataset. The default write announces for you. A custom onToggle that never calls this helper leaves entryEdit listeners blind to the switch.

Returns​

void

entry​

entry: Entry

Defined in: model/field.ts:69

field​

field: FieldKey

Defined in: model/field.ts:70

nextValue​

nextValue: boolean

Defined in: model/field.ts:72

The opposite of the value the cell shows now. An empty cell reads as false, so this is true.