DomainObjectHandler<T>

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

The per-table ObjectHandler for domain rows: reflective (it takes columns, labels, choices and access from the runtime registry, so it works on ANY table without codegen) and delegating (every render member falls through to the platform's Dart meta for that table).

class IssueHandler extends DG.DomainObjectHandler {
  constructor() { super('grit.issue'); }
  renderCard(x) { return ui.divText(`#${x.values.number} ${x.values.title}`); }
}
DG.ObjectHandler.register(new IssueHandler());

Dispatch precedence (unchanged by this class):

Rendering — the last-registered JS handler applicable to the object wins ObjectHandler.forEntity; the platform's per-table meta demotes itself behind it regardless of registration order.
Overriding nothing is never a regression — an override-nothing subclass renders exactly like the platform, because the defaults below delegate to the same Dart meta the platform would have used.
Platform commands stay — Edit/Delete/Share/Watch/History context-menu commands remain the platform's, permission-gated; a JS handler ADDS actions (registerParamFunc), it never replaces those.
Grid cells keyed by semType keep their registered cell renderer.

Extends

ObjectHandler<T>

Type Parameters

Type Parameter	Default type
`T`	`DomainRow`

Constructors

Constructor

new DomainObjectHandler<T>(table): DomainObjectHandler<T>

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

[table] addresses the domain table as '<schema>.<table>' (also the row entity type and semType); a malformed address throws immediately.

Parameters

Parameter	Type
`table`	`string`

Returns

DomainObjectHandler<T>

Overrides

ObjectHandler.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`dart`	`public`	`any`	-	`ObjectHandler`.`dart`	js-api/ui.ts:1637
`schemaName`	`readonly`	`string`	Domain schema name of table.	-	js-api/src/domains-ui.ts:110
`table`	`readonly`	`string`	-	-	js-api/src/domains-ui.ts:117
`tableName`	`readonly`	`string`	Table name of table within schemaName.	-	js-api/src/domains-ui.ts:112

Accessors

client

Get Signature

get protected client(): DomainTableClient

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

Client for this table (grok.dapi.domains.table(this.table)).

Returns

DomainTableClient

dartMeta

Get Signature

get protected dartMeta(): EntityMetaDartProxy | null

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

The platform's per-table meta, as an EntityMetaDartProxy — what the default render members delegate to. Never a JS handler (delegating into one would recurse); null only for a table whose address cannot be parsed. Only a real hit is cached: a miss is re-resolved on the next use, so a handler constructed before the platform metas exist starts delegating as soon as they do.

Returns

EntityMetaDartProxy | null

helpUrl

Get Signature

get helpUrl(): string | null

Defined in: js-api/ui.ts:1644

URL of help page for the object that this meta handles.

Returns

string | null

Inherited from

ObjectHandler.helpUrl

markupRegexp

Get Signature

get markupRegexp(): string | null

Defined in: js-api/ui.ts:1787

Creates a regexp for detecting markup descriptions of an object

Returns

string | null

Inherited from

ObjectHandler.markupRegexp

name

Get Signature

get name(): string

Defined in: js-api/ui.ts:1648

Returns

string

Inherited from

ObjectHandler.name

regexpExample

Get Signature

get regexpExample(): { example: string; nonVariablePart: string; regexpMarkup: string; } | null

Defined in: js-api/ui.ts:1657

Will be used by search providers to get suggestions (like chembl which has regexp matcher) For something like CHEMBL object handler, it should return: regexpMarkup: 'CHEMBL[0-9]+', example: 'CHEMBL1234', nonVariablePart: 'CHEMBL'

Returns

{ example: string; nonVariablePart: string; regexpMarkup: string; } | null

Inherited from

ObjectHandler.regexpExample

type

Get Signature

get type(): string

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

Type of the object that this meta handles.

Returns

string

Overrides

ObjectHandler.type

Methods

access()

access(): Promise<DomainAccess>

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

Effective DomainAccess of the current user on this table. Every affordance below is derived from it — consumers never hand-wire permission checks.

Returns

Promise<DomainAccess>

auditPane()

auditPane(x): HTMLElement

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

The row's audit history as an embeddable element (the History pane of the built-in context panel).

Parameters

Parameter	Type
`x`	`T`

Returns

HTMLElement

cloneRow()

cloneRow(x): Promise<boolean>

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

Opens the platform's create dialog prefilled from [x].

Parameters

Parameter	Type
`x`	`T`

Returns

Promise<boolean>

copyLink()

copyLink(x): void

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

Copies the row's deepLink to the clipboard (with the platform's confirmation balloon).

Parameters

Parameter	Type
`x`	`T`

Returns

void

deepLink()

deepLink(x): string | null

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

Permalink to the row's Entity View (business-key URL when unambiguous, id URL otherwise — the platform's own rule); null for an unsaved row (newRow), which has no address yet.

Parameters

Parameter	Type
`x`	`T`

Returns

string | null

deleteRow()

deleteRow(x): Promise<boolean>

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

Deletes [x] after the standard confirmation.

Parameters

Parameter	Type
`x`	`T`

Returns

Promise<boolean>

editRow()

editRow(x?): Promise<boolean>

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

Opens the platform's edit dialog for [x] — its create dialog when [x] is omitted or unsaved; resolves to whether a row was saved.

Parameters

Parameter	Type
`x?`	`T`

Returns

Promise<boolean>

fromMarkup()

fromMarkup(matches): any

Defined in: js-api/ui.ts:1782

Extract object from parsed markup description

Parameters

Parameter	Type
`matches`	`string`[]

Returns

any

Inherited from

ObjectHandler.fromMarkup

getById()

getById(id): Promise<T | null>

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

Loads the row by id (the acquisition path for a DomainRow in JS); null when it does not exist or is not visible.

Parameters

Parameter	Type
`id`	`string`

Returns

Promise<T | null>

Overrides

ObjectHandler.getById

getCanvasRenderer()

getCanvasRenderer(): CanvasRenderer | null

Defined in: js-api/ui.ts:1682

Returns

CanvasRenderer | null

Inherited from

ObjectHandler.getCanvasRenderer

getCaption()

getCaption(x): string

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

String representation of the [item]: the value of a semantic value or a grid cell, item.toString() otherwise.

Parameters

Parameter	Type	Description
`x`	`T`	item

Returns

string

Overrides

ObjectHandler.getCaption

getDetailTabs()

getDetailTabs(x): Promise<DomainDetailTab[]>

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

FK-inverted child tables scoped to [x] — the child tabs the built-in Entity View shows. Empty for an unsaved row or a table nothing references.

Parameters

Parameter	Type
`x`	`T`

Returns

Promise<DomainDetailTab[]>

getGridCellRenderer()

getGridCellRenderer(): GridCellRenderer<any> | null

Defined in: js-api/ui.ts:1687

Returns

GridCellRenderer<any> | null

Inherited from

ObjectHandler.getGridCellRenderer

getProperties()

getProperties(): Promise<Property[]>

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

Runtime Property metadata of the table's declared columns (type, semType, choices, min/max, nullable, friendly label), bound to DomainRow values. Rejects with a DomainValidationError for a table that is not registered.

Returns

Promise<Property[]>

getRibbonActions()

getRibbonActions(x): Promise<DomainAction[]>

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

Actions available on [x] for the CURRENT user — the JS mirror of the Entity View ribbon plus its default Open action (Open, Edit, Clone, Delete, Share, Watch, History, Copy link), gated by the row's server-truth access columns (a withAccess read, DOMAIN_ACCESS_COLUMNS) and the table's registry metadata. Actions the user may not perform are absent from the list; an unsaved row (newRow) has none of them — it has no address, history or permissions until it is inserted.

The dialog-backed runs delegate to editRow / cloneRow / deleteRow / shareRow / showHistory — override one of those to replace a flow, the action list stays the platform's.

Every action declares DomainAction.changesRow: the platform knows which of its own actions write, so a consumer reloads on it instead of guessing from the caption (which changes with the state: 'Watch' ⇄ 'Unwatch') or from the icon.

Parameters

Parameter	Type
`x`	`T`

Returns

Promise<DomainAction[]>

init()

init(): void

Defined in: js-api/ui.ts:1792

Gets called once upon the registration of meta export class.

Returns

void

Inherited from

ObjectHandler.init

isApplicable()

isApplicable(x): boolean

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

Claims rows of table, including ones wrapped in a SemanticValue (how the platform passes cell values around).

Parameters

Parameter	Type
`x`	`any`

Returns

boolean

Overrides

ObjectHandler.isApplicable

newRow()

newRow(): DomainRow

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

A new, unsaved row of this table — what renderEditor binds to when called without an object. Insert it with grok.dapi.domains.table(...).insert(row.values).

Returns

DomainRow

openRow()

openRow(x): void

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

Opens the row's Entity View — the platform's default (double-click) action for a domain row.

Parameters

Parameter	Type
`x`	`T`

Returns

void

pickRow()

pickRow(options?): Promise<DomainRow | null>

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

Opens the platform's row picker for this table; resolves to the picked row or null. With [options.anchor] it is the drop-down flavour (see DomainObjectHandler.pickRow).

Parameters

Parameter	Type
`options?`	`DomainPickerOptions`

Returns

Promise<DomainRow | null>

refresh()

refresh(x): Promise<T>

Defined in: js-api/ui.ts:1665

Parameters

Parameter	Type
`x`	`T`

Returns

Promise<T>

Inherited from

ObjectHandler.refresh

registerParamFunc()

registerParamFunc(name, run): void

Defined in: js-api/ui.ts:1839

Registers a function that takes applicable objects as the only argument. It will be suggested to run in the context menu for that object, and also in the "Actions" pane on the context panel.

Example: https://public.datagrok.ai/js/samples/ui/docking/docking

Parameters

Parameter	Type	Description
`name`	`string`	function name
`run`	(`param`) => `any`	a function that takes exactly one parameter

Returns

void

Inherited from

ObjectHandler.registerParamFunc

renderCard()

renderCard(x, context?): HTMLElement

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

Renders card div for the item.

Parameters

Parameter	Type	Default value
`x`	`T`	`undefined`
`context`	`any`	`null`

Returns

HTMLElement

Overrides

ObjectHandler.renderCard

renderEditor()

renderEditor(x?): Promise<HTMLElement>

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

Reflective property form over the writable columns of [x] (a new row when omitted) — inputs come from getProperties, and non-writable columns are excluded from the form AND from any payload built off it, mirroring column security. Callers without the corresponding table right (can.insert for a new row, can.edit for an existing one) get a read-only explanation instead: column security alone is NOT table Edit. A richer form (async validation, reference pickers, error mapping) is u2's domainForm.

Parameters

Parameter	Type
`x?`	`T`

Returns

Promise<HTMLElement>

renderGrid()

renderGrid(grid, options?): void

Defined in: js-api/ui.ts:1764

Customizes a Grid presenting a collection of this handler's objects IN PLACE: column order/visibility, captions, cell renderers, interactivity. options.items is the DataFrame backing the grid when the caller wants the handler to tag or (re)bind it; when omitted, operate on grid.dataFrame.

Contract: derive presentation from column tags/semTypes only — the frame may be a pure data frame (e.g. a queryDf result) with NO hidden ~item object column; never assume one. Interactivity that needs the object goes through the semType renderer/context machinery.

Dispatch: OVERRIDING this member takes FULL responsibility for grid decoration of the built-in views (e.g. the Domain View grid). Any handler that does not override it — including one written against this version of the API — falls through to the platform meta for type, from EITHER side: the Dart dispatch skips the sentinel-marked base (see below), and the base itself delegates, so ObjectHandler.forEntity(x).renderGrid(grid) decorates exactly like the platform. To opt out of decoration entirely, override it with an empty body.

Parameters

Parameter	Type
`grid`	`Grid`
`options?`	{ `items?`: `DataFrame`; }
`options.items?`	`DataFrame`

Returns

void

Inherited from

ObjectHandler.renderGrid

renderIcon()

renderIcon(x, context?): HTMLElement

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

Renders icon for the item.

Parameters

Parameter	Type	Default value
`x`	`T`	`undefined`
`context`	`any`	`null`

Returns

HTMLElement

Overrides

ObjectHandler.renderIcon

renderInput()

renderInput(x, context?): InputBase<any> | null

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

Renders an input for the item (e.g. to be used in forms); null when the handler does not define one.

Parameters

Parameter	Type	Default value
`x`	`T`	`undefined`
`context`	`any`	`null`

Returns

InputBase<any> | null

Overrides

ObjectHandler.renderInput

renderListItem()

renderListItem(x, context?): HTMLDivElement

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

Renders the item as a list item — used when displaying objects in lists (such as wide html grids, or popups in type-ahead boxes). By default, renders the item's name.

Parameters

Parameter	Type	Default value
`x`	`T`	`undefined`
`context`	`any`	`null`

Returns

HTMLDivElement

Overrides

ObjectHandler.renderListItem

renderMarkup()

renderMarkup(x, context?): HTMLElement

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

Renders markup for the item. [context] says what the item is being rendered FOR, so one handler can serve several surfaces. The platform's many-to-many chips pass {relation, table, input: 'tags'} — the relation's name, the OWNER's '<schema>.<table>', and the widget kind. A chip's DG.DomainRow is a {id, displayName} stub with no column values, so read its name through getCaption(x) / x.displayName — x.values[nameColumn] is undefined there.

Parameters

Parameter	Type	Default value
`x`	`T`	`undefined`
`context`	`any`	`null`

Returns

HTMLElement

Overrides

ObjectHandler.renderMarkup

renderPreview()

renderPreview(x, params?, path?): Promise<View>

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

Renders preview list for the item.

Parameters

Parameter	Type
`x`	`T`
`params?`	`any`
`path?`	`string`

Returns

Promise<View>

Overrides

ObjectHandler.renderPreview

renderProperties()

renderProperties(x, context?): HTMLElement

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

Renders properties list for the item.

Parameters

Parameter	Type	Default value
`x`	`T`	`undefined`
`context`	`any`	`null`

Returns

HTMLElement

Overrides

ObjectHandler.renderProperties

renderTooltip()

renderTooltip(x, context?): HTMLElement

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

Renders tooltip for the item.

Parameters

Parameter	Type	Default value
`x`	`T`	`undefined`
`context`	`any`	`null`

Returns

HTMLElement

Overrides

ObjectHandler.renderTooltip

renderView()

renderView(x, context?): HTMLElement

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

Renders view for the item.

Parameters

Parameter	Type	Default value
`x`	`T`	`undefined`
`context`	`any`	`null`

Returns

HTMLElement

Overrides

ObjectHandler.renderView

rowFrom()

rowFrom(values): DomainRow

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

Wraps [values] — one row of a query() result — as a DomainRow of this table, locally and WITHOUT a round trip: the acquisition path a list, a card or a context panel uses to render, address and act on rows it already fetched (getById is the one that asks the server). Identity (displayName, semValue, deep links) resolves from the registry, so a row fetched without its business-key columns addresses itself by id. Anything but a plain values map (or null, for a new row) is REJECTED by name: read key by key, a string or an array produces a row of nonsense values that only shows up much later, as a card with no identity.

Parameters

Parameter	Type
`values`	{[`key`: `string`]: `any`; } \| `null`

Returns

DomainRow

rowOf()

protected rowOf(x): DomainRow | null

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

The DomainRow behind [x] (unwrapping a SemanticValue) when it belongs to this table, null otherwise. Use it in overrides instead of casting — handler members receive both shapes.

Parameters

Parameter	Type
`x`	`any`

Returns

DomainRow | null

rowOrThrow()

protected rowOrThrow(x): DomainRow

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

rowOf, for the members that cannot act without a row: throws a named error naming the table instead of failing later on a null.

Parameters

Parameter	Type
`x`	`any`

Returns

DomainRow

setWatch()

setWatch(x, value): Promise<boolean>

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

Subscribes/unsubscribes the current user to changes of [x]; resolves to the resulting state (the server refuses row watch on tables without an audit trail, and the state then stays unchanged).

Parameters

Parameter	Type
`x`	`T`
`value`	`boolean`

Returns

Promise<boolean>

shareRow()

shareRow(x): Promise<void>

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

Opens the standard sharing flow for [x] (row-mode tables); resolves when the sharing dialog is SHOWN, not when sharing is done.

Parameters

Parameter	Type
`x`	`T`

Returns

Promise<void>

showHistory()

showHistory(x): void

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

Shows the row's audit history in the platform's History dialog.

Parameters

Parameter	Type
`x`	`T`

Returns

void

toMarkup()

toMarkup(T): string | null

Defined in: js-api/ui.ts:1777

Converts object to its markup description

Parameters

Parameter	Type
`T`	`any`

Returns

string | null

Inherited from

ObjectHandler.toMarkup

toString()

toString(): string

Defined in: js-api/ui.ts:1650

Returns

string

Inherited from

ObjectHandler.toString

auditPane()

static auditPane(row): HTMLElement

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

The row's audit trail as an embeddable element: who / when / what, newest first, with the field diff in each row's tooltip and a link opening the full event list as a table. Explains itself when the table has no audit trail.

Parameters

Parameter	Type
`row`	`DomainRow`

Returns

HTMLElement

cloneRow()

static cloneRow(row): Promise<boolean>

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

Opens the create dialog prefilled from [row] (writable columns only).

Parameters

Parameter	Type
`row`	`DomainRow`

Returns

Promise<boolean>

copyLink()

static copyLink(row): void

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

Copies [row]'s deepLink to the clipboard, with the platform's confirmation balloon; a no-op for an unsaved row.

Parameters

Parameter	Type
`row`	`DomainRow` \| `null`

Returns

void

createRow()

static createRow(table): Promise<boolean>

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

Opens the platform's create dialog for [table] ('<schema>.<table>'); resolves to whether a row was saved. Inputs come from the registry, values are validated with the same code the server re-runs, columns the caller cannot write are absent from the form AND the payload.

Parameters

Parameter	Type
`table`	`string`

Returns

Promise<boolean>

decorateGrid()

static decorateGrid(grid, table, dataFrame?): void

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

Customizes [grid] the way the platform customizes every grid over [table]'s rows: column captions, reference cells showing display names, the name column first, system and ~ columns hidden. Pair it with Grid.attachEditor for an editable grid.

Decoration goes through the handler that WINS dispatch for the table, which is safe for plain handlers — one that does not override renderGrid falls through to the platform meta from the JS side too.

Which is not a one-liner, because forEntity resolves plenty of handlers that must NOT be decorated through. It applies the collapse rule of the built-in Domain View (DomainView.refreshGrid) branch for branch — with the Dart one widened, since the Dart rule names DomainRowMeta while every Dart meta reaches JS as one wrapping proxy:

a DART meta collapses — the resolved proxy may be the inert GENERIC 'DomainRow' fallback (no per-table meta registered, e.g. a session with domain databases not enabled), whose renderGrid early-returns into a raw grid; a registered per-table meta decorates identically to own anyway;
a JS handler WITHOUT a real renderGrid collapses — the base method is a no-op the platform marks isPlatformDefault;
everything else wins, INCLUDING a plugin handler that claims the table through isApplicable under a type of its own.

own's inherited renderGrid reaches the per-table meta regardless of registration, so the collapse never loses decoration.

Parameters

Parameter	Type
`grid`	`Grid`
`table`	`string`
`dataFrame?`	`DataFrame`

Returns

void

deepLink()

static deepLink(row): string | null

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

Permalink to [row]'s Entity View — the business-key URL when unambiguous, the id URL otherwise; null for an unsaved row, which has no address yet.

Parameters

Parameter	Type
`row`	`DomainRow` \| `null`

Returns

string | null

deleteRow()

static deleteRow(row): Promise<boolean>

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

Deletes [row] after the platform's confirmation; resolves to whether it was deleted — false on cancel, and on a failed delete (a restrict violation, no Delete permission, a server error), which the platform reports in a balloon and then closes the dialog.

Parameters

Parameter	Type
`row`	`DomainRow`

Returns

Promise<boolean>

editRow()

static editRow(row): Promise<boolean>

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

Opens the platform's edit dialog for [row]; resolves to whether it was saved. A version conflict goes through the standard reload/overwrite dialog — reloading and saving in the reopened dialog still resolves true.

Parameters

Parameter	Type
`row`	`DomainRow`

Returns

Promise<boolean>

forEntity()

static forEntity(object, context?): ObjectHandler<any> | null

Defined in: js-api/ui.ts:1815

Parameters

Parameter	Type	Default value
`object`	`any`	`undefined`
`context`	`any`	`null`

Returns

ObjectHandler<any> | null

Inherited from

ObjectHandler.forEntity

forSemType()

static forSemType(semType): Promise<ObjectHandler<any>[]>

Defined in: js-api/ui.ts:1826

Parameters

Parameter	Type
`semType`	`string`

Returns

Promise<ObjectHandler<any>[]>

Inherited from

ObjectHandler.forSemType

grantsPane()

static grantsPane(entityId, name?, options?): HTMLElement

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

Read-only grants pane of a REGISTRY entity — a schema, table or property schema id (DomainTable.id, grok.dapi.domains.registry), NOT a domain row: rows are shared through shareRow. Lists the direct permission rows plus a 'Manage access...' link ([options.readOnly] drops the link); listing requires Share, and non-Share callers get an explanation instead.

Parameters

Parameter	Type
`entityId`	`string`
`name?`	`string`
`options?`	{ `readOnly?`: `boolean`; }
`options.readOnly?`	`boolean`

Returns

HTMLElement

list()

static list(): ObjectHandler<any>[]

Defined in: js-api/ui.ts:1807

All registered handlers

Returns

ObjectHandler<any>[]

Inherited from

ObjectHandler.list

onResolve()

static onResolve(observer): Subscription

Defined in: js-api/ui.ts:1811

Parameters

Parameter	Type
`observer`	`PartialObserver`<`ObjectHandlerResolutionArgs`>

Returns

Subscription

Inherited from

ObjectHandler.onResolve

openPath()

static openPath(path): void

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

Opens a /domains address through the platform's own navigation: row deep links, table views, and the scoped child-table views getDetailTabs produces. THE navigation entry point for domain addresses — do not re-spell it with grok.shell.route, which pushes history differently.

Parameters

Parameter	Type
`path`	`string`

Returns

void

openRow()

static openRow(row): void

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

Opens [row]'s Entity View — the platform's default (double-click) action.

Parameters

Parameter	Type
`row`	`DomainRow` \| `null`

Returns

void

pickRow()

static pickRow(table, options?): Promise<DomainRow | null>

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

Opens the platform's lookup picker for [table] ('<schema>.<table>') — the target table's Domain View with search and single select; resolves to the picked row, or null on cancel.

With [options.anchor] the picker is a headless DROP-DOWN: no caption or buttons, opening below the anchor element and right-aligned with it, closing on the item click that picks, on an outside click, and on ESC. Without it, the picker is the modal dialog (the flavour to keep for richer interactions).

Parameters

Parameter	Type
`table`	`string`
`options?`	`DomainPickerOptions`

Returns

Promise<DomainRow | null>

register()

static register(meta): void

Defined in: js-api/ui.ts:1795

Registers entity handler.

Parameters

Parameter	Type
`meta`	`ObjectHandler`

Returns

void

Inherited from

ObjectHandler.register

shareRow()

static shareRow(row): Promise<void>

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

Opens the standard sharing flow for [row]: the row is promoted to an entity (idempotent, needs Share on it) and the platform sharing dialog follows. Row-mode tables only — elsewhere access comes from the securing table, whose grants are grantsPane's subject. Resolves once the dialog is SHOWN (promotion done, permission denial already ballooned) — NOT when the user finishes sharing; subscribe to the platform's sharing events for that.

Parameters

Parameter	Type
`row`	`DomainRow`

Returns

Promise<void>

showConflictDialog()

static showConflictDialog(subject): Promise<"reload" | "overwrite" | null>

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

The standard optimistic-concurrency dialog for a 409, naming [subject] (the row's display value). Resolves to the user's decision — 'reload' (discard my changes, take the server's), 'overwrite' (retry against the current version), or null when the dialog is dismissed. The caller applies it; the platform's own editors resolve their conflicts through this same dialog.

Parameters

Parameter	Type
`subject`	`string`

Returns

Promise<"reload" | "overwrite" | null>

showGrantsDialog()

static showGrantsDialog(entityId, name?): Promise<void>

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

The editable grants dialog for a registry entity (grant/revoke per group); resolves when it is shown.

Parameters

Parameter	Type
`entityId`	`string`
`name?`	`string`

Returns

Promise<void>

showHistory()

static showHistory(row): void

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

auditPane in the platform's History dialog.

Parameters

Parameter	Type
`row`	`DomainRow`

Returns

void

Extends​

Type Parameters​

Constructors​

Constructor​

Parameters​

Returns​

Overrides​

Properties​

Accessors​

client​

Get Signature​

Returns​

dartMeta​

Get Signature​

Returns​

helpUrl​

Get Signature​

Returns​

Inherited from​

markupRegexp​

Get Signature​

Returns​

Inherited from​

name​

Get Signature​

Returns​

Inherited from​

regexpExample​

Get Signature​

Returns​

Inherited from​

type​

Get Signature​

Returns​

Overrides​

Methods​

access()​

Returns​

auditPane()​

Parameters​

Returns​

cloneRow()​

Parameters​

Returns​

copyLink()​

Parameters​

Returns​

deepLink()​

Parameters​

Returns​

deleteRow()​

Parameters​

Returns​

editRow()​

Parameters​

Returns​

fromMarkup()​

Parameters​

Returns​

Inherited from​

getById()​

Parameters​

Returns​

Overrides​

getCanvasRenderer()​

Returns​

Inherited from​

getCaption()​

Parameters​

Returns​

Overrides​

getDetailTabs()​

Parameters​

Returns​

getGridCellRenderer()​

Returns​

Inherited from​

getProperties()​

Returns​

getRibbonActions()​

Extends

Type Parameters

Constructors

Constructor

Parameters

Returns

Overrides

Properties

Accessors

client

Get Signature

Returns

dartMeta

Get Signature

Returns

helpUrl

Get Signature

Returns

Inherited from

markupRegexp

Get Signature

Returns

Inherited from

name

Get Signature

Returns

Inherited from

regexpExample

Get Signature

Returns

Inherited from

type

Get Signature

Returns

Overrides

Methods

access()

Returns

auditPane()

Parameters

Returns

cloneRow()

Parameters

Returns

copyLink()

Parameters

Returns

deepLink()

Parameters

Returns

deleteRow()

Parameters

Returns

editRow()

Parameters

Returns

fromMarkup()

Parameters

Returns

Inherited from

getById()

Parameters

Returns

Overrides

getCanvasRenderer()

Returns

Inherited from

getCaption()

Parameters

Returns

Overrides

getDetailTabs()

Parameters

Returns

getGridCellRenderer()

Returns

Inherited from

getProperties()

Returns

getRibbonActions()