Skip to main content

DomainGridOptions

Defined in: js-api/src/ui/domains/domains-grid.ts:118

Options of DomainGrid.create.

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
capabilities?DomainTableCapabilitiesPre-probed capabilities, to avoid a second round trip when the caller already has them (a DomainGrid passes its own).DomainFrameEditorOptions.capabilitiesjs-api/src/ui/domains/domains-editor.ts:74
defaults?objectValues every row added through the toolbar starts with — how a detail grid of a master-detail page prefills the foreign key of its parent, so 'Add row' produces a saveable row instead of one failing on a required column.-js-api/src/ui/domains/domains-grid.ts:128
editable?booleanMaster switch for editing; ANDed with the table's canEdit capability, so a table the user may not edit is read-only whatever this says.-js-api/src/ui/domains/domains-grid.ts:121
query?DomainQuerySpec<string, string>The query the frame came from — what DomainFrameEditor.refresh re-runs, and what DomainFrameEditor.create runs to build it.DomainFrameEditorOptions.queryjs-api/src/ui/domains/domains-editor.ts:71
toolbar?booleanShow the toolbar (unsaved-change count, Save/Cancel, Add/Delete row). Defaults to true; turn it off to drive the editor from your own ribbon.-js-api/src/ui/domains/domains-grid.ts:124