@ahoo-wang/wow-view-engine symbol index
Every name @ahoo-wang/wow-view-engine exports — 455 — with its kind and the first sentence of its TSDoc, generated from the built declarations. 45 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 |
|---|---|---|---|
AbsoluteDateTimeValue | interface | ISO 8601 instants or dates; to is omitted for an open upper bound. | — |
ActionConfirm | interface | The question an action asks before it runs. | Host Wiring |
ActionContext | interface | What an action's rules are asked with: the time they are asked at — the engine's clock, a harness's own in a test — and, where one is known, the input the command would run with (a choice's option, a filled form). | — |
ActionForm | type | An action's form, by field name: what run receives as its input. | — |
ActionFormField | interface | One field of an action's form, drawn by the condition editor's own value controls (FilterValueEditor): a list of options, a number, a yes/no or a line of text. | Host Wiring |
ActionInput | type | What a form (or a choice) gave, by field name. | — |
ActionInputError | class | What an action's run throws when the source refused what the form gave — a value it cannot read, a number past its range — rather than the record. | Host Wiring |
ActionPlace | type | Where a declared action is offered. | — |
ActionRefusal | interface | One record the command will not be sent to, and why. | — |
ActionRow | type | A record as an action is handed it: its key and its data. | — |
ActionTone | type | How much an action costs: danger draws it (and its confirmation) red. | — |
AggregationDatePartName | type | — | — |
AggregationDateUnitName | type | — | — |
AggregationExpressionOperatorName | type | — | — |
AggregationFieldCapability | interface | How one field may be aggregated; shared by root and element fields. | — |
AggregationFunctionName | type | — | — |
AggregationGroupTypeName | type | The Wow aggregation enums as the string literals a config stores. | — |
AnalysisCapability | interface | — | — |
AnalysisColumn | interface | One column of the result table. | — |
AnalysisColumnView | interface | A column of the result table; groups come first, then metrics. | — |
AnalysisDerivedExpression | type | A derived metric's arithmetic: references to earlier metrics, numbers and the four operators. | — |
AnalysisElement | interface | Expansion of an array path; its filter is scoped to the element fields. | — |
AnalysisElementCapability | interface | How an element's fields may be aggregated. | — |
AnalysisExpression | type | Isomorphic to Wow's AggregationExpression. | — |
AnalysisGroup | type | Isomorphic to Wow's AggregationGroup: fields are validated against the definition and enums are stored as literals. | — |
AnalysisHavingExpression | type | Wow's having/derived trees only reference aliases and numbers. | — |
AnalysisLayout | type | — | — |
AnalysisLimitBounds | interface | The range 「前 N 组」 may take, and the N it stands for when nobody said one. | — |
AnalysisLimits | interface | — | — |
AnalysisMetric | type | Isomorphic to Wow's AggregationMetric. | — |
AnalysisNamed | interface | What a dimension or a metric is called on screen, when the analyst gave it a name: the column header, the legend and the reading say this instead of what the field and the summary would compose. | — |
AnalysisProjection | interface | — | — |
AnalysisSort | interface | — | — |
AnalysisSpec | interface | The analyses a host offers, narrowed from what the model grants. | — |
AnalysisTableSpec | interface | — | — |
AnalysisTop | interface | 「每个省只留 GMV 前三的城市」: within each value of the within dimension, keep the first count groups by metric — highest first, or lowest with ASC. | — |
AnalysisViewConfig | interface | Table and chart are stored together, like the two record layouts. | — |
AnalysisViewRuntime | type | An analysis view: a question asked of one source, and its answer. | — |
AnyViewRuntime | type | What opening an instance returns; narrow it by runtime.kind. | — |
ArrangeStep | type | One keyboard command: a step of one grid cell, or a size one cell bigger or smaller. | — |
ArrayFilterValue | type | What one entry of an array field may be. | — |
Availability | type | true, or why not — a key (text(…)) or words, said where shown. | — |
AxisSpec | interface | — | — |
BUILTIN_FIELD_KINDS | const | The kinds this package ships, in the order FieldKindId lists them. | Definitions and Field Kinds |
BoardOrigin | interface | The board a view was opened from: what 「返回〈仪表盘〉」 names, and where it goes — the board on the tab and under the filters it was left on. | — |
BoardValueSource | type | Where one of another board's filters takes its value from, when a press opens that board: - dimension — the group pressed, on this panel's dimension over that field (「这一组的〈维度〉」); - filter — this board's filter of that name, as the reader has it at the press (「这块板的〈筛选〉」, approved 2026-09-23): its value, which is its default until a reader sets another; one left blank sends nothing. | — |
BooleanFilterValue | type | — | — |
BoxplotBox | interface | One box: a group and its five numbers, lowest first. | — |
BoxplotData | interface | — | — |
BoxplotSpec | interface | A boxplot: how a number is spread within each group — its lowest and highest value, its lower and upper quartile and its median, one box per value of one dimension. | — |
BuiltinFieldKindId | type | — | — |
CHART_TYPES | const | Every type, in the order the picker lays them out: the everyday ones first, each new one beside the one it is read against — the gauge after the metric card, whose number it places on a scale; the boxplot, the radar and the parallel axes after the scatter, the other charts of several metrics per group; the sunburst and the tree after the treemap, the other parts of a whole, and the sankey beside them; the calendar after the heatmap, whose cells it lays out as days, and the theme river after the area, whose stack it lets flow; the candlestick after the boxplot, the other chart that draws several numbers of one field as one mark. | — |
CalendarData | interface | — | — |
CalendarDay | interface | One day of a calendar: its bucket, its date in the zone, its number. | — |
CalendarSpec | interface | A calendar heatmap: a number a day, laid out as the calendar lays the days out — weeks across, weekdays down, a year a block — so a season, a weekday rhythm and a single odd day are seen at once. | — |
Candle | interface | One candle: a period and its four numbers. | — |
CandlestickData | interface | — | — |
CandlestickSpec | interface | A candlestick (K 线): how one number moved within each period — where it opened and closed, and how high and low it went — one candle per bucket of one time dimension. | — |
CartesianData | interface | — | — |
CartesianGap | type | Something the spec asked the chart to draw that the kernel left out, and why: a derived line (DerivedGap), or a statistic reference line over a split or over no measured value. | — |
CartesianMissing | type | How a missing point reads: as 0, or as a gap in the line. | — |
CartesianSeries | interface | — | — |
CartesianSpec | interface | — | — |
ChartData | type | What a renderer receives. | — |
ChartFamily | type | The families a chart type belongs to, each the name of the sub-object ofChartSpec its types share: four cartesian types draw one kind of spec, every other type is a family of its own. | — |
ChartFit | interface | — | — |
ChartProfile | interface | A group's profile: its value on each of several metrics, in the order the spec lists them — one shape of a radar, one line of parallel axes. | — |
ChartSpec | interface | Charts are stored per family: the sub-object of the current type is required and the others are kept, so switching families loses nothing. | — |
ChartStage | type | Where a chart failed: its library never arrived, or it threw drawing. | — |
ChartType | type | — | — |
ChartUnfit | type | Why a chart type cannot draw the shape on hand, as a catalogue key. | — |
ColumnCurrency | interface | How a metric column of money in a currency each record holds is read, row by row: the companions telling each row's currency (CurrencyCompanion) — its own, or a derived metric's operands' — and whether its number is written in that currency. | — |
ColumnEdge | type | Which edge the table holds a column against. | — |
ComparisonOperatorName | type | A comparison a time since another moment may make. | — |
ConfigOfKind | type | Narrows a config union member by its kind. | — |
ConflictChoice | type | — | — |
ConflictingState | interface | What the server holds, said by which of the two it is. | — |
ContentPanelKind | type | — | — |
CreateInput | interface | What ViewEngine.create makes a view from: nothing is saved until save. | Engine and Resources |
CrossFilterOutcome | type | What a press that sets a filter did. | — |
CsvOptions | interface | How a CSV is written. | — |
CurrencyReading | type | What currency an amount — one record's, or an aggregate over several — is in, for money whose currency each record holds (RowMoneyNumeric): | — |
CursorPaging | interface | A cursor result: the one way on, when there is one. | — |
DEFAULT_MISSING_KEY | const | The bucket key records with no value of the dimension land in. | — |
DEFAULT_RUNTIME_LIMITS | const | — | — |
DashboardContentPanel | type | Content panels are static: no query, no global filter, no child runtime. | — |
DashboardDefinition | interface | Dashboards own no data; the definition is their catalogue entry. | — |
DashboardEditing | interface | Building the board (batch B1). | — |
DashboardField | interface | A board's filter: one chip on the filter bar, wired to a field of each panel it narrows. | — |
DashboardFilterEditing | interface | Setting up the board's filters, through the draft like every other edit of the board: each goes into the draft and onto the screen at once, and is saved with the board. | — |
DashboardFilterType | type | The six kinds of board filter, each a family of the field kinds it can be wired to: a date filter reaches a date or a datetime, a text one a string or an enum, an id one a reference, a number and a yes-or-no their own, and a search one a record view's search box — asearch field, whose searchFields say where it looks. | — |
DashboardFilters | interface | What a board's filters hold right now: the reader's, never the config's (「筛选值写进地址，不写进配置」). | — |
DashboardLink | interface | — | — |
DashboardPanel | type | — | — |
DashboardPanelBase | interface | — | — |
DashboardPanelState | interface | One panel as the grid renders it. | — |
DashboardRuntime | interface | The public face of a dashboard runtime: a view runtime whose snapshot also carries the panels. | — |
DashboardRuntimeState | interface | — | — |
DashboardTab | interface | One tab of a board: panels are grouped under it, and the global filter sits above them all. | — |
DashboardTarget | interface | A dashboard, opened with filters as its reader's values — the host hands them to DashboardWorkbench's initialFilters (orOpenOptions.filters), never into the board's config. | — |
DashboardTimeGrouping | interface | The board's time grouping (整板 按日／周／月): one choice amongunits that sets the date unit of every panel's time dimension, where the panel's definition allows that unit. | — |
DashboardViewConfig | interface | — | — |
DashboardViewPanel | type | Data panel: shows a record or analysis view and is filtered by the board. | — |
DashboardViewPanelBase | interface | What a data panel holds whichever view it shows; see DashboardViewPanel. | — |
DashboardWidth | type | How wide a board is laid out: its 24 columns spread across whatever holds it (full), or held to a fixed width and centred (fixed), as Metabase's 「固定宽度／全宽」 is the dashboard's own setting. | — |
DataViewConfig | type | The two kinds that ask a question of their own (DataViewConfigBase) and that a ViewRuntime executes; a dashboard owns child runtimes. | — |
DataViewConfigBase | interface | What a view that asks one question of its own — a record view, an analysis — stores besides: its conditions, and the editor mode they are shown in. | — |
DataViewDefinition | interface | — | — |
DatasetCatalog | interface | What DatasetResources reads: the dataset directory, and each dataset's source. | — |
DatasetDirectoryEntry | interface | One dataset of a service's directory, named as wow-client's DatasetEntry names it: the bounded context it lives in, its name there, and its title. | — |
DatasetDuplicate | interface | A dataset a catalog listed under an id an earlier catalog serves: left out, the earlier one's kept. | — |
DatasetOverrides | type | What a host may say over a dataset's derived definition; see DatasetCatalog.overrides. | — |
DatasetRefresh | interface | What one DatasetResources.refresh found. | — |
DatasetRegistrar | interface | The part of an engine DatasetResources drives (ViewEngine is one). | — |
DatasetResource | interface | A dataset served, as registered: its directory entry and its definition id. | — |
DatasetResources | class | Keeps an engine's datasets in step with services' directories: eachrefresh registers a dataset a directory newly lists, registers again one whose version changed, and removes one no directory lists any more. | — |
DatasetResourcesInit | interface | What DatasetResources reads and whom it tells: the catalogs, and the callbacks for what it cannot serve. | — |
DatasetWordingEditor | interface | What a dataset's wording editor reads and writes: the fields the descriptor derives, the wording in force, and a save that stores it and registers the dataset again in the new words. | — |
DatasetWordingStore | interface | Where a dataset's wording is kept; see DatasetCatalog.wordings. | — |
DateDiffUnitName | type | — | — |
DateTemporal | interface | — | — |
DateTimeFilterValue | type | — | — |
DateTimePreset | type | Named calendar windows, in three directions. | — |
DecimalNumeric | interface | — | — |
DefineDatasetSpec | interface | What a host says of a dataset beyond its descriptor. | — |
DefineViewOptions | interface | What defineView needs beyond the snapshot and the host's choices: the field kinds the host registers (ViewEngineOptions.kinds) — the snapshot's comparisons are written on a field of a host's own kind only when its kind is known here, since it is built before any engine is. | Definitions and Field Kinds |
DefineViewSpec | interface | One data definition's choices over its descriptor. | Definitions and Field Kinds |
DefinitionDescribed | interface | What defineView found; see DataViewDefinition.described. | — |
DefinitionFor | type | The definition a config belongs to. | — |
DefinitionLookup | type | How a board's admission reads a definition, by id. | — |
DefinitionNarrowing | interface | What one narrowing found; see DataViewDefinition.narrowing. | — |
DerivedFormat | type | How a derived metric's number reads, as a base metric's reads off its field: a ratio as a percent — the value is the ratio, 0.259 reads 25.9%, never multiplied by a hundred first — money in a currency, or a number with so many decimals. | — |
DerivedGap | type | Why a derived series cannot be computed over this result. | — |
DerivedKind | type | What a derived series computes: the least-squares line through the measured points (trend), the mean of each point and the ones before it (moving-average, over window points), the running total (cumulative, a metric that adds up only), and the running total as a share of the whole (cumulative-share, 累计占比). | — |
DerivedLine | interface | One computed line, as the drawing takes it: a value per point or none. | — |
DerivedSeries | interface | — | — |
DestinationBoard | type | Another board as a click reads it: the instance, its config a board's. | — |
DetailSection | interface | One titled part of a record's detail: the fields a group gathers. | — |
Dropped | interface | What a step of the chain took out of the question. | — |
DurationFilterValue | interface | A time since another moment (N3): the leaf's field is the later moment,from the earlier one, and the condition compares the time between them — 「发货时间 距 付款时间 > 48 小时」 — in unit, a day being 24 hours. | — |
EDITOR_INPUTS | const | Every input shape the engine can draw, as values and not as a type alone. | Definitions and Field Kinds |
EditCommand | type | The edits building a board is made of, by the command that makes each —DashboardEditing and DashboardFilterEditing less the undoing itself. | — |
EditHistoryState | interface | What the history offers now: the step an undo would take back, and a redo. | — |
EditStep | interface | One step of the board's history: the command, and what it was about — a panel's id, a tab's id or a filter's name; null for the time grouping, the fixed scope and the board's width. | — |
EditorDescriptor | interface | Shape of the input an editor should render; never a component name. | Definitions and Field Kinds |
EditorInput | type | — | — |
ElementTitleView | interface | The element field an array of objects is read by, one element at a time (FieldDefinition.elementTitle), resolved to what reading it takes: where it sits within an element, and how it reads. | — |
EnumFilterValue | type | — | — |
EpochTemporal | interface | — | — |
EpochTimeUnit | type | The units of TimeUnit an epoch time is kept in, as Wow spells them. | — |
ExportCancelledError | class | What a cancelled export rejects with. | — |
ExportColumn | interface | The least an export needs of a column: where to read it, what to call it. | — |
ExportFormat | type | How one value is written. | — |
ExportOperation | type | A file or a picture made of a view: the rows read for a file, the file handed over, a chart drawn as an image. | — |
ExportRowsOptions | interface | — | — |
ExportedRows | interface | — | — |
FieldAnalysisSpec | interface | How one field analyses, as a host narrows it (defineView): each member given is a subset of what the path offers, each left out is whatever the source grants. | — |
FieldCellId | type | How a cell reads. | — |
FieldDefinition | interface | One queryable field of a definition. | — |
FieldGroupDefinition | interface | One group of a field picker: a stable id, a label, and its fields in order. | — |
FieldKind | interface | Everything the engine needs to know about one field type. | Definitions and Field Kinds |
FieldKindBlankContext | interface | — | — |
FieldKindCompileContext | interface | — | — |
FieldKindDescribeContext | interface | — | — |
FieldKindDescription | interface | What a FieldKind says about one applied condition. | — |
FieldKindId | type | Identifies a FieldKind: the package registers the built-in ones and an application may register its own, so this stays an open string union. | — |
FieldKindRegistry | type | Kinds available to the kernels, keyed by id. | Definitions and Field Kinds |
FieldKindValidateContext | interface | — | — |
FieldMetricType | type | The metric types that measure one field: a function of its values, how many distinct values it holds, a percentile of them, its value on the earliest or the latest record (期初值／期末值), or any one of them. | — |
FieldNumeric | type | What a number field's value is, beyond a number — Wow's numericQuerySemanticType (#3552), named as the engine names things: how many digits it is kept to, and for an amount of money, whose money it is. | — |
FieldOption | interface | A selectable value: static for enum, resolved for reference. | — |
FieldSpec | interface | One field: what the host says of it, over what its path is. | Definitions and Field Kinds |
FieldTemporal | type | How a time field keeps its time, which is how a condition on it has to write one — Wow's own QuerySemanticType for time, named as Wow names it. | — |
FieldTone | type | What a badge says about the value it wraps, beyond naming it. | — |
FilterCompileContext | interface | When a filter is evaluated, and in which zone. | — |
FilterGroup | interface | — | — |
FilterGroupOperator | type | How a group combines its children: Wow's AND, OR and NOR, as the values it spells them with. | — |
FilterLeaf | interface | — | — |
FilterMode | type | simple mode only admits a single AND group whose children are all leaves. | — |
FilterNode | type | — | — |
FilterOperatorName | type | Operator name as stored in a configuration: the same values as Wow'sFilterOperator, as string literals, so a config stays plain JSON. | — |
FilterPath | type | Where a node sits: child indexes from the root outwards, so [1, 0] is the first child of the second child. | — |
FilterReach | type | What one filter does to one data panel: wired, through which field, and whether auto-connect made the wire; or not wired, and why — its view has no field of the filter's type (「没有可接的字段」), or it has one nobody chose (unwired). | — |
FilterSummaryItem | interface | One applied condition, for the summary bar above a result. | — |
FilterSummaryRelation | type | A relation a kind reads its operator as, where the operator's own word would mislead. | — |
FilterSummaryValue | type | What a condition compares against, as its kind read it. | — |
FilterTree | type | The scope of a view, shared by all three kinds. | — |
FilterValue | type | The semantic value of a leaf. | — |
FixedMoneyNumeric | interface | — | — |
FunnelData | interface | — | — |
FunnelSpec | interface | A funnel: its stages in the business's order. | — |
FunnelStage | interface | — | — |
FunnelStages | type | — | — |
GaugeData | interface | — | — |
GaugeSpec | interface | A gauge: one number placed on a scale, and how far it is from a target — 「离目标多远」 on a wall screen. | — |
GroupNaming | interface | What a name 「{subject} · {group}」 claims: the conditions that select the group, and what the view is without them. | — |
HandOver | interface | What a view takes with it when it leaves a board, in its own field names — the same two parts through every way off it: 「在工作台中打开」, a click's view destination, the follow-up menu and a board's own analysis. | — |
HavingOperator | type | The comparisons one row may make: the model's, never listed again. | — |
HavingRow | interface | One row of the editor: keep the groups whose metric compares so. | — |
HeatmapData | interface | — | — |
HeatmapSpec | interface | — | — |
HeldFilters | interface | What a host holds of a board's filters (DashboardRuntime.holdFilters): each filter named, at the value given — null for its default — and, with unit present, the time grouping at that unit (null for its default). | — |
HierarchyData | interface | — | — |
HierarchyNode | interface | One part of a hierarchy: a value of its level's dimension, its number — a leaf's own row's, a parent's the sum of its parts — and the group values from the outermost level down to it. | — |
HierarchySpec | interface | A sunburst or a tree: a whole broken down level by level, one dimension a level, outermost first — 品类 → 子类. | — |
InstancePermissions | interface | — | Persistence Port |
InstantRange | interface | Resolving a relative or preset value happens at compile time against the injected moment: the kernel never reads the system clock, and the same config run tomorrow produces a different window on purpose. | — |
Issue | interface | A validation finding. | Issue Codes |
IssuePath | type | — | Issue Codes |
IssueSeverity | type | error blocks apply and save; warning is reported without blocking — something is wrong, or the answer could be misread; note is something true about the answer a reader should know, and nothing is wrong: the groups a view's own limit left out, when every row shown is whole. | Issue Codes |
JsonValue | type | Any value a saved configuration may hold: configs are plain JSON. | — |
LiteralEnums | type | Replaces enum members with their string values and leaves everything else untouched, so a Wow protocol type can be reused in a configuration without dragging its enums into stored data. | — |
LocalStorageSnapshotOptions | interface | Where a localStorageSnapshot reads and writes. | — |
MAX_VIEW_CONFIG_BYTES | const | The largest config a saved view may store, in UTF-8 bytes of its JSON: the server's ViewConfigs.MAX_CONFIG_BYTES, mirrored as the title's limit is — below the 256 KB request body a WebFlux server buffers by default, so the server's refusal is the one a larger config meets. | — |
MAX_VIEW_TITLE_LENGTH | const | The longest title a saved view may have, counted in UTF-16 code units after trimming. | — |
MapData | interface | — | — |
MapRegion | interface | One region of a map: a value of the region dimension and its number. | — |
MapSpec | interface | A map: a number per region, each region shaded by it — 按地区看. | — |
MemorySnapshot | interface | Where a MemoryViewStore keeps its state between page loads: the whole state, read and written as one document, synchronously. | Persistence Port |
MemoryState | interface | — | — |
MemoryViewStore | class | The one implementation this package ships: a synchronous map behind the port, for tests, examples and query-only use. | Persistence Port |
MemoryViewStoreOptions | interface | — | Persistence Port |
MetadataFieldKindId | type | Kinds backed by Wow's metadata filters rather than by a document field. | — |
MetricAgainst | type | — | — |
MetricCardData | interface | — | — |
MetricCardSpec | interface | — | — |
MetricCondition | interface | What a metric's own condition (「只算满足条件的记录」) does to the way the metric reads. | — |
MetricFunction | type | Which summary a metric is, in one token. | — |
MetricHeadline | type | — | — |
MetricMove | interface | A metric moved in the list, as far as the rule lets it go. | — |
MetricMoveStop | interface | Why a metric could not go as far as it was asked: the metric it reads, which it must stay after (after), or the derived metric that reads it, which it must stay before (before). | — |
MetricPeriod | interface | The period a trend card's headline is, as its bucket key — a key the card prints the way its column does. | — |
MetricTrend | interface | The time dimension a metric card draws as its sparkline, and how it reads. | — |
NestedTree | interface | A tree held inside a leaf's value, and the fields it is written against. | — |
NewContentPanel | type | A content panel as it is added: what it holds, and optionally a title. | — |
NewFilter | interface | A filter as it is added: its type and its name on the bar. | — |
NewPanel | type | — | — |
NewPanelPlacement | interface | Where a new panel goes; every member has a default. | — |
NewViewPanel | type | A data panel as it is added: a saved view, or one the board owns. | — |
NumberFilterValue | type | — | — |
NumberFormat | type | Formatting shared by cells, summaries and chart axes. | — |
NumberRange | type | Inclusive bounds of a BETWEEN. | — |
OpenCapabilities | interface | What a defineView definition leaves to its source; see DefinitionDescribed.open. | — |
OpenOptions | interface | How ViewEngine.open opens a view, beyond which one. | Engine and Resources |
OptionSource | interface | Remote candidates of a reference field: a paged search, and a lookup by id that says the values rows and saved configs hold as their labels. | — |
OptionSpec | type | One value of a category: its words, or its words and tone; false hides it. | — |
OwnedView | interface | An analysis view that lives only in this dashboard: saved, deleted and shared with the board, never listed among the definition's views. | — |
PagedPaging | interface | Where a paged result stands, as the pager reads it: every number the bar shows and every step it offers, worked out once from what ran. | — |
PanelBinding | interface | Wires a board filter to a field of the panel's view: the filter narrows the panel through that field. | — |
PanelClick | type | What a press on one group of an analysis panel does, set by the board's author (「点击时…」). | — |
PanelDefinition | interface | The definition a panel's view is of, and what its bindings may name. | — |
PanelGrouping | type | What the board's time grouping does to one panel: its time dimension took the unit (taken), or the panel has one that cannot — its definition does not group that field by that unit — and keeps its own (kept); null for a panel with no time dimension, or a board without a time grouping. | — |
PanelLayout | interface | Grid geometry; coordinates are non-negative and sizes positive integers. | — |
PanelPresentation | interface | How a panel looks at its view, over what the view itself says: the layout, the chart and the table's totals row — the members of a view that draw the result rather than ask for it. | — |
PanelReference | interface | What a panel refers to, once the engine has loaded it. | — |
PanelReferences | type | References by instance id. | — |
PanelSize | type | A panel's size without a place: what inRows lays out. | — |
ParallelData | interface | — | — |
ParallelSpec | interface | Parallel coordinates: several metrics per group as one line across as many upright axes, each on its own scale — where a group stands on each, and which move together. | — |
Picked | type | What the panel shows as chosen: a chart type, or the table. | — |
PieData | interface | — | — |
PieSlice | interface | — | — |
PieSpec | interface | — | — |
PlacedLine | interface | A reference line where the kernel placed it: a constant as written, a statistic at the number it came to. | — |
PresetDateTimeValue | interface | A named calendar window, resolved against the evaluation moment. | — |
PressDestination | type | Where a press on a custom destination goes, or why it goes nowhere. | — |
ProjectedAnalysis | interface | — | — |
ProjectedBase | interface | What both kinds carry besides their view: what is wrong with these numbers, as opposed to what is wrong with the config. | — |
ProjectedRecord | interface | — | — |
ProjectedView | type | What one execution produced, already shaped by its kernel. | — |
QueryOperation | type | A query the engine ran, by what it asked for. | — |
QueryStatus | type | — | — |
RadarData | interface | — | — |
RadarSpec | interface | A radar: several metrics per group as one closed shape, an axis per metric each on its own scale — the outline of each group against the others. | — |
ReadOptions | interface | What every read of a store takes: the signal that cancels it. | — |
RecordAction | interface | One declared command on a record. | Host Wiring |
RecordActions | type | A binding's declared actions, as actions() hands them back. | — |
RecordCapability | interface | — | Definitions and Field Kinds |
RecordCardField | interface | One field of a card. | — |
RecordCardSpec | interface | — | — |
RecordCardView | interface | The card layout of the result, resolved against the definition. | — |
RecordColumn | interface | One column of the table layout. | — |
RecordColumnView | interface | A column as the table should render it, with its semantics resolved. | — |
RecordData | type | One row as returned by the business query source. | — |
RecordKanbanSpec | interface | The kanban half of a record view: which field's stages the lanes are, and which of them the reader folded away. | — |
RecordKey | type | The value of a row's rowKey field. | — |
RecordLaneView | interface | One lane of a kanban result: one option of the lane field, or the 「其他」lane of every record whose value is none of them. | — |
RecordLayout | type | How a record view draws its rows: a table, a grid of cards, or the cards laid out in one lane per stage (kanban). | — |
RecordPageTarget | type | Where to read from. | — |
RecordPaging | type | — | — |
RecordPagingMode | type | Which paging protocol the source offers; declared by the definition. | — |
RecordProjection | interface | — | — |
RecordRow | interface | — | — |
RecordSort | interface | — | — |
RecordSummary | interface | — | — |
RecordTableSpec | interface | — | — |
RecordViewConfig | interface | Every layout's settings are stored together, so switching between them keeps the others'; layout only records the current choice. | — |
RecordViewRuntime | interface | Paging and selection belong to Record alone. | — |
ReferenceBand | interface | A stretch of one value axis, from below to, shaded behind the marks. | — |
ReferenceFilterValue | interface | — | — |
ReferenceId | type | A reference id, as a row holds it and OptionSource.resolve is asked. | — |
ReferenceItem | interface | — | — |
ReferenceLabel | type | What a reference id reads as right now. | — |
ReferenceLabelReader | interface | How a view reads reference ids as names: what one id reads as now, and a subscription that says when that may have changed. | — |
ReferenceLabelTimeoutError | class | A lookup that took longer than RuntimeLimits.referenceTimeout. | — |
ReferenceLine | interface | A horizontal rule across the plot: at a constant value, or at astatistic of one drawn metric's measured values — its average or its median over the points drawn, a filled-in 0 left out (batch B). | — |
ReferenceStatistic | type | Where a statistic reference line stands: the mean, or the middle value. | — |
RefreshConfig | interface | Auto-refresh interval in seconds, or null when off. | — |
RefusalGroup | interface | The refused, by reason, the commonest first; ties keep their order. | — |
RelativeDateDirection | type | — | — |
RelativeDateTimeValue | interface | A window measured from the evaluation moment: "the last 7 days", or "the next 7 days". | — |
RelativeDateUnit | type | — | — |
RiverStream | interface | One stream of a theme river: a split value, or the folded rest. | — |
RoutedTarget | type | A way off a board or a view that leads to one of the host's resources. | — |
RowMoneyNumeric | interface | — | — |
RuntimeEnvironment | interface | The only interface between a runtime and its host. | Engine and Resources |
RuntimeFor | type | Keeps the narrow type through create, which knows its config statically — and, for a config whose kind only the value knows (a union), is whatopen hands back (AnyViewRuntime), so no caller has to say it again. | — |
RuntimeLimits | interface | Admission and scheduling budgets. | — |
SankeyData | interface | — | — |
SankeyLink | interface | One band of a sankey, between two nodes of neighbouring levels. | — |
SankeyNode | interface | One node of a sankey: a value of one level's dimension. | — |
SankeySpec | interface | A sankey: how an amount flows from one dimension's values to the next's — 渠道 → 支付方式 — each band as wide as the metric over the rows of that pair. | — |
SaveAsInput | interface | Where a copy of a view is saved: its title and the scope it is saved into (ViewEngine.saveAs, and a board panel's view saved as its own).'system' makes a stored system view, which needs editSystem. | — |
SavedViewTarget | interface | A saved record or analysis view, opened on its own conditions withfilter added to them — so it opens 「已修改」 and 「还原」 takes them back off — under scopeFilter as its scope. | — |
ScatterData | interface | — | — |
ScatterSpec | interface | — | — |
SearchModeName | type | Wow's SearchMode, as the literal a definition writes. | — |
SeriesExtremes | type | Each series' highest and lowest measured value, as point indexes. | — |
ShapeContext | interface | What shaping reads besides the config and the rows. | — |
SizedPanel | type | A dashboard panel whose layout gives only its size, for inRows. | — |
SortDirectionName | type | Sort direction as stored in a config: Wow's SortDirection values. | — |
SourceOptions | interface | What every read of a source takes: the signal that cancels it. | — |
StoreOperation | type | A ViewStore method, as the engine called it. | — |
StoredDatasetWording | interface | A dataset's wording as stored, and the revision a write expects. | — |
StringComparisonName | type | Wow's StringComparison, as the literal a definition writes. | — |
StringFilterValue | type | — | — |
SummaryCell | interface | — | — |
SummaryFunction | type | Row-level aggregations a record view may show under a column: four of Wow's AggregationFunctions and its COUNT metric. | — |
SummaryRow | interface | — | — |
SystemView | interface | A baseline view shipped with the definition. | Definitions and Field Kinds |
Text | type | A key standing where a label goes; a string, so it goes anywhere one does. | Definitions and Field Kinds |
TextResolver | type | How a host says a key in the language in force; undefined for none. | — |
TextWords | type | The words keys are said in: a resolver, or a catalogue by key. | — |
ThemeRiverData | interface | — | — |
ThemeRiverSpec | interface | A theme river: a stacked stream over time, one stream per value of a second dimension, each as wide as its number — how a whole's make-up flows. | — |
TimePrecision | type | How finely a table cell writes a time of day (FieldDefinition.timePrecision). | — |
TreemapData | interface | — | — |
TreemapSpec | interface | A treemap: a whole cut into tiles whose areas are the groups' shares of it — the reading for a composition of more categories than the palette has colours, since every tile carries its own name. | — |
TreemapTile | interface | One tile: a group value and its number. | — |
UnsavedViewTarget | interface | A view nobody saved: a follow-up on a group — its records, the same question split by another dimension or of the group alone — or an analysis the board owns. | — |
VIEW_STORE_ERROR_CODES | const | — | Persistence Port |
ValidateAnalysisOptions | interface | — | — |
ValidateDashboardOptions | interface | — | — |
ValidateDefinitionOptions | interface | — | — |
ValidateFilterOptions | interface | — | — |
ValidateRecordOptions | interface | — | — |
ValueCandidate | interface | One value the data holds, and how many records hold it. | — |
ValueCandidateSource | interface | The values a condition on one field may be picked from, counted from the data (valueCandidatesConfig). | — |
ValueCandidates | interface | What one candidate query answered. | — |
ValueFormat | type | — | — |
ValueMetric | type | A metric whose value is one record's value (VALUE_METRIC_TYPES). | — |
ViewAudience | type | Who a view is for. | — |
ViewChange | interface | What a confirmed write changed about one definition's list of views. | — |
ViewChangeKind | type | The write that changed a list — not the kind of the view it changed. | — |
ViewChangeListener | type | — | — |
ViewCommandError | class | A command the engine refused before dispatching it: a missing definition, an empty title, a permission the user does not hold, a config that still has an error. | — |
ViewConfig | type | What a user saves: the way of observing, never a data snapshot. | — |
ViewConfigBase | interface | What every view kind stores. | — |
ViewDefinition | type | What a dataset offers. | — |
ViewDestination | type | What the host's navigate is handed: a route, where the target's definition has one; otherwise the target as it came — a URL, or a definition the host bound no route for. | — |
ViewEngine | class | The registry and the command entry point: definitions in, runtimes and writes out. | Engine and Resources |
ViewEngineOptions | interface | — | Engine and Resources |
ViewErrorContext | type | Where a failure of any kind happened. | — |
ViewErrorContexts | interface | What each kind of failure says of where it happened. | — |
ViewErrorEvent | type | One failure, as RuntimeEnvironment.onError is told of it: a union onkind, each kind with its own context. | — |
ViewErrorKind | type | What failed, by the part of the engine it failed in. | — |
ViewErrorPlace | interface | Where a failure happened, each member only where the failing part knows it. | — |
ViewHandOver | type | The two a workbench opens (DataWorkbench's handOver). | — |
ViewInstance | interface | A saved config plus its identity. | — |
ViewInstanceSummary | interface | What a list returns: enough to render the sidebar, without the config. | — |
ViewKind | type | — | — |
ViewListOptions | interface | One page of ViewStore.list to read. | — |
ViewListPage | interface | One page of a definition's views, in the port's order. | — |
ViewListing | interface | What a definition's list is right now: every view that could be read, and the reason the rest could not. | Engine and Resources |
ViewLocation | interface | Where the host's router is (host-integration.md 4.2): what the engine reads the open view (?view=), the open record (?id=) and what a page was handed (ViewRouteState, the history entry's state) from. | — |
ViewNavigation | type | Where a way off the board goes, for the host's route. | — |
ViewPermissions | interface | What the current user may do with one definition's views. | Persistence Port |
ViewPreferences | interface | One user's ordering and default view for one definition. | — |
ViewQueryState | interface | — | — |
ViewResource | interface | One thing a host registers (host-integration.md 4): a definition, and where its data comes from. | Engine and Resources |
ViewResult | interface | — | — |
ViewRoute | interface | A way off a board or a view, resolved through its definition's route: the host's path, and what the page there is handed. | — |
ViewRouteOf | type | Where a view or a board of a definition lives in the host's address.target is the way off it was asked for; it is absent where the engine asks for a link rather than a way off — a resource's or a system view's place in the host's navigation (useViewNavigation). | — |
ViewRouteState | interface | What the page a route opens is handed with it, as history state. | — |
ViewRouter | interface | The router port (host-integration.md 4.2): the host's router as the engine reads and moves it — the one bridge to it, whichever library it is. | Host Wiring |
ViewRuntime | interface | One open view. | — |
ViewRuntimeState | interface | — | — |
ViewScope | type | Who configured a view, who sees it and who may change it. | — |
ViewSource | interface | Where a definition's data comes from: the reads of one Wow query route, in wow-client's own shapes, so any QueryModelClient — a generated…SnapshotQueryClient, a dataset's DatasetClient.dataset(…) — is a source as it is, with no adapter (test/architecture.test.ts holds both to it). | Engine and Resources |
ViewStore | interface | The only port a backend must satisfy. | Persistence Port |
ViewStoreError | class | The single failure type of the persistence port. | Persistence Port |
ViewStoreErrorCode | type | — | Persistence Port |
ViewWriteError | class | How every write command rejects. | — |
VisibilitySource | interface | — | — |
WaterfallData | interface | — | — |
WaterfallSpec | interface | A waterfall: how a total is built up step by step. | — |
WaterfallStep | interface | One step of a waterfall: its group, its change, and where it floats. | — |
WindowFunctionName | type | A window function of Wow's derived expressions. | — |
WriteAction | type | — | — |
WriteHandle | interface | Addresses a write that no open runtime owns, such as renaming a view from the list. | — |
WriteOptions | interface | One logical write. | Persistence Port |
WritePayload | type | The body of a write, kept as it was sent. | — |
WriteState | type | An outcome that is not success. | — |
WriteTarget | type | What a write command is addressed to: an open view, or a handle. | — |
actions | function | A binding's actions, checked: every one has an id no other has, a label and a run. | Host Wiring |
builtinFieldKinds | const | Ready-to-use registry; extend it with withFieldKinds. | Definitions and Field Kinds |
compileAnalysis | function | Compilation is a mapping, not a translation: the configuration is isomorphic to the Wow aggregation protocol and differs only in storing enum values as literals and filters as trees. | — |
compileFilter | function | Compiles an admitted tree into a Wow filter expression. | — |
compileRecord | function | Compiles the applied config into the query its source understands. | — |
createFieldKindRegistry | function | — | Definitions and Field Kinds |
defaultAnalysisConfig | function | A complete starting config. | — |
defaultRecordConfig | function | A complete starting config, because create takes a config rather than inventing one: a definition that validateDefinition accepted always has a layout and a row key to build from. | — |
defaultRuntimeEnvironment | function | The default host: the ambient clock and timers, the ambient zone, and a page that is always visible. | — |
defineDataset | function | A dataset's definition, derived from its descriptor (host-integration.md 3.2): a dataset is published at run time, so its definition is not code. | — |
defineView | function | A data definition built from its source's descriptor (host-integration.md 3): the descriptor gives the facts — which paths there are, what each is, what it sorts and feeds — as an upper bound, and spec picks, names and narrows within it. | Definitions and Field Kinds |
emptyDashboardConfig | function | A complete starting config, the dashboard counterpart of the twodefault*Config functions. | — |
emptyPreferences | function | An empty preference record, which is what an untouched definition has. | — |
fitChartSlots | function | The chart, with the family its type asks for filled in from the groups and metrics the analysis actually has. | — |
hasAsked | function | Whether this view has put a question to its source: a result came back, one is on its way, or the last one failed. | — |
hasResult | function | Whether this view ever got a result, even one that is now out of date. | — |
inRows | function | Panels laid out row by row, so a board written in code says only how big each panel is: each row starts under the tallest panel of the row above, and its panels go left to right from the first column, each w wide. | — |
isAnalysisRuntime | function | Whether runtime is an analysis view, read off its kind: what narrows a runtime held as any data view (a board panel's, say) to one, whereisRecordRuntime narrows it to a record view. | — |
isDateTimeFilterValue | function | — | — |
isExportCancelledError | function | By name, as every guard of the engine's errors (isViewStoreError). | — |
isRecordRuntime | function | Whether a data view's runtime is a Record view's, with its rows' commands: a dashboard panel's runtime (DashboardPanelState.runtime) is either kind. | — |
isSystemInstanceId | function | True for any id in the namespace a ViewStore must not issue. | — |
isViewCommandError | function | By name, as every guard of the engine's errors (isViewStoreError). | — |
isViewStoreError | function | Structural, so an error raised by a second copy of this package, or by a store that builds the shape itself, is still recognised: an Error namedViewStoreError with one of the port's codes. | Persistence Port |
isViewWriteError | function | By name, as every guard of the engine's errors (isViewStoreError). | — |
issue | function | — | — |
localStorageSnapshot | function | A MemoryViewStore snapshot kept in localStorage under key: the whole store as one JSON document, { instances, preferences }. | Persistence Port |
projectAnalysis | function | Turns aggregation rows into table columns plus whatever the chart family needs. | — |
projectRecord | function | Turns a page of rows into what a table or a card list renders. | — |
resolveDateTimeRange | function | The range a value names: from on its start edge, to on its end edge, so a date-only to reaches the end of that day. | — |
serializeCsv | function | The rows as a CSV, RFC 4180 with a BOM in front. | — |
systemInstanceId | function | Instance id of a code-declared system view. | — |
text | function | The key key, to stand where a label goes. | Definitions and Field Kinds |
textKeyOf | function | The key a label stands for, or null for a label that is words already. | — |
validateAnalysis | function | Admits an analysis config against its definition. | — |
validateDashboard | function | Admits a dashboard config. | — |
validateDefinition | function | Admits a definition. | — |
validateFilter | function | Admits a tree that arrived from a store. | — |
validateRecord | function | Admits a record config against its definition. | — |
withFieldKinds | function | Adds or replaces kinds, so an application extends the built-in set without mutating it. | Definitions and Field Kinds |
withText | function | value with every key in it said by resolve, and the same object where it holds none. | — |