@ahoo-wang/wow-view-engine/react symbol index
Every name @ahoo-wang/wow-view-engine/react exports — 116 — with its kind and the first sentence of its TSDoc, generated from the built declarations. 19 of them are described by hand in the curated pages, linked in the last column; the rest are read from their source through the signature in the API report. This index is English only.
| Symbol | Kind | Summary | Covered in |
|---|---|---|---|
ActionFailureContext | interface | Where a failure the runner reports happened. | — |
ActionRunner | interface | A surface's one runner: its command in flight, and what the last came to. | — |
AnalysisEditorController | interface | — | — |
AnalysisFieldOption | interface | One field and what the definition allows doing with it. | — |
AnalysisResultController | interface | — | — |
BulkActionView | interface | One action as the selection's bar draws it. | — |
BulkFailure | interface | One record the command did not take, and the reason why: the source's words, or the action's own refusal as written (a key stays a key). | — |
BulkOutcome | interface | What one command came to, once every record it started has settled. | — |
BulkProgress | interface | How far a command has come over the records it was handed. | — |
BulkRun | interface | One command over records, as the surface's runner takes it — a declared action's, or a host's own from a slot (run on a slot's context): what it is called, and what it does to one record. | — |
BulkRunning | interface | The command in flight on a surface. | — |
BulkSelection | interface | The records a command runs over, and what a command does to them afterwards: the ones still to be dealt with stay selected (select), the rest are let go, and the view is read again. | — |
DashboardController | interface | — | — |
DashboardOpening | type | What a dashboard opens with, as a host's address has it: the tab on screen and what the filters hold (D22 E, F), and what an embedding page holds of them (held). | — |
DashboardPanelView | interface | One panel, ready to place: geometry, what runs inside, what is wrong. | — |
DrillTarget | interface | What a drill would open, as offered to a host that takes drilling over. | — |
DropCause | type | The edit a drop is said after: a step of the chain, or any other. | — |
DropNotice | interface | What the last edit took out of the question besides what it was asked to — the dimensions and metrics a step of the chain left behind, the derived metrics that read one removed — and the step it followed (D71). | — |
FilterEditorController | interface | One view's filter editor: a tree to edit, plus the things that belong to the view around it — which mode it shows, what is currently applied, and when to run. | — |
FilterTreeController | interface | The part of the controller that edits a tree, and nothing about the view around it. | — |
FollowUp | interface | What the menu over one pressed group shows. | — |
FollowUpAction | type | One thing the follow-up menu offers on a group (D20 追问). | — |
FollowUpGroup | interface | One dimension of the group pressed, for the menu to name it by. | — |
FollowUpHost | type | The part of a workbench the follow-up menu drives (useAnalysisResult): what a dashboard panel hands it in place of one. | — |
HeldView | interface | A view the workbench holds rather than opens by id: made from nothing, or drilled out of another. | — |
InstanceSyncOptions | interface | What the sync watches, and what it does about a disagreement. | — |
LeaveGuard | interface | Leave protection with no dialog in it: the question, and the two answers. | — |
LeaveGuardOptions | interface | — | — |
LeaveGuardState | interface | What the guard reads off the open view. | — |
ManagedInstanceAbilities | interface | What may be done to one row. | — |
MetricRemoval | type | Whether a metric's ✕ may take it out: last when it is the only one,cascade when every other metric reads it and would leave with it — the edit #3777 makes as asked, leaving admission to refuse it. | — |
NewViewOptions | interface | What a workbench needs before it can make a view from nothing. | — |
OpenViewState | interface | — | React Hooks |
PendingAction | interface | An action pressed and waiting on the reader: its question, its form. | — |
QuestionEditing | type | — | — |
QuestionEditingInput | interface | — | — |
RecordActionSlots | interface | Where a host hangs markup of its own on a record surface — the escape hatch beside the declared actions (actions(), host-integration.md 5), drawn after them: a link out, a control the declarations cannot say. | React Hooks |
RecordActionTable | interface | What of a record table the actions read and act on. | — |
RecordActionsController | interface | The declared actions of one record surface (host-integration.md 5): what each record and the selection are offered, the press that asks first or runs, the question or form waiting on the reader, and the one runner every command on the surface goes through — a few at a time, its progress, its stop, its outcome, the refresh after. | — |
RecordActionsOptions | interface | — | React Hooks |
RecordBulkActionContext | interface | — | — |
RecordDetailControl | interface | Who says which record the detail has open, as value and onChange say it on an input. | — |
RecordDetailController | interface | — | — |
RecordDetailPlacement | type | — | — |
RecordDetailSection | interface | A section the host adds to a record's detail, beside the ones the engine lays out from the definition's field groups (detailSections) — what the definition cannot say because it is the application's: a form that acts on the record, a stack trace read the host's way, the record's history as an embedded view (G2). | — |
RecordDetailSectionContext | interface | — | — |
RecordExportController | interface | — | — |
RecordExportOptions | interface | — | — |
RecordExportOutcome | interface | What one finished export produced, until the next run or reset(). | — |
RecordExportProgress | interface | — | — |
RecordExportScope | type | The two readings of "export": what is picked, and what the conditions match. | — |
RecordExportScopes | interface | — | — |
RecordGlobalActionContext | interface | — | — |
RecordRowActionContext | interface | — | — |
RecordTableController | interface | — | — |
RecoveredWrite | interface | What replaying a write answered: whether it landed, and what it made. | — |
RefreshController | interface | How often this view renews its own answer, and the way to run one now. | — |
Reshape | type | A change to what is grouped or measured; see useAnalysisEditor's reshape. | — |
ReshapeProposal | type | What a change to the question proposes: the groups and metrics, the chain where it moves, and what the change itself took out beyond what it was asked to (withElements' dropped), for the editor to say. | — |
RowActionView | interface | One action as a record's row, menu or detail draws it. | — |
SaveAbilities | interface | — | — |
SaveCommandState | interface | — | — |
SaveCommands | interface | — | — |
SaveTargetInput | interface | — | — |
SearchBoxController | interface | A view's search, kept on hand rather than behind the conditions editor. | — |
SettledWrite | interface | What a command ended as, and the address of the write behind it. | — |
SnapshotOf | type | The snapshot a runtime hands out. | — |
SplitOption | interface | A dimension a group can be split by: a field the result is not grouped on. | — |
ToggleSelectionOptions | interface | How RecordTableController.toggle treats the rows around one. | — |
ToggleSortOptions | interface | How RecordTableController.toggleSort treats the other columns. | — |
UnavailableController | interface | What an open view uses that its source no longer admits, and the one press that takes it out (capabilities.md Q2, ViewRuntime.unavailable). | — |
VALUE_CANDIDATE_DEBOUNCE_MS | const | How long typing may pause before the values holding it are asked for. | — |
ValueCandidatesController | interface | — | — |
ViewListOptions | interface | — | — |
ViewListReloadOptions | interface | What a caller already knows about the list it is asking to be read again. | — |
ViewListState | interface | — | React Hooks |
ViewManagerAbilities | interface | — | — |
ViewManagerController | interface | — | — |
ViewOrigin | interface | Where a held view came from: the view it was drilled out of, and the conditions the drill added. | — |
ViewRuntimeStore | interface | What useViewRuntime needs: any runtime satisfies it. | — |
WorkbenchController | interface | Everything a workbench needs that is not its own markup: which views there are, which one is open, what it says, and what happens when the user moves to another. | — |
WorkbenchOptions | interface | — | React Hooks |
browserRuntimeEnvironment | function | The host a browser provides: ambient clock and timers, real visibility. | — |
documentVisibility | function | Page visibility as the browser reports it, so a hidden tab stops auto-refreshing. | — |
failureReasons | function | The reasons a command's failures give, most common first — the strip says a few of them rather than one reason for all, since records refuse for different reasons and the most common is the one to fix first. | — |
kindMismatch | function | The reason a view that opened cannot be drawn here, or nothing. | — |
ownedNavigation | function | An analysis the board owns, opened in the workbench (「在工作台中打开」): it has no saved view to open, so it goes as a view nobody saved, taking what its panel takes off the board (handOver). | — |
retryableOpen | function | Whether a failure to open may go away by itself, so trying again is worth offering: the store could not be reached or could not answer (view.open.failed.unavailable, ….server), or what failed said nothing the engine knows (view.open.failed). | — |
toIssue | function | One Issue for whatever a command threw, so a caller renders a single shape. | — |
useAnalysisEditor | function | — | React Hooks |
useAnalysisResult | function | The analysis result as a host draws it (phase-2 review, developer #9): which rows, which chart over them, what the picker offers, and what a press on one group can do next. | React Hooks |
useAutoRefresh | function | The auto-refresh of one open view, as a control can offer it. | — |
useDashboard | function | A dashboard as a grid of panels. | React Hooks |
useFilterEditor | function | Editing of the draft filter tree, addressed by path. | React Hooks |
useHandOver | function | Opens each new handOver once, through the leave guard (D22 H, D26 Q30): a view a dashboard or an embed sent through the host's route. | — |
useHandedConditions | function | A saved view handed over (SavedViewTarget), once it is open by its id: what the reader set on the board goes onto its own conditions and runs — so it opens 「已修改」, the conditions on 「正在显示」 each removable, and 「还原」 takes them back off. | — |
useHandedRemoval | function | The filter editor of a saved view handed over (SavedViewTarget), whose ✕ on 「正在显示」 takes a condition the board handed it off rather than blanking it (D26 Q30). | — |
useInstanceSync | function | Keeps the host's value and the open view in agreement. | — |
useLeaveGuard | function | The confirmation that stands between an open view and the next one. | React Hooks |
useOpenView | function | Opens an instance and owns the runtime it produced: changing the id or unmounting disposes the previous one, and a response that arrives after that is dropped rather than applied to a view nobody is looking at. | React Hooks |
usePanelFollowUps | function | The follow-ups on a dashboard panel's groups (D22 H): the analysis view's own menu — the records behind a group, the question split by another dimension, the question of the group alone — each opened through the host's route (navigate) as a view nobody saved, rather than beside the panel: a board has no "beside". | — |
useRecordActions | function | — | React Hooks |
useRecordDetail | function | One record's detail (production review A2): what an operator opens to read a failure whole — the message a column clipped, the stack trace no column holds. | — |
useRecordExport | function | Exporting the result: the rows that are picked, or everything the applied conditions match. | — |
useRecordTable | function | A record view as a table renders it, with no vendor types in sight. | React Hooks |
useRefreshCountdown | function | Whole seconds until the next automatic refresh, redrawn once a second. | — |
useReleaseDeleted | function | Lets the pinned view go once it is gone. | — |
useSaveCommands | function | The write commands of one open view, with the permissions that decide which buttons are live. | React Hooks |
useSearchBox | function | — | — |
useUnavailable | function | The view's unavailable parts, read again whenever its snapshot changes, or null when there are none — so a surface draws its strip only where there is something to say. | — |
useValueCandidates | function | A condition's values offered from the data: the list of oneValueCandidateSource, asked for while active. | — |
useViewEngine | function | Creates one engine for the lifetime of the component and disposes it on unmount. | React Hooks |
useViewList | function | The list, the preferences and the permissions of one definition. | React Hooks |
useViewManager | function | Managing the views a list shows, rather than the one that is open: rename, move to the other audience, delete, reorder and choose a default, with the recovery actions for writes that no runtime owns. | React Hooks |
useViewRuntime | function | Subscribes to a runtime. | React Hooks |
useWorkbench | function | The shell of one workbench, without any of its look. | React Hooks |