IFrameEditor
Defined in: js-api/src/grid.ts:916
What a Grid needs from an editing engine over its frame (see
Grid.attachEditor): the grid reports edits through beginEdit /
commitEdit, paints from isChanged / errorOf, and gates editing on
writableColumns / isSaving. DG.DomainFrameEditor is the platform's
implementation; the editor itself subscribes to no grid events.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
isSaving | readonly | boolean | - | js-api/src/grid.ts:934 |
onChanged | readonly | Observable<unknown> | - | js-api/src/grid.ts:935 |
onRefreshed | readonly | Observable<DataFrame> | Fires with the NEW frame when the editor rebuilt it — the grid rebinds. | js-api/src/grid.ts:937 |
onSavingChanged | readonly | Observable<boolean> | - | js-api/src/grid.ts:938 |
writableColumns | readonly | string[] | null | The columns the user may edit; null (or empty) when NOTHING in the frame can be edited — the whole grid is read-only. | js-api/src/grid.ts:933 |
Methods
beginEdit()
beginEdit(
row):void
Defined in: js-api/src/grid.ts:917
Parameters
| Parameter | Type |
|---|---|
row | number |
Returns
void
canEdit()
canEdit(
row,column):boolean
Defined in: js-api/src/grid.ts:923
Whether this one cell may be edited — the row dimension writableColumns cannot express (a per-row right, a draft the caller may not insert).
Parameters
| Parameter | Type |
|---|---|
row | number |
column | string |
Returns
boolean
commitEdit()
commitEdit(
row,column):void
Defined in: js-api/src/grid.ts:918
Parameters
| Parameter | Type |
|---|---|
row | number |
column | string |
Returns
void
errorOf()
errorOf(
row,column): {kind:"error"|"conflict";message:string; } |null
Defined in: js-api/src/grid.ts:920
Parameters
| Parameter | Type |
|---|---|
row | number |
column | string |
Returns
{ kind: "error" | "conflict"; message: string; } | null
isChanged()
isChanged(
row,column):boolean
Defined in: js-api/src/grid.ts:919
Parameters
| Parameter | Type |
|---|---|
row | number |
column | string |
Returns
boolean
refusalOf()?
optionalrefusalOf(row,column):string|null
Defined in: js-api/src/grid.ts:926
Why the cell may not be edited, in the user's own vocabulary (the row's name, the column's caption) — the grid's refusal message; optional, a generic one otherwise.
Parameters
| Parameter | Type |
|---|---|
row | number |
column | string |
Returns
string | null
refuse()?
optionalrefuse(row,column,message):void
Defined in: js-api/src/grid.ts:930
Told that the host refused an edit of that cell, once per attempt — how a refusal the GRID
detects reaches the editor's error channel (DomainFrameEditor.onRefused), and a host's
status line; optional.
Parameters
| Parameter | Type |
|---|---|
row | number |
column | string |
message | string |
Returns
void