Skip to main content

Interface: CommandTarget

Defined in: api/command.ts:140

What focus a chord or a right-click landed on (issue #137) — S5.7's and S5.11's chord scoping ("on a focused header cell", "on a selected bar", "on the splitter") has nothing else in CommandContext to read a when against. Filled by the keymap resolver from view state; a menu or run(id) invocation with no meaningful target for this kind leaves it undefined.

It carries the same entryIds word DomTarget uses, but not always the same set (#199, #212). A DomTarget states a DOM fact: what the node stands for. This states what the command acts on, resolved from the Selection by resolveActedOn below — the Selection when the thing you clicked shares it (either one holds the other), and the thing you clicked when it does not. So a right-click on one of three selected bars names three, a right-click on an unselected row names every Entry that row owns, and a right-click on a row that owns a lone selected bar plus others names only that one bar — the narrower thing the user already picked, left alone (#212).

The id set is empty for a 'header' or 'splitter' target, and for a grouping header row. It is never undefined, so a when counts it with no fallback.

Extends​

Properties​

entryIds​

entryIds: readonly EntryId[]

Defined in: api/command.ts:122

Inherited from​

ActedOn.entryIds


field?​

optional field?: FieldKey

Defined in: api/command.ts:145

Which Grid column this landed on, for a 'header' or 'gridCell' target. field names a column everywhere a column is named (#194) — the same word DomTarget.field, GridColumn.field and a renderer's ctx.column.field already use.


kind​

kind: TargetKind

Defined in: api/command.ts:141