Types API Reference

API reference › Types and the glossary

All 26 pages Everything on one page → Developer guide →

Type reference

Generated from the type declarations, so it always matches the release. Each surface lists its properties, its methods and the events it raises as three tables; an option or value type lists its members once.

Glossary of value types

The value and result types the surfaces above hand back, alphabetical.

AcfResult

Autocorrelation (ACF) and partial autocorrelation (PACF) arrays.

AdfResult

The Augmented Dickey-Fuller stationarity test result.

AggregateProvenance

How one aggregate was routed, for `lastPlan()` provenance.

AggregateRequest

One aggregate the grid asks the source to compute over the matching set. `params` carries e.g. `{ share: 0.1 }` so an adapter emits the matching SQL; `weight` names the second column for a two-column stat like `correlation`.

AnnotationAddResult

The result of {@link AnnotationApi.add}: the new mark's id alongside the mark count `add()` returned before it had one. Coerces to `count` via `valueOf`, so code written against the old bare-number return (`if (annotate.add(m))`, `annotate.add(m) + 1`, `annotate.add(m) > 0`) keeps working unchanged. `===` and `assert.strictEqual` against a number do not coerce; compare `.count` instead.

AnomalyReason

AnomalyReport

AnomalyRow

ApproximateEntry

One entry of the approximate maintenance tier.

CapabilityInterval

An interval for a capability index, by Bissell's approximation.

CaptureOptions

Rendering the grid to a still image. `scale` multiplies the pixel dimensions : 2 for a retina still, 3 or 4 for a slide. `background` fills behind the grid so a PNG dropped into a deck does not show it through.

ChangeResult

ChartActiveRule

One entry of {@link Chart.responsive} and of the `responsive` event's `active` list.

ChartAnimationOptions

The object form of {@link ChartSpec.animation}: how a chart's entry and its updates play.

ChartAnimationProvenance

What the last draw did about animation: {@link ChartProvenance.animation}.

ChartAnnotateMeasure

Where a `measure-x` or `measure-xy` readout's volume figure comes from.

ChartAnnotateOptions

The drawing rail's settings, when `annotate` is an object rather than `true`.

ChartAnnotation

ChartAnnotationAnchor

One point of a drawn chart annotation, in the chart's own data coordinates.

ChartAnnotationEvent

What an `annotation:added`, `annotation:changed` or `annotation:removed` handler receives.

ChartAnnotationItem

A drawing a reader made on a chart, anchored in data rather than in pixels.

ChartAnnotationReadout

What a `measure-x`, `measure-y` or `measure-xy` item's readout carries. Every field is omitted, not `null`, when it does not apply to the kind or could not be computed - `measure-y` never carries `count`, and neither half is present before anything is bound.

ChartAxis

One axis's configuration. A bare string is the title.

ChartAxisZoomState

One axis's zoom, as it is stored and restored.

ChartBrushEvent

`brush`: a range was dragged out on an axis, **before** the chart zooms or filters on it. A handler that wants to take the brush over calls `preventDefault()` on the payload, which stops the chart zooming its own domain or filtering the grid for this drag; writing `defaultPrevented` directly still works, the same way.

ChartClickEvent

`click`: a mark was clicked, **before** the chart does anything about it. The one event most callers want: it is how a click on a mark becomes a filter on the grid. It fires whether or not the spec sets `filterOnClick`, and it fires before the filter, the drill or the selection the chart would otherwise apply - so a host that wants to do something else entirely (open a drawer, cross-filter a second grid) calls `preventDefault()` and takes the click over.

ChartCursorApi

The host's handle on a chart's crosshair.

ChartCursorLeaveEvent

What a `cursor:leave` handler receives.

ChartCursorMoveEvent

What a `cursor:move` handler receives.

ChartCursorOptions

The object form of {@link ChartSpec.cursor}: a crosshair that follows the pointer over a cartesian chart.

ChartCursorPosition

What {@link Chart.cursor.get} and `cursor:move` report about where the cursor is.

ChartDatumEvent

A mark, in the terms a host thinks in: `hover`'s payload, and the shape `click` adds its `preventDefault` to. One shape for every chart type, so a host need not know whether it attached to a pie, a bar chart, a treemap, a map, a matrix or a network to read what the pointer is on: a type with no third channel leaves the field null. There is no `point` wrapper - the fields are flat.

ChartDatumSeries

One series' reading under a mark, on a chart with several series. `value` is that series' own number at the mark, and `rows` how many source rows were aggregated into it - a count, not the rows themselves.

ChartDrawEvent

`draw`: the chart finished a draw, at its settled size. Raised once per `draw()`, after the second pass a legend or heading that changed the plot box forces - so a handler never sees the in-between, wrongly-sized pass. A draw that showed the empty state instead raises nothing.

ChartDrillEvent

`drill`: the chart descended into a hierarchy, or `ascend()` came back up. Raised after the new level is set and before it is drawn.

ChartEditEvent

What a chart's `edit` and `editRejected` handlers receive.

ChartEditable

How a chart's marks may be dragged to edit the grid; see {@link ChartSpec.editable}).

ChartEvent

What every chart event carries, whatever it is about. The three members the chart's own dispatcher adds to each payload before it reaches a handler, so one handler bound to several charts can tell which chart and which grid it is being told about.

ChartEventPayloads

What a handler receives, per chart event.

ChartFocusEvent

`focus`: the keyboard moved onto a mark, which has just been given the `aria-label` a screen reader announces.

ChartGradientFill

A linear or radial gradient fill, accepted anywhere a chart takes a colour for a filled mark - a bar, an area, a pie or donut slice, a treemap cell, a band, a map's land (`basemap.fill`). `stops` are `[offset, colour]` pairs, offset 0 to 1. A line or an outline is stroked in the gradient's first colour: a gradient across a hairline paints nothing.

ChartLabels

Data labels beside each mark.

ChartLegendEvent

`legend`: a legend entry was clicked and the hidden set already changed; the redraw follows.

ChartMarkerOptions

Pictures as markers on a line, scatter or bubble chart and on a `markermap`.

ChartMeasure

ChartMeasureOptions

The point-to-point measure tool's own settings; the spec's `measure` takes `true` for the defaults or this object.

ChartNode

One node of a `network` chart, as the host declares it. `x` and `y` are fractions of the plot, 0 to 1, measured from its top-left. A node giving both is **pinned** there and takes no part in the force simulation; the rest are laid out around it, deterministically. Giving only one of the two is not a position and the node is laid out.

ChartPatternFill

A repeating pattern fill: the colour-blind-safe way to tell series apart without relying on hue. `colour` is also the solid fallback an export that cannot carry definitions paints.

ChartPenOptions

The freehand `pen` tool's defaults; a stroke may carry its own `colour` and `width`.

ChartProvenance

What {@link Chart.provenance} reports (GEO-5).

ChartRampOptions

The object form of {@link ChartSpec.ramp}: the ramp's colours together with the scale a value is placed along it by. Read by every ramp-coloured type - `heatmap`, `geomap`, a `markermap` or `bubblemap` past its viewport cap (density cells), and the opt-in `calendar`, `hexbin`, `hexmap` and `choropleth`.

ChartResponsiveEvent

`responsive`: the set of matching rules changed, after the redraw it caused. Raised when a rule starts or stops matching, and once at the first draw when any rule matches.

ChartResponsiveOptions

One responsive rule: `set` is laid over the chart's options while the chart's own container satisfies every bound given. Bounds are inclusive pixel sizes of the container, not the viewport.

ChartState

What a chart's own view state holds: the drawings on it, and the zoom.

ChartTrend

One trend or forecast overlay.

ChartViewportFilterOptions

Narrows {@link ChartSpec.viewportFilter}, GEO-4,.

ChartViewportProvenance

What a map's {@link ChartProvenance.viewport} reports (GEO-6).

ChartVolumePaneOptions

A candlestick's volume pane.

ChartZoomApi

The host's handle on a chart's zoom.

ChartZoomEvent

What a `zoom` handler receives.

ChartZoomOptions

The zoom's settings, when `zoom` is an object rather than `true`.

ChartZoomState

A chart's zoom, per axis; an axis showing everything is absent.

ClipboardOptions

ColumnDifference

How one column differs between the filtered subset and its population.

ColumnDistribution

ColumnProfile

CommentDescriptor

Counts for one cell. Never bodies: this is consulted on every repaint.

ConfidenceInterval

An interval for an estimated figure, at a stated level.

CsvExportOptions

CurrencyConfig

DatasetColumnDifference

DatasetComparison

DetailForwardedEvent

The fields every `detail:` re-emission adds on top of the nested grid's own event payload (): which master row raised it, and where the change lands on that row's own record.

DiagnosticWarning

One thing the grid has flagged as probably a mistake.

DuckDbSpatialOptions

The `spatial` option of `duckdbAdapter` in its object form (GEO-2). `spatial: true` is the same with neither member set.

ErrorBound

How an approximate reduction's error bound holds, and what it measures.

ExcelBorderSpec

A cell border, per edge. `true` means a thin line; a string names the style.

ExcelCellStyle

A conditional-formatting rule's rendering, returned by `cellStyle`.

ExcelExportOptions

FacetState

A column's computed distribution.

FindCount

How many matches there are and which is current. `windowed` is the honest scope flag: over a paged pushdown source only the loaded rows are searched, so `total` counts matches in `loaded` rows out of the `rows` the source reports for the whole matching set.

FindMatch

One matching cell.

FindQuery

How `grid.find(text, opts)` matches. Defaults: case-insensitive, substring, every visible column, starting from the first row. Find matches the **formatted display text** - what the cell shows, a column `format` included - never a raw value; there is no regular-expression mode.

FindState

The current query and whether the bar is showing.

ForecastPoint

One forecast step: the point estimate and, where a band applies, its interval.

ForecastResult

A forecast: the chosen model, its parameters, and the projected points.

GeoJsonGeometry

A geometry as a `geometry` column stores it: a GeoJSON geometry object with two-ordinate positions, longitude first. Z and M are dropped on ingest.

GeoPack

An optional geometry pack for a geomap, as one of the `modules/geo-*` packages exports. Generated at build time from a named public source; `source`, `licence` and `attribution` record where the geometry came from and what its licence requires. A single-layer pack carries `topology` directly; a multi-layer pack (the UK) carries `layers` instead, keyed by layer name, each with its own `topology`.

GridModule

GroupComparison

GroupDifferenceInterval

A confidence interval on the difference a two-sample test measured.

GroupEffectSize

The effect size paired with a two-sample test - the "how big" half.

HeadlessGridConfig

The configuration {@link createHeadlessGrid} accepts (,. Every {@link GridConfig} key remains meaningful off the DOM - sources, columns, sort, grouping and the rest all still drive the same pipeline - so this is the same shape, not a smaller one; it exists so `icons` has its own doc anchor for the headless case, which touches no `document` at all.

Heteroscedasticity

The Breusch-Pagan heteroscedasticity test result.

HistogramBin

HistoryEntry

IconGlyph

One sprite: its view box, its path data, and how it is painted.

ImportColumn

One source column as understood by the importer, after type inference ().

ImportPreview

What a preview carries - everything a confirm dialog needs ().

ImportXlsxPreview

What an `.xlsx` preview carries - an {@link ImportPreview} plus the sheet read ().

ImportXlsxSheet

One worksheet of an `.xlsx` workbook, as {@link ImportApi#xlsxSheets} lists it (,.

LicenceInfo

ListCount

The operand of `listCount`: how the number of items compares to `value`.

MaintenanceTier

The maintenance label for one kernel across both tiers.

ModuleContext

Money

A stored currency value: an amount in a named currency. `{amount:10,code:'USD'}` is a different value from `{amount:10,code:'EUR'}` - currency is a real type, not a display format, so the code rides on every cell.

MutateCapability

MutationOp

MutationResult

The result of a mutation () - the reconcile payload. A cell-update commit flows this back through `PendingWrites`: `ok: false` reverts and surfaces `reason`; `rows` (`returning: 'row'`) reconciles server truth before confirm; `conflict` surfaces a last-write-wins divergence via `cell:conflict`.

OpenRowOp

A structural op (append or delete) still awaiting an outcome ().

OpenWrite

ProcessCapability

ProportionInterval

A Wilson score interval for a rate. Stays inside 0 to 1 at the extremes.

PushdownAdapter

An engine the grid can query, and what it is able to answer.

PushdownAggregatesConfig

Design-time aggregate-pushdown policy for a pushdown source Part B). The developer chooses, at grid setup before render, whether each statistic is computed by the engine (fast, over the matching set) or client-side (the grid's exact definition, needs a full-dataset pull). It is fixed for the life of the grid, never a runtime toggle, and never surfaced to an end user. Absent, every aggregate is computed client-side - today's behaviour, so no existing caller regresses. `engine-if-identical` is the recommended setting for a windowed DuckDB source: it pushes only the statistics whose engine result is verified identical to the grid kernel, keeping the documented MAY-DIFFER stats (e.g. `mode`) client-side. The engine is used only when the filter is fully pushed; a residual filter forces every aggregate client-side, so an engine figure and a client figure never mix in one result set.

PushdownCapabilities

What a pushdown adapter can answer. Everything is off unless declared.

PushdownFullDatasetConfig

Opt-in, sticky full-dataset pull for a pushdown/remote source. Off by default. When enabled, the source materialises the entire matching set client-side once per query signature and serves every window, total and statistic from it, so those figures are computed over the whole set rather than the loaded window. A set past either limit is refused with a visible `source:error` - never silently truncated.

PushdownPlan

How one request was divided between the engine and the grid.

PushdownSourceConfig

Registry

RegressionBand

A pointwise confidence band for the mean response of a single-predictor fit.

RegressionFit

RejectedRow

A row a change could not apply, and why. Reported, never thrown.

RowChange

RowOrderResult

What `rowOrder.enter`, `set` and `exit` report.

RowRegroupChange

One grouping value a row moved into another group was given.

SavedView

SelectionStatistics

The shape {@link SelectionApi.statistics} returns: what `summary()` reports, plus the range's own size and shape. `distinct` counts every non-blank value, numeric or not, so a numeric-looking selection that is really a set of codes shows up as a low distinct count against a high `count`. The five fields after `distinct` are present only when at least one selected value parsed as a number - `statistics()` never invents a quartile or a deviation over an empty numeric set.

SeriesStats

Source

SpatialBucket

A spatial grouping key for `source.aggregate()` (GEO-2): a geometry column's centroid binned into square cells `size` degrees on a side. Pushed by an adapter that declares `buckets: ['grid']` (`duckdbAdapter({ spatial })` with the extension loaded) as `floor(ST_X(ST_Centroid(geom)) / size)` and the same for `ST_Y`; each group's key comes back as `[x, y]`, the cell covering longitudes `[x·size, (x+1)·size)` and latitudes `[y·size, (y+1)·size)`, or `null` on a rolled-up row.

SpatialDistance

A circle on the Earth's surface: the operand of `withinDistance`.

Stat

The handle `createStat` returns.

StatCoverage

How much of the data a computed figure actually covers. `covered < total`, or `total === null`, means the figure is approximate.

SubsetComparison

The subset-vs-population ranking.

TopValue

One row of a categorical column's top-values table.

TwoSampleSpec

How {@link StatisticsApi.compareGroups} splits the rows and picks a test.

UnitConfig

UnitDescriptor

One unit descriptor: a symbol and how many base quantities it is worth.

ValidationError

One recorded validation error.

ViewChange

ViewImportReport

What {@link ViewsApi.import} reports.

ViewPayload

What {@link ViewsApi.export} produces and {@link ViewsApi.import} accepts.

ViewStorage

WhereOptions

How a `where` predicate is re-evaluated, whether `filters.clear()` may remove it, and what the source may be told about it.

WindowSpec

The window a windowed aggregate was computed over.

WindowedResult

One windowed figure and the window it covers.

Types

Every type alias the declarations export, with its definition. A type named anywhere in the tables above links to its entry here.

AggregateMode

How one requested aggregate should be computed.

type AggregateMode = 'engine' | 'client' | 'engine-if-identical'

AIAsk

The provider-agnostic model callback the host supplies. The module never imports a provider SDK, reads a key, or makes a network call - it builds this payload and awaits the host's reply. A host may wrap a chat provider (`{ text }`), a completion (a bare string), a tool-calling turn (`{ toolCalls }`), or a structured provider (`{ structured }`).

type AIAsk = (payload: { system: string; message: string; prompt: string; messages: Array<{ role: string; content: string; [k: string]: unknown }>; tools?: object[]; schema?: unknown; signal?: AbortSignal; }) => Promise< | string | { text?: string; content?: string; toolCalls?: object[]; structured?: unknown } >

Declared in lattice-grid/modules/ai.

AIBriefKind

What an AI narrative targets.

type AIBriefKind = 'view' | 'column' | 'forecast' | 'kpi' | 'chart' | 'risk'

Declared in lattice-grid/modules/ai.

AIEventName

The events an AI controller raises. The controller's own, not the grid's: `grid.on` takes {@link EventName} and knows nothing about these. `on()` warns once on any other name, because a binding to an event that can never fire is a silent no-op. Each event also has a config callback (`onNarrative`, `onQuery`, `onProposal`, `onError`); both routes fire. None of them is cancellable: each reports a run that has already finished, and the one point where the AI changes anything - applying a proposal - goes through the grid's own `beforeEdit` gate (or the board's `beforeMove`), which is where a host vetoes an AI write.

type AIEventName = 'narrative' | 'query' | 'proposal' | 'error'

Declared in lattice-grid/modules/ai.

AINarrativeMode

Which path an AI narrative ran through: tool calls, or an upfront facts packet.

type AINarrativeMode = 'tools' | 'packet'

Declared in lattice-grid/modules/ai.

AIProposalScope

An AI proposal's row scope: the filtered view, or an opted-in widen to all rows.

type AIProposalScope = 'view' | 'all'

Declared in lattice-grid/modules/ai.

AIReconcileMode

What to do with an ungrounded figure in an AI narrative: drop it, or flag it in place.

type AIReconcileMode = 'strip' | 'flag'

Declared in lattice-grid/modules/ai.

AlarmLevel

An alarm's level. The KPI panel's own vocabulary, deliberately - `good | warn | critical` - rather than a fifth spelling of red/amber/green beside the four that already exist. Only `warn` and `critical` ARE alarms: `good` is the healthy level and clears whatever was raised.

type AlarmLevel = KpiStatus

Declared in lattice-grid/modules/alarms.

AlarmsEventName

The events an alarm set emits.

type AlarmsEventName = 'alarm:raised' | 'alarm:cleared'

Declared in lattice-grid/modules/alarms.

AlarmSource

Which of the three kinds of source an alarm came from.

type AlarmSource = 'kpi' | 'grid' | 'router'

Declared in lattice-grid/modules/alarms.

Align

Cell and header alignment. `left` and `right` are accepted and normalised to `start` and `end`. `start`/`end` follow the writing direction, so they mirror in a right-to-left grid while `left`/`right` stay physical. `centre` is accepted alongside `center`.

type Align = 'start' | 'center' | 'end' | 'left' | 'right' | 'centre'

AnnotationKind

What an annotation mark is: a freehand trail, an arrow, a rectangle, a highlight, or text.

type AnnotationKind = 'freehand' | 'arrow' | 'rect' | 'highlight' | 'text'

AnnotationRegion

Which columns an annotation mark belongs to: the pinned start, the centre, or the pinned end.

type AnnotationRegion = 'start' | 'centre' | 'end'

AnnotationTool

The annotation drawing tool: a pen, an arrow, a rectangle, a highlighter, or the eraser.

type AnnotationTool = 'pen' | 'arrow' | 'rect' | 'highlight' | 'erase'

BadgeTone

A tab's count-badge tone, declared by the host rather than derived from a threshold.

type BadgeTone = 'good' | 'warn' | 'bad' | 'unknown'

Declared in lattice-grid/modules/tabs.

BooleanDisplay

How a boolean format renders its two states: as text, a glyph pair, or an icon pair.

type BooleanDisplay = 'checkbox' | 'switch' | 'text' | 'icon'

CalendarEventName

The events a calendar emits.

type CalendarEventName = 'card:click' | 'card:dblclick' | 'card:contextmenu' | 'card:mount' | 'range:change' | 'beforeMove' | 'card:move'

Declared in lattice-grid/modules/calendar.

CalendarFieldMap

A card field mapping: a property path, or a function reading the row.

type CalendarFieldMap = string | ((row: CalendarRow) => unknown)

Declared in lattice-grid/modules/calendar.

CalendarReadonly

Granular readonly: the whole calendar, or selectively by day key and card key.

type CalendarReadonly = boolean | { board?: boolean; days?: Record<string, boolean>; cards?: Record<string | number, boolean>; }

Declared in lattice-grid/modules/calendar.

CalendarRow

A row backing a calendar card: any object. Its date comes from `startProperty` and its identity from `rowKey`.

type CalendarRow = Record<string, unknown>

Declared in lattice-grid/modules/calendar.

CalendarView

A calendar view name: a week day-grid, a month grid, a week time-grid, or a single-day time-grid.

type CalendarView = 'week' | 'month' | 'week-time' | 'day'

Declared in lattice-grid/modules/calendar.

CamelJoin

An event name as the callback prop a Svelte 5 component takes: `'cell:changed'` becomes `'CellChanged'`, so the prop is `onCellChanged`. Svelte 5 removed component events - `createEventDispatcher` is deprecated and `on:` no longer applies to a component - so an instance event reaches a host as a callback prop. The all-lowercase spelling (`oncellchanged`) is accepted at runtime too, for hosts that prefer Svelte's DOM attribute style; only the canonical one is typed, because a union of both would make every misspelling type-check.

type CamelJoin<E extends string> = E extends `${infer Head}:${infer Tail}` ? `${Capitalize<Head>}${CamelJoin<Tail>}` : Capitalize<E>

Declared in lattice-grid/modules/svelte.

ChartAnnotateRail

Where a chart's drawing rail sits, or `none` for the tools without the strip.

type ChartAnnotateRail = 'left' | 'top' | 'none'

ChartAnnotationCompute

A named reduction a chart annotation's `compute` derives its position from.

type ChartAnnotationCompute = 'mean' | 'avg' | 'median' | 'min' | 'max'

ChartAnnotationItemKind

What a drawn chart annotation is; the drawing tools, less `select` and `delete`.

type ChartAnnotationItemKind = 'trendLine' | 'horizontalLine' | 'verticalLine' | 'channel' | 'fibonacci' | 'arrow' | 'pen' | 'measure-x' | 'measure-y' | 'measure-xy' | 'measure' | 'text' | 'callout' | 'note'

ChartAnnotationKind

What kind of chart annotation this is.

type ChartAnnotationKind = 'line' | 'target' | 'band' | 'callout' | 'event'

ChartAnnotationOrient

Whether a chart annotation is forced horizontal or vertical.

type ChartAnnotationOrient = 'horizontal' | 'vertical'

ChartAnnotationToolName

A tool on a chart's drawing rail.

type ChartAnnotationToolName = 'select' | 'trendLine' | 'horizontalLine' | 'verticalLine' | 'channel' | 'fibonacci' | 'arrow' | 'pen' | 'measure' | 'text' | 'callout' | 'note' | 'delete' | 'measure-x' | 'measure-y' | 'measure-xy'

ChartAxisSide

Which measure axis a chart annotation reads: left, right, or the secondary y2.

type ChartAxisSide = 'left' | 'right' | 'y2'

ChartCurve

How a line or area series connects its readings. `'linear'` (the default) draws straight segments, `'monotone'` a cubic that never overshoots the data, `'catmullRom'` a spline with a `tension`, and `'step'` a level that holds a value until the next reading.

type ChartCurve = 'linear' | 'monotone' | 'catmullRom' | 'step'

ChartCurveOptions

The object form of {@link ChartSpec.curve}: a curve with its own settings. `tension` (0..1, default 1) is the Catmull-Rom spline's pull toward its points; `mode` (`'after'`, the default; `'before'` or `'middle'`) is where a step changes level between two readings.

type ChartCurveOptions = { type: ChartCurve; tension?: number; mode?: 'before' | 'after' | 'middle'; }

ChartDirectedOptions

The object form of {@link ChartSpec.directed}: how a directed chord draws its flows. `style` is how a ribbon ends at its target - `'taper'` (the default: it narrows to 40% of the width it left with) or `'arrow'` (it closes into an arrow head whose tip sits on the ring). `arc` is what a node's arc length measures - `'out'` (the default: what the node sends; a node that only receives keeps a small floor so it stays on the ring) or `'inout'` (what it sends plus what it receives).

type ChartDirectedOptions = { style?: 'taper' | 'arrow'; arc?: 'out' | 'inout'; }

ChartEventName

The events a chart raises. A chart's own, not the grid's: `grid.on` takes {@link EventName} and knows nothing about these. There is no `point:click`, `point:hover` or `series:toggle`; the events are the flat names below, and `click` is the one most callers want - it is how a click on a mark becomes a filter on the grid. Every payload carries `type`, `chart` and `grid` ({@link ChartEvent}); what else arrives is {@link ChartEventPayloads}. A handler that throws is reported to the console and the rest still run. Each event also fires the matching `on<Event>` in the spec (`onClick`, `onDraw`, …) before the subscribers. `click` and `brush` are the two events the chart acts on, and both carry a `preventDefault` a handler can call to take the action over; the rest are notifications.

type ChartEventName = 'click' | 'hover' | 'leave' | 'focus' | 'draw' | 'drill' | 'brush' | 'legend' | 'annotation:added' | 'annotation:changed' | 'annotation:removed' | 'zoom' | 'cursor:move' | 'cursor:leave' | 'edit' | 'editRejected' | 'responsive'

ChartExtensionType

Every chart type an opt-in `lattice-grid/modules/chart-*` module registers, aliases included. Importing the module is what makes the type draw; naming it here is what lets a strict TypeScript host write `createChart({ type: 'waffle' })` without a compile error. A gate check derives the registered names from the modules themselves and fails when one is missing from this union, so it cannot drift.

type ChartExtensionType = 'alluvial' | 'arc' | 'barRace' | 'bubblemap' | 'bump' | 'calendar' | 'choropleth' | 'decomposition' | 'diverging' | 'dumbbell' | 'fan' | 'forceTree' | 'hexbin' | 'hexmap' | 'icicle' | 'markermap' | 'motion' | 'nightingale' | 'pack' | 'parallel' | 'pictorial' | 'polarArea' | 'polarScatter' | 'pyramid' | 'radialBar' | 'ridgeline' | 'roc' | 'rose' | 'serpentine' | 'slope' | 'spiral' | 'splom' | 'scatter3d' | 'tree' | 'venn' | 'voronoiTreemap' | 'waffle' | 'wordCloud'

ChartFill

A gradient or pattern fill for a chart mark.

type ChartFill = ChartGradientFill | ChartPatternFill

ChartLabelPosition

Where a chart data label sits relative to its mark.

type ChartLabelPosition = 'outside' | 'inside' | 'auto'

ChartMeasureType

The mark a combo chart's measure draws with.

type ChartMeasureType = 'bar' | 'line' | 'area'

ChartPictorialOptions

The options of a `pictorial` chart. `mode` is `'fill'` (the default: one silhouette cut into horizontal bands sized by each stage's value) or `'repeat'` (an isotype row of icons per category). `shape` is an icon name from the grid's icon registry or an SVG path string (path data only; anything else is refused and the built-in figure is drawn). `unit` is what one icon stands for in `'repeat'` mode; unset, a round number that fits the widest row on one line.

type ChartPictorialOptions = { mode?: 'fill' | 'repeat'; shape?: string; unit?: number; }

ChartPolarOptions

Options for the polar chart types, set as `ChartSpec.polar`, 0001650, 0001651). `polarArea` gives every category an equal angle and draws its wedge's radius from the measure; `radialBar` draws one ring per category, swept in proportion to its value; `polarScatter` places each row by an angle and a radius. `startAngle` and `endAngle` (on the spec, in degrees clockwise from twelve o'clock) set where the angular range begins and ends; `max` fixes the outer ring or a full track.

type ChartPolarOptions = { scale?: 'sqrt' | 'linear'; sort?: 'asc' | 'desc'; multi?: 'rings' | 'stacked'; track?: boolean; angle?: 'degrees' | 'category' | 'hourOfDay' | 'dayOfWeek' | 'month'; colour?: string; }

ChartRadiusOptions

The object form of {@link ChartSpec.radius}: a pie or donut whose slice radii come from a second measure. `fn` maps that measure to a radius - `'sqrt'` (the default, area-true: area grows as the measure) or `'linear'` - and `min` is the smallest share of the full radius a slice may shrink to, from 0 to 1.

type ChartRadiusOptions = { col: string; fn?: 'sqrt' | 'linear'; min?: number; }

ChartScale

How a chart axis's scale is chosen, rather than taken from the column's type.

type ChartScale = 'auto' | 'linear' | 'time' | 'band' | 'category'

ChartSchemeName

A built-in colour scheme's name, as `scheme: '…'` or `registerScheme`'s first argument names one of `SCHEMES` - `'default'` (Okabe-Ito, checked against the common colour-vision deficiencies), `'bright'`, `'earth'` and `'mono'` (checked to survive a greyscale print). A host's own `registerScheme` name is a plain `string` alongside these, so `scheme` also accepts one it is not enumerable here.

type ChartSchemeName = 'default' | 'bright' | 'earth' | 'mono' | 'patterns'

ChartSerpentineOptions

The options of a `serpentine` timeline. `rows` is the number of rows the time axis is folded into; unset it follows the plot's size. `ticks: false` removes the calendar ticks along the path.

type ChartSerpentineOptions = { rows?: number; ticks?: boolean; }

ChartSpiralOptions

The options of a `spiral` timeline. `period` is one turn: `'day'`, `'week'` (from Monday) or `'year'` - calendar periods, UTC - or a duration (`'28d'`, `'12h'`, `'90m'`, `'45s'`, `'2w'`) or a number of milliseconds, counted from the epoch; default `'week'`. `mode` is `'points'` (the default), `'bars'` or `'spans'`; `barBy` says whether a bar's value is its `'length'` (the default) or its `'thickness'`.

type ChartSpiralOptions = { period?: 'day' | 'week' | 'year' | string | number; mode?: 'points' | 'bars' | 'spans'; barBy?: 'length' | 'thickness'; }

ChartStagesOptions

The options of a `pyramid` chart. `inverted` points the apex down. `area` makes each slice's *area* proportional to its value instead of its height. `gap` is the space between slices in pixels (default 2; area is exact with `gap: 0`). `labels` is where each slice's stage, value and share are written: `'auto'` (the default: inside where the text fits, beside it with a leader where it does not), `'inside'`, `'beside'`, or `false` for none (the legend then names the stages).

type ChartStagesOptions = { inverted?: boolean; area?: boolean; gap?: number; labels?: 'auto' | 'inside' | 'beside' | false; }

ChartTrendMethod

A trend or forecast overlay method. Each name has aliases: `linear` (also `lr`, `ols`, `regression`); `movingAverage` (also `ma`, `sma`, `rolling`); `exponential` (also `ewma`, `ses`, `holt`, `smoothing`).

type ChartTrendMethod = 'linear' | 'movingAverage' | 'exponential' | 'lr' | 'ols' | 'regression' | 'ma' | 'sma' | 'rolling' | 'ewma' | 'ses' | 'holt' | 'smoothing'

ChartType

One of the thirty chart types `createChart` accepts.

type ChartType = 'line' | 'step' | 'area' | 'rangeArea' | 'bar' | 'horizontalBar' | 'waterfall' | 'floatingBar' | 'horizontalFloatingBar' | 'populationPyramid' | 'bullet' | 'scatter' | 'bubble' | 'forest' | 'combo' | 'pareto' | 'histogram' | 'boxplot' | 'heatmap' | 'qq' | 'ecdf' | 'lorenz' | 'correlogram' | 'control' | 'capability' | 'movingRange' | 'pie' | 'donut' | 'sunburst' | 'treemap' | 'radar' | 'gauge' | 'funnel' | 'candlestick' | 'ohlc' | 'geomap' | 'sankey' | 'chord' | 'network' | 'stream' | 'marimekko' | 'violin' | 'gantt'

ChartYMeasure

The object form of {@link ChartSpec.y}: a single measure column with its own reduction and whether it runs as a running total - the single-measure equivalent of {@link ChartMeasure.cumulative}.

type ChartYMeasure = { col: string; fn?: TotalName; cumulative?: boolean; }

ChartZoomAxes

Which axes a zoom acts on; the default is the x axis alone.

type ChartZoomAxes = 'x' | 'y' | 'xy'

ChartZoomButtons

When the zoom toolbar is shown: on hover and keyboard focus, always, or never.

type ChartZoomButtons = 'hover' | 'always' | 'none'

ChartZoomRange

A visible range, as two ends in the axis's own units: two categories on a band axis, two readings on a continuous one, and epoch milliseconds on a time axis - which is what survives `JSON.stringify` and comes back the same.

type ChartZoomRange = [string | number, string | number]

ChartZoomReason

What moved a zoom, as reported by the `zoom` event. `pinch` is a two-finger pinch on a touch screen; `filter` is the grid's filter moving the view of a chart whose grid follows it ({@link ChartSpec.viewportFilter}): the chart's condition cleared in the grid (the zoom resets), or put back by an undo or a redo (the view returns to it).

type ChartZoomReason = 'button' | 'wheel' | 'key' | 'pan' | 'pinch' | 'reset' | 'api' | 'group' | 'filter'

ColumnExportLookup

How a lookup column leaves in an export: its label, its stored value, or both.

type ColumnExportLookup = 'label' | 'value' | 'columns'

ColumnGroupAction

What happened to a banded header group.

type ColumnGroupAction = 'formed' | 'removed' | 'renamed' | 'dissolved' | 'moved' | 'applied'

ColumnGroupGranularity

The calendar unit a column's row-grouping buckets a timestamp by.

type ColumnGroupGranularity = 'day' | 'week' | 'month' | 'instant'

ColumnRef

A column, named by its `id`: what every API that asks "which column" takes.

type ColumnRef = string

ComboLoadResult

A combo `load` result: a page, or a bare array (a single non-paging page).

type ComboLoadResult = { items: ComboOption[]; total?: number; hasMore?: boolean } | ComboOption[]

Declared in lattice-grid/modules/form.

ComboOption

A combo option: a bare value, or the object form.

type ComboOption = string | number | ComboOptionObject

Declared in lattice-grid/modules/form.

CommentDisplayMode

Whether a comment thread floats beside its cell or opens in a side panel.

type CommentDisplayMode = 'anchored' | 'docked'

CommentOperation

Which comment-provider call failed.

type CommentOperation = 'loadIndex' | 'loadThread' | 'addComment' | 'editComment' | 'deleteComment' | 'resolveThread' | 'unresolveThread'

CompactDisplay

Which compact form `notation: 'compact'` renders, short (`1.2M`) or long (`1.2 million`).

type CompactDisplay = 'short' | 'long'

Comparator

Your own sort order for a column, in place of the built-in one for its type. Return a negative number when `a` sorts first, a positive number when `b` does, and zero when they tie. The two rows are passed as well, so an order can depend on a second field, and `descending` says which way the grid is about to apply the result - which is how blanks are kept last either way.

type Comparator = ( a: unknown, b: unknown, rowA?: Row, rowB?: Row, descending?: boolean, ) => number

ControlChartRuleSet

Which control-chart rule family flags an out-of-control point.

type ControlChartRuleSet = 'westernElectric' | 'nelson'

CorrelationMethod

Which correlation a correlogram computes.

type CorrelationMethod = 'pearson' | 'spearman' | 'kendall'

CorrelationOrient

Whether a pairwise correlation is shaped as one row per pair, or the square matrix.

type CorrelationOrient = 'pairs' | 'matrix'

CurrencyDisplay

How a currency figure names its unit, mirroring `Intl.NumberFormatOptions.currencyDisplay`.

type CurrencyDisplay = 'symbol' | 'code' | 'name' | 'narrowSymbol'

DashboardPanelKind

What a panel shows.

type DashboardPanelKind = 'grid' | 'chart' | 'kpi' | 'calendar' | 'board' | 'gantt' | 'map' | 'html'

Declared in lattice-grid/modules/dashboard.

DashboardSource

A named source.

type DashboardSource = DashboardRowsSource | DashboardPushdownSource | DashboardRouterSource | DashboardGridSource

Declared in lattice-grid/modules/dashboard.

DashJoin

The event name a Vue template binds, as a type: `'cell:changed'` becomes `'cell-changed'`. Recursive over the `:` segments, so a three-part name like `'cell:edit:start'` becomes `'cell-edit-start'` - the same rule `dashedName` applies at runtime, stated once so the props type and the implementation cannot disagree. A colon cannot appear in a Vue binding, which is why the adapter renames at all.

type DashJoin<E extends string> = E extends `${infer Head}:${infer Tail}` ? `${Head}-${DashJoin<Tail>}` : E

Declared in lattice-grid/modules/vue.

DataTypeBase

The storage family a data type belongs to.

type DataTypeBase = 'text' | 'number' | 'boolean' | 'date' | 'dateString' | 'object'

DataTypeStorage

How the column store holds a type's values in bulk.

type DataTypeStorage = 'float64' | 'int32' | 'bitset' | 'dictionary' | 'object'

DateStyle

A locale-chosen date form, mirroring `Intl.DateTimeFormatOptions.dateStyle`.

type DateStyle = 'short' | 'medium' | 'long' | 'full'

DecorationName

How a cell is drawn around its value: plain text, a filled background, a rounded pill, a coloured dot, an inline bar, a heat shade, or an icon. The shape only - which colour it takes is the variant's job.

type DecorationName = 'plain' | 'fill' | 'pill' | 'dot' | 'bar' | 'heat' | 'icon'

DecorationShape

A decoration's container outline shape.

type DecorationShape = 'pill' | 'rounded' | 'square'

DecorationSize

A decoration's size token, following the grid's density unless set.

type DecorationSize = 'sm' | 'md' | 'lg'

DeltaMode

What a movement line prints: the difference alone, the percentage alone, or both.

type DeltaMode = 'absolute' | 'relative' | 'both'

Declared in lattice-grid/modules/kpi.

Density

A named preset, or a raw scale where 1 is `standard`. Row heights are 23.8 / 28 / 42 / 56px for the four presets; a number scales 28px.

type Density = 'compact' | 'standard' | 'comfortable' | 'spacious' | number

DepValues

The values a computed column's dependencies hold for the row being computed, keyed by column id, so a formula reads what it declared it needs rather than reaching into the raw row.

type DepValues = Record<string, unknown>

DerivedFollow

Which of a derived source's rows to read.

type DerivedFollow = 'filtered' | 'all' | 'selected' | 'grouped'

DerivedOrient

With `profile`, whether a derived source emits one row per column or one per statistic.

type DerivedOrient = 'columns' | 'metrics'

DerivedRefresh

When a derived source re-derives: on every change, coalesced to a frame, or only on demand.

type DerivedRefresh = 'live' | 'idle' | 'manual'

DerivedStatistics

Which relational statistic a derived source projects into rows, and how. See `DerivedSourceConfig.statistics`. A discriminated union on `fn`, so the relational statistics still deferred - `regression`, `regressionModel`, `forecast`, `anomalies`, `adf`, `acf`, `spearman`, `kendall`, `covariance`, `subsetVsPopulation`, `compareGroups`, `capability`, `interval`, `windowed`, `weightedQuantile`, `weightedAverage` - arrive as further arms of this one key rather than as a second mechanism.

type DerivedStatistics = DerivedCorrelation | DerivedSeries | DerivedDatasetComparison

DesignerDerivedStep

One step of a derived grid's ordered step list.

type DesignerDerivedStep = DesignerDerivedFilterStep | DesignerDerivedGroupStep | DesignerDerivedPivotStep | DesignerDerivedJoinStep | DesignerDerivedSortStep | DesignerDerivedTopNStep

Declared in lattice-grid/modules/designer.

DesignerEventName

Every event the designer emits, in the order its `on()` declares them.

type DesignerEventName = 'state' | 'mode' | 'select' | 'page'

Declared in lattice-grid/modules/designer.

DesignerFieldType

A field's data type, shown with its own icon and grouped in the data panel.

type DesignerFieldType = 'number' | 'currency' | 'percent' | 'date' | 'datetime' | 'boolean' | 'text' | 'list' | 'geometry'

Declared in lattice-grid/modules/designer.

DesignerLlm

The host's model callback for the AI assistant. A function is `ask` itself; an object wraps `ask` and may opt into sending a bounded sample of the chosen source's rows with `sendSampleRows`.

type DesignerLlm = ((request: DesignerProposalRequest) => Promise<unknown> | unknown) | { ask: (request: DesignerProposalRequest) => Promise<unknown> | unknown; sendSampleRows?: number; }

Declared in lattice-grid/modules/designer.

DesignerMode

`'edit'` builds the canvas interactive; `'view'` is `createDashboard` and nothing else.

type DesignerMode = 'edit' | 'view'

Declared in lattice-grid/modules/designer.

DiagnosticSource

Where a diagnostic warning came from: a scheduled check, or a `warnOnce` report.

type DiagnosticSource = 'check' | 'reported' | 'info'

DiffAddedColumns

In diff/audit mode, whether a column absent from the snapshot counts as changed or is left alone.

type DiffAddedColumns = 'unchanged' | 'changed'

Direction

Writing direction. See {@link GridConfig.direction}.

type Direction = 'ltr' | 'rtl' | 'auto'

DistributionOp

Operators that resolve against the column's own distribution (spec 8.12).

type DistributionOp = 'topPercent' | 'bottomPercent' | 'topN' | 'bottomN' | 'aboveMean' | 'belowMean' | 'aboveMedian' | 'belowMedian' | 'zAbove' | 'zBelow' | 'outlier'

DriftMeasure

Every effect-size measure the difference surface reports, widest set: the two families' numeric measures (subset-vs-population, and dataset-vs-dataset) plus the categorical one both share. A single comparison site reports only the member(s) its own family can produce, via `Extract<DriftMeasure, …>`.

type DriftMeasure = 'standardizedMeanDifference' | 'pooledStandardMeanDifference' | 'categoricalTotalVariation'

Edge

The leading or trailing side of a value, layout or column pin.

type Edge = 'start' | 'end'

EditConfirmMode

How an optimistic write settles: on what `commit` returns, or only when you call `edit.settle` yourself.

type EditConfirmMode = 'auto' | 'manual'

EditMode

How an edit session is scoped: one cell committing on move-away, or one row held open until the whole row commits as a step.

type EditMode = 'cell' | 'row'

EditorCtor

An editor class. The grid instantiates one when an edit session opens on a cell and destroys it when the session ends, however it ended.

type EditorCtor = new () => Editor

EditorName

The built-in cell editors, addressable by name through `cell.edit`. Anything registered through `components` is also valid here.

type EditorName = 'checkbox' | 'code' | 'colour' | 'currency' | 'date' | 'datetime' | 'duration' | 'iconPicker' | 'ipaddress' | 'multiSelect' | 'number' | 'objectPicker' | 'password' | 'radix' | 'rating' | 'richtext' | 'segmented' | 'select' | 'slider' | 'temperature' | 'text' | 'textarea' | 'time' | 'treeSelect' | 'unit' | (string & {})

EditStartGesture

Which gesture opens a cell editor.

type EditStartGesture = 'single' | 'double' | 'key'

EmptyMessage

The empty-state message: a fixed string, or a function that returns one - or a DOM node - from the reason the grid is empty.

type EmptyMessage = string | ((ctx: EmptyMessageContext) => string | Node)

EmptyMessageReason

Why a grid is empty when it shows its `emptyMessage`. `'noData'` is an empty dataset; `'filtered'` is a non-empty dataset whose rows are all hidden by the current filters; `'loading'` is a count that has not arrived yet, and is never delivered to the message - the grid waits for one of the other two rather than guessing.

type EmptyMessageReason = 'noData' | 'filtered' | 'loading'

ErrorBoundKind

How an approximate reduction's error bound holds: every run, in expectation, or to rounding.

type ErrorBoundKind = 'deterministic' | 'probabilistic' | 'exact'

ErrorBoundMetric

What an error bound's value measures.

type ErrorBoundMetric = 'absolute' | 'relative' | 'rank' | 'none'

EventHandler

A function subscribed to a grid event, handed the event that fired.

type EventHandler = (e: GridEvent) => void

EventName

Every event the grid emits. Complete, and checked against the runtime by `tools/check.js`, an `emit()` call with no entry here fails the build. It was not complete before: fifty-one events were emitted and undeclared, so subscribing to any of them from TypeScript was a compile error on an event the grid genuinely raises. Grouped by the subsystem that raises them, which is also how the reference lists them.

type EventName = 'ready' | 'destroy' | 'render:first' | 'render:done' | 'config:changed' | 'licence:changed' | 'model:changed' | 'rows:changed' | 'rows:queued' | 'rows:deferred' | 'rows:paused' | 'rows:resumed' | 'row:received' | 'row:sent' | 'row:copied' | 'row:moved' | 'source:error' | 'source:total' | 'stream:chunk' | 'stream:end' | 'stream:evicted' | 'rowDrag:started' | 'rowDrag:moved' | 'rowDrag:left' | 'rowDrag:ended' | 'cell:changed' | 'cell:pending' | 'cell:confirmed' | 'cell:reverted' | 'cell:conflict' | 'cell:clicked' | 'cell:dblclicked' | 'cell:contextmenu' | 'cell:mouseover' | 'cell:mouseout' | 'cell:mousedown' | 'cell:mouseup' | 'cell:edit:start' | 'cell:edit:end' | 'row:edit:start' | 'row:edit:end' | 'row:clicked' | 'row:dblclicked' | 'row:pending' | 'row:confirmed' | 'row:reverted' | 'row:conflict' | 'form:opened' | 'form:closed' | 'form:saved' | 'form:error' | 'sort:changed' | 'filter:changed' | 'group:toggled' | 'facet:computed' | 'facet:filtered' | 'facet:expanded' | 'facet:failed' | 'column:moved' | 'column:resized' | 'column:visible' | 'column:pinned' | 'column:grouped' | 'column:pivoted' | 'column:filter:open' | 'column:profile:open' | 'column:menu:open' | 'pivot:drill' | 'columns:changed' | 'columns:tagged' | 'columngroup:changed' | 'header:contextmenu' | 'selection:changed' | 'range:changed' | 'clipboard:copy' | 'page:changed' | 'scroll' | 'scroll:end' | 'size:changed' | 'detail:toggled' | 'detail:cell:edit:start' | 'detail:cell:edit:end' | 'detail:row:edit:start' | 'detail:row:edit:end' | 'detail:cell:changed' | 'toolpanel:focus' | 'highlight:changed' | 'find:changed' | 'tree:loading' | 'tree:loaded' | 'tree:loadFailed' | 'tree:loadAborted' | 'state:changed' | 'state:reset' | 'history:changed' | 'history:applied' | 'views:changed' | 'view:applied' | 'view:saved' | 'view:removed' | 'view:renamed' | 'view:default' | 'validation:failed' | 'validation:cleared' | 'formatting:changed' | 'redaction:changed' | 'permissions:changed' | 'presentation:changed' | 'presentation:started' | 'presentation:ended' | 'presentation:view' | 'presentation:scale' | 'presentation:spotlight' | 'presentation:captured' | 'comment:added' | 'comment:edited' | 'comment:deleted' | 'comment:failed' | 'comment:resolved' | 'comment:unresolved' | 'comment:threadOpened' | 'comment:threadClosed' | 'comment:indexLoaded' | 'presence:published' | 'presence:joined' | 'presence:updated' | 'presence:left' | 'presence:failed' | 'presence:lockRefused' | 'diff:changed' | 'diff:swapped' | 'timeline:attached' | 'timeline:detached' | 'timeline:seek' | 'timeline:seeking' | 'annotation:changed' | 'export:progress' | 'export:request' | 'export:done' | 'shortcuts:opened' | 'shortcuts:closed' | 'print:before' | 'print:after' | 'beforeEdit' | 'beforeSort' | 'beforeFilter' | 'beforeColumnMove' | 'beforeColumnResize' | 'beforeColumnHide' | 'beforeSelect' | 'beforeRowAdd' | 'beforeDelete' | 'beforeRowMove' | 'beforeGroup' | 'beforeRowReceive' | 'edit:cancelled' | 'sort:cancelled' | 'filter:cancelled' | 'columnMove:cancelled' | 'columnResize:cancelled' | 'columnHide:cancelled' | 'selection:cancelled' | 'rowAdd:cancelled' | 'delete:cancelled' | 'rowMove:cancelled' | 'group:cancelled' | 'rowReceive:cancelled' | '*'

EventOrigin

Who caused a grid change: `'user'` interaction, an `'api'` call, `'init'` (the grid's own startup), or an approved `'ai'` write.

type EventOrigin = 'api' | 'user' | 'init' | 'ai'

ExcelHiddenColumns

What an Excel export does with grid-hidden columns: drop them, or keep them Excel-hidden.

type ExcelHiddenColumns = 'omit' | 'hidden'

ExportRowsScope

Which rows an export or a copy includes, widest set (the clipboard's, which alone offers `'range'`); a file export accepts the narrower `Extract<ExportRowsScope, …>` that excludes it.

type ExportRowsScope = 'visible' | 'all' | 'selected' | 'range'

FacetBarOrder

How a categorical facet histogram's bars are ordered.

type FacetBarOrder = 'count' | 'alpha'

FacetBoundsKind

Which family of buckets a column's facet histogram draws, or `none` for no histogram.

type FacetBoundsKind = 'numeric' | 'date' | 'category' | 'boolean' | 'none'

FacetBucketStrategy

How a facet histogram's numeric buckets are placed across a column's values.

type FacetBucketStrategy = 'equal' | 'quantile' | 'log'

FacetDateGranularity

The calendar unit a date column's facet histogram buckets by.

type FacetDateGranularity = 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year'

FacetOverflowMode

What a facet histogram does with a categorical column past its cardinality limit.

type FacetOverflowMode = 'suppress' | 'topN'

FacetSuppressedReason

Why a facet histogram was not drawn.

type FacetSuppressedReason = 'type' | 'cardinality' | 'rows' | 'streaming' | 'no-provider' | 'disabled'

Feed

A feed: any iterator that yields a snapshot first, then deltas forever.

type Feed = Iterator<FeedMessage>

Declared in lattice-grid/modules/mock-socket.

FeedMessageKind

Whether a feed message is the opening snapshot, or a delta of changes since.

type FeedMessageKind = 'snapshot' | 'delta'

Declared in lattice-grid/modules/mock-socket.

FeedRow

One record on a feed: any object. Its partition comes from a property and its identity from `rowKey`.

type FeedRow = Record<string, unknown>

Declared in lattice-grid/modules/mock-socket.

FilterCtor

A filter class. The grid instantiates one per column that uses it, and asks it to rebuild its control when the rows change.

type FilterCtor = new () => Filter

FilterKind

Which kind of filter fired: the structured condition tree, or the quick filter.

type FilterKind = 'structured' | 'quick'

FilterName

The built-in column filters, addressable by name through `column.filter`. `none` turns filtering off for a column; anything registered through `components` is also valid here.

type FilterName = 'text' | 'number' | 'date' | 'boolean' | 'set' | 'multi' | 'none' | (string & {})

FilterOp

How a filter group's children combine: conjunction, disjunction, or negation.

type FilterOp = 'and' | 'or' | 'not'

FilterSet

A filter, as data: one condition, a group nesting conditions and further groups to any depth, or `null` for no filter at all. This is the shape the filter APIs hand back and accept, so a filter can be saved with a view, sent to a server and restored without going through the user interface that built it.

type FilterSet = FilterGroup | Condition | null

FollowScope

Which slice of a source's rows a shared multi-site "follow" setting reads.

type FollowScope = 'filtered' | 'all' | 'selected' | 'grouped'

ForecastMethod

A forecasting kernel's method.

type ForecastMethod = 'movingAverage' | 'ses' | 'holt' | 'holtWinters' | 'linear'

FormatSpec

How a value is turned into the text you see. One of the four formatters, picked by the `type` on the spec; the rest of the object is that formatter's own options. A `geometry` column reads a {@link GeometryFormat} instead.

type FormatSpec = NumberFormat | DateFormat | BooleanFormat | TextFormat | GeometryFormat

FormattingScope

A column id, or `'*'` for every column.

type FormattingScope = string

FormBind

The `bind` option: a grid row (`{ grid, rowKey }`), a routed record (`{ router, route, key }`), or a plain object of values.

type FormBind = FormBindGridConfig | FormBindRouterConfig | Record<string, unknown>

Declared in lattice-grid/modules/form.

FormButtonsAlign

How a `buttons` row lays its children out along the form's width.

type FormButtonsAlign = 'start' | 'end' | 'center' | 'stretch' | 'space-between'

Declared in lattice-grid/modules/form.

FormButtonVariant

A button's visual weight: theme-token colours, light and dark.

type FormButtonVariant = 'primary' | 'secondary' | 'tonal' | 'outline' | 'text' | 'danger'

Declared in lattice-grid/modules/form.

FormControlType

The control types a form item may name.

type FormControlType = 'input' | 'number' | 'textarea' | 'checkbox' | 'button' | 'text' | 'combo' | 'select' | 'radiogroup' | 'checkboxgroup' | 'toggle' | 'datepicker' | 'file' | 'richtext' | 'rating' | 'stage' | 'chips' | 'otp'

Declared in lattice-grid/modules/form.

FormDensity

The density levels a form accepts - the grid's own presets.

type FormDensity = 'compact' | 'standard' | 'comfortable'

Declared in lattice-grid/modules/form.

FormEventName

The events a form raises, on `form.on()`. The form's own, not a grid's. `on()` warns once on any other name. The cancellable `beforeChange` runs before a committed edit is stored, on the same contract the grid core uses: call `preventDefault(reason?)` on the payload, or return `false`; a veto reverts the control to its committed value. The past-tense events - `change`, `input`, `click`, `focus` and `blur` - report an edit already made and carry no `preventDefault`.

type FormEventName = 'beforeChange' | 'change' | 'input' | 'click' | 'focus' | 'blur' | 'validated' | 'complete'

Declared in lattice-grid/modules/form.

FormInputSubtype

The native subtype of an `input` item.

type FormInputSubtype = 'text' | 'email' | 'password' | 'url'

Declared in lattice-grid/modules/form.

FormLabelPosition

Where an item's label sits: above the control, to its left, or visually hidden (the accessible name stays, but the label and its asterisk take no space).

type FormLabelPosition = 'top' | 'left' | 'hidden'

Declared in lattice-grid/modules/form.

FormPickerMode

The picker modes of a `datepicker` item.

type FormPickerMode = 'date' | 'date-time' | 'time'

Declared in lattice-grid/modules/form.

FormRule

A declarative field rule: a constant, a function of the whole `{ name: value }` snapshot, or a condition on one named item's value.

type FormRule = boolean | ((values: Record<string, unknown>) => boolean) | { name?: string; equals?: unknown; in?: unknown[]; empty?: boolean; fn?: (value: unknown, values: Record<string, unknown>) => boolean; }

Declared in lattice-grid/modules/form.

FormStepOrientation

The orientation of a wizard's step indicator.

type FormStepOrientation = 'horizontal' | 'vertical'

Declared in lattice-grid/modules/form.

FormulaResult

The result of evaluating a formula a user typed into a cell (spec 8.11).

type FormulaResult = { ok: true; value: unknown; references: string[] } | { ok: false; error: string; at?: number }

FormValidationMode

When an item re-checks itself: on a committed edit, on blur, or only on `validate()`.

type FormValidationMode = 'change' | 'blur' | 'submit'

Declared in lattice-grid/modules/form.

FormValidationRule

A validation rule: a built-in rule name (`email`, `number`, `integer`, `url`), a whole-value RegExp, or a function `(value, item)` returning `true`/`undefined`/`null` for pass, `false` for a fail, or a string that is the failure message.

type FormValidationRule = 'email' | 'number' | 'integer' | 'url' | RegExp | ((value: unknown, item: FormItemConfig) => boolean | string | void)

Declared in lattice-grid/modules/form.

GanttBarLabel

What a Gantt bar's own label shows: the task name, its percent, its dates, or nothing.

type GanttBarLabel = 'name' | 'percent' | 'dates' | 'none'

Declared in lattice-grid/modules/gantt.

GanttBarLabelPosition

Where a Gantt bar's own label sits: `inside` centres it on the bar when it fits, `right` keeps it just past the bar's right edge, and `auto` chooses - inside when it fits, right when it does not.

type GanttBarLabelPosition = 'inside' | 'right' | 'auto'

Declared in lattice-grid/modules/gantt.

GanttCalendar

A working-time calendar: a Monday-Friday preset, or explicit working weekdays and holidays.

type GanttCalendar = 'weekends' | { workdays?: number[]; holidays?: Array<string | number | Date> }

Declared in lattice-grid/modules/gantt.

GanttCalendarRef

What a task's or resource's `calendar` may be: a calendar spec stated inline, the `'weekends'` preset, or the id of an entry in the `calendars` option. An id that names none refuses the schedule with an `unknown-calendar` error.

type GanttCalendarRef = 'weekends' | string | GanttNamedCalendar

Declared in lattice-grid/modules/gantt.

GanttCalendars

The named calendars a plan offers its tasks and resources, keyed by calendar id.

type GanttCalendars = Record<string, GanttNamedCalendar>

Declared in lattice-grid/modules/gantt.

GanttChangeCause

The cause of one committed data-change: who or what moved it.

type GanttChangeCause = 'user' | 'pushed' | 'api' | 'undo' | 'redo'

Declared in lattice-grid/modules/gantt.

GanttChangeKind

The kind of one entry inside a {@link GanttChangeBatchEvent}.

type GanttChangeKind = 'taskAdd' | 'taskRemove' | 'taskUpdate' | 'dependencyAdd' | 'dependencyRemove' | 'dependencyUpdate' | 'assignmentChange'

Declared in lattice-grid/modules/gantt.

GanttCommitChangeKind

The kind of one entry in a `lattice:gantt-commit` / `lattice:gantt-change` detail.

type GanttCommitChangeKind = 'add' | 'delete' | 'move' | 'resize' | 'progress' | 'cell-edit' | 'link' | 'row-move'

Declared in lattice-grid/modules/gantt.

GanttConstraintType

A scheduling constraint: pin a date, floor/ceiling a start or finish, or schedule as late as possible.

type GanttConstraintType = 'as-soon-as-possible' | 'must-start-on' | 'must-finish-on' | 'as-late-as-possible' | 'start-no-earlier-than' | 'start-no-later-than' | 'finish-no-earlier-than' | 'finish-no-later-than' | 'ASAP' | 'MSO' | 'MFO' | 'ALAP' | 'SNET' | 'SNLT' | 'FNET' | 'FNLT'

Declared in lattice-grid/modules/gantt.

GanttContextMenu

The split view's context menu: the host supplies the items for a task's row or bar, and the view shows them in the grid's own menu component. Return `null`/`undefined` (or an empty array) to suppress the menu for that task. The function receives the host's ORIGINAL task object (the same shape `createGantt` took, not the scheduled shape) and the DOM event that asked for the menu - a pointer `contextmenu` event on the row/bar, or `null` when the request came from the keyboard (the Menu key / Shift+F10), where there is no pointer position. `event.preventDefault()` is already called for you; the native menu does not open. Each item's `action` is called with the item (as the grid does) and a `ctx` of `{ task, event, view }` - `task` the same original task, `event` the same DOM event, and `view` the `GanttSplitView` instance the menu belongs to. The third argument, `defaults`, is the built-in task menu: add task above / below, add subtask, add successor, add predecessor, convert to milestone (or back to a task) and delete, labelled from the message catalogue, with the actions on a read-only task disabled. Return it as is to keep it, filter it to hide items, reorder it, or spread it among your own. Pass `contextMenu: true` to install exactly the defaults.

type GanttContextMenu = true | ((task: GanttTask, event: Event | null, defaults: MenuItem[]) => MenuItem[] | null | undefined) | null

Declared in lattice-grid/modules/gantt.

GanttCriticalStyle

How a critical bar is marked: recoloured, or outlined over its own fill.

type GanttCriticalStyle = 'fill' | 'outline'

Declared in lattice-grid/modules/gantt.

GanttEventName

The events a Gantt controller raises. The controller's own, not a grid's: `grid.on` takes {@link EventName} and knows nothing about these, and a grid-bound Gantt follows the grid's events itself rather than re-publishing them. `on()` takes a name and a listener and warns about nothing, so a misspelt name is a subscription that never fires. The fourteen `before…` events are cancellable ({@link GanttBeforeEvent}); each has a matching `<action>:cancelled` that fires when a handler refuses, carrying the same context plus the reason. `schedule` and `error` are the recompute's own pair and are raised on every recompute, whatever caused it.

type GanttEventName = 'schedule' | 'error' | 'beforeTaskEdit' | 'beforeTaskMove' | 'beforeTaskResize' | 'beforeProgressChange' | 'beforeMilestoneMove' | 'beforeDependencyCreate' | 'beforeTaskDelete' | 'beforeDependencyDelete' | 'beforeRowMove' | 'beforeRowDrop' | 'taskEdit:cancelled' | 'taskMove:cancelled' | 'taskResize:cancelled' | 'progressChange:cancelled' | 'milestoneMove:cancelled' | 'dependencyCreate:cancelled' | 'taskDelete:cancelled' | 'beforeTaskPaste' | 'taskPaste:cancelled' | 'beforeTaskAdd' | 'taskAdd:cancelled' | 'beforeMilestoneConvert' | 'milestoneConvert:cancelled' | 'dependencyDelete:cancelled' | 'rowMove:cancelled' | 'rowDrop:cancelled' | 'dependencies' | 'history' | 'columnResize' | 'workload:click' | 'workloadCellClick' | 'workloadCellDblClick' | 'workloadCellContextMenu' | 'workloadCellHover' | 'workloadCellHoverEnd' | 'workloadResourceClick' | 'dataBand:change' | 'beforeDataBandEdit' | 'dataBandEdit:cancelled' | 'cell:click' | 'cellClick' | 'cellDblClick' | 'cellContextMenu' | 'beforeCellEditStart' | 'cellEditStart' | 'cellEditStart:cancelled' | 'cellEditCommit' | 'cellEditCancel' | 'rowClick' | 'rowDblClick' | 'task:filtered' | 'draw' | 'beforeTaskExpand' | 'beforeTaskCollapse' | 'taskExpand' | 'taskCollapse' | 'taskExpand:cancelled' | 'taskCollapse:cancelled' | 'resourceExpand' | 'resourceCollapse' | 'selectionChange' | 'rowMove' | 'rowDrop' | 'schedulingConflict' | 'taskAdd' | 'taskRemove' | 'taskUpdate' | 'dependencyAdd' | 'dependencyRemove' | 'dependencyUpdate' | 'assignmentChange' | 'datesChanged' | 'change' | 'ready' | 'beforeTaskDrag' | 'taskDragStart' | 'taskDrag' | 'taskDrag:cancelled' | 'beforeTaskResizeStart' | 'taskResizeStart' | 'taskPartialResize' | 'taskResizeEnd' | 'beforePercentBarDrag' | 'percentBarDragStart' | 'percentBarDrag' | 'percentBarDrop' | 'percentBarDrag:cancelled' | 'taskClick' | 'taskDblClick' | 'taskMouseOver' | 'taskMouseOut' | 'taskContextMenu' | 'linkClick' | 'linkDblClick' | 'linkContextMenu' | 'linkHover' | 'tooltipShow' | 'tooltipHide' | 'zoomChange' | 'visibleRangeChange' | 'scroll' | 'viewMount' | 'viewDestroy' | 'dirtyChange'

Declared in lattice-grid/modules/gantt.

GanttLinkType

One of the four dependency link types (finish-to-start, start-to-start, finish-to-finish, start-to-finish).

type GanttLinkType = 'FS' | 'SS' | 'FF' | 'SF'

Declared in lattice-grid/modules/gantt.

GanttResourceSpec

Resource capacities for over-allocation detection and leveling: either a list of resources or a name→capacity map. A resource may carry its own working `calendar`, in which case load, workload, over-allocation and `level()` measure it against THAT: zero capacity on a day it does not work, and `capacity` is read **in hours per day** (defaulting to that weekday's `hoursPerDay`). A resource with no calendar keeps the historical unitless `capacity` (max concurrent units, default 1), treated as a fraction of the plan `hoursPerDay`. A resource may also carry cost data: `rate` (per hour, for the default `type: 'work'`, or per unit of an assignment's `units` for `type: 'material'`), dated `rates` changes, and `type` - `'cost'` charges its flat `cost` once per assignment, independent of hours or units. `gantt.cost()`/`earnedValue()`/the histogram's `unit: 'cost'` read this; a resource with none of `rate`/`rates`/`cost` costs nothing, so a plan with no rate data is unaffected. A resource may also carry an `avatar` image URL, drawn as a round picture in the split view's assignee column, workload band resource rows and assignment picker - `alt` text is the resource's name, and a resource without one, or whose image fails to load, keeps its initials glyph.

type GanttResourceSpec = Array<{ id?: string; name?: string; resource?: string; avatar?: string; capacity?: number; maxUnits?: number; max?: number; units?: number; calendar?: GanttResourceCalendar | GanttCalendarRef; rate?: number; rates?: GanttResourceRateChange[]; type?: 'work' | 'material' | 'cost'; cost?: number; }> | Record<string, number>

Declared in lattice-grid/modules/gantt.

GanttSchedulingMode

A task's scheduling mode: which quantity of `effort = duration × Σ units × hours per day` is held when another changes. `fixedDuration` (the default) holds the duration; `fixedEffort` holds the effort so more units shorten the duration; `fixedUnits` holds the units so a bigger effort lengthens the duration.

type GanttSchedulingMode = 'fixedDuration' | 'fixedEffort' | 'fixedUnits'

Declared in lattice-grid/modules/gantt.

GanttTooltip

The task tooltip: a positioned card on hover and keyboard focus, anchored to the bar, in both `mount` and `mountSplit`. `true` (the default) draws the built-in card: the task name as a title, then labelled Start/End/Duration/Complete rows (dates in the grid/plan locale, e.g. "May 1, 2026"; "Duration: 152 days"), plus Effort, Assigned, Cost and Slack when the task has them. A milestone shows a single Date row instead. `{ fields }` picks and orders the rows (ignored for a milestone, which always shows just its Date). `false` turns the tooltip off. A function renders the host's own content - a `string` (always text) or a `Node`/`HTMLElement` (the host's own DOM, attached as it is; task data put into it should still be set as text, never `innerHTML`).

type GanttTooltip = boolean | { fields?: GanttTooltipField[] } | ((task: GanttScheduledTask, ctx: GanttTooltipContext) => string | HTMLElement | null | undefined)

Declared in lattice-grid/modules/gantt.

GanttTooltipField

A row the task tooltip card can show; `tooltip.fields` picks and orders them.

type GanttTooltipField = 'start' | 'end' | 'duration' | 'percentComplete' | 'effort' | 'resources' | 'cost' | 'slack' | 'deadline'

Declared in lattice-grid/modules/gantt.

GanttZoom

The Gantt timeline's zoom: a named level, or raw pixels-per-day.

type GanttZoom = 'day' | 'week' | 'month' | 'quarter'

Declared in lattice-grid/modules/gantt.

GanttZoomCause

What changed the split view's zoom: a host `setZoom`/`fitZoom` (`'api'`), the view's own zoom control (`'control'`), or a future pinch/wheel gesture (`'gesture'`).

type GanttZoomCause = 'api' | 'control' | 'gesture'

Declared in lattice-grid/modules/gantt.

GanttZoomLevel

One level of the split view's built-in zoom control: a preset, or `fit`, which zooms to show the whole plan.

type GanttZoomLevel = GanttZoom | 'fit'

Declared in lattice-grid/modules/gantt.

GanttZoomValue

The level a `zoomChange` moved from or to: a preset, `fit` (the control's fit-to-plan), or `custom` for a raw pixels-per-day.

type GanttZoomValue = GanttZoom | 'fit' | 'custom'

Declared in lattice-grid/modules/gantt.

GeometryFormatPattern

What a `geometry` cell shows: `'summary'` (the default) is a line a person reads - `Point 51.5074°N 0.1278°W`, `Polygon, 14 vertices, 2.31 km²` - with numbers in the grid's locale; `'wkt'` is the Well-Known Text; `'geojson'` is the GeoJSON geometry as JSON text.

type GeometryFormatPattern = 'summary' | 'wkt' | 'geojson'

GeometryKind

The kind of a geometry: the GeoJSON geometry type name.

type GeometryKind = 'Point' | 'LineString' | 'Polygon' | 'MultiPoint' | 'MultiLineString' | 'MultiPolygon' | 'GeometryCollection'

GraphqlPagination

How a GraphQL adapter pages: an offset/limit list, or a Relay cursor connection.

type GraphqlPagination = 'offset' | 'cursor'

HandlerProp

The React prop name for one grid event: `'rows:changed'` is `onRowsChanged`. The pair with {@link PascalJoin} is what lets an editor complete the props of `<LatticeGrid>` from the event union itself.

type HandlerProp<E extends string> = `on${PascalJoin<E>}`

Declared in lattice-grid/modules/react.

HeaderControlsVisibility

When the per-column header controls - the sort arrow, the filter funnel and the menu button - are shown, as a grid-level default. See {@link GridConfig.headerControls}.

type HeaderControlsVisibility = 'hover' | 'always' | 'hidden' | 'none'

HeaderRenderFn

The short form of a heading renderer: a function handed the heading element to fill and the {@link HeaderParams} above.

type HeaderRenderFn = (label: HTMLElement, params: HeaderParams) => HTMLElement | string | void

HistoryDirection

Which way the undo/redo stack moved.

type HistoryDirection = 'undo' | 'redo'

IconDefinition

One sprite as a registration route accepts it: `config.icons`, `registerIcon` and `registerIcons` all take this shape. The long form is the glyph itself - a view box, one or more SVG path `d` strings, and whether they are stroked or filled. The two short forms exist because most glyphs are one filled path on the house 16x16 box: a bare path string, or an array of them, is read as exactly that, so a host registering its own mark writes the path and nothing else. `path` is accepted as a singular spelling of `paths`. What comes back out of {@link IconRegistryApi} is always the normalised {@link IconGlyph}, never the short form. A name already in the registry is overridden, which is how the expander chevron or the sort arrow is swapped for a host's own.

type IconDefinition = string | string[] | { viewBox?: string; paths?: string[]; path?: string; paint?: Paint; }

IconName

A glyph name from the icon sprite registry (`packages/dom/src/cell/icons.js`). The union below is every built-in name, generated from `iconNames()` so an editor can autocomplete and typo-check them - see `test/icon-name-type-drift.test.js`, which fails if this list and the registry ever disagree. It is deliberately **not closed**: the registry is extensible at runtime via `registerIcon`, `registerIcons`, `config.icons` and `grid.icons`, and `(string & {})` widens the type so a custom registered name still typechecks without losing autocomplete on the built-ins. A name the registry has never heard of - built-in or custom - draws a blank glyph and warns once at runtime; it is not a type error.

type IconName = 'chevronRight' | 'chevronDown' | 'chevronUp' | 'chevronLeft' | 'check' | 'dash' | 'close' | 'plus' | 'minus' | 'info' | 'success' | 'warning' | 'danger' | 'clock' | 'lock' | 'link' | 'external' | 'filter' | 'pause' | 'play' | 'chart' | 'palette' | 'undo' | 'redo' | 'columns' | 'download' | 'restore' | 'spreadsheet' | 'print' | 'maximise' | 'minimise' | 'views' | 'search' | 'pencil' | 'trash' | 'share' | 'pin' | 'sortAsc' | 'sortDesc' | 'menu' | 'drag' | 'star' | 'heart' | 'circleFilled' | 'square' | 'bolt' | 'flag' | 'arrow' | 'highlight' | 'eraser' | 'thumbUp' | 'eye' | 'eyeOff' | 'copy' | 'present' | 'cabinet' | 'splice' | 'exchange' | 'pole' | 'chamber' | 'premises' | 'fault' | 'user' | 'calendar' | 'blank' | (string & {})

IconSetKind

A built-in glyph set for an icon-set formatting rule.

type IconSetKind = 'arrows' | 'trafficLights' | 'ratings'

IconSetName

A built-in threshold icon set, mapping value bands to built-in glyphs.

type IconSetName = 'trafficLights' | 'arrows' | 'trafficArrows' | 'ratings' | (string & {})

ImportMode

How a confirmed import lands: added to the dataset, or replacing it.

type ImportMode = 'append' | 'replace'

IntervalBounds

Which ends of a `between` range are inclusive, in interval notation.

type IntervalBounds = '[]' | '[)' | '(]' | '()'

JoinType

Whether a join keeps only matched rows, or keeps every row on this side.

type JoinType = 'inner' | 'left'

KanbanAssignee

One assignee on a card: a name string, or an object carrying `name` (or `label`/`id`) and an optional `avatar` image URL. Drawn as the avatar component the Gantt has used since 1.88 - the picture when it has one, the initials glyph otherwise, coloured from the name, with a `+N` overflow.

type KanbanAssignee = string | { name?: string; label?: string; id?: string; avatar?: string | null }

Declared in lattice-grid/modules/kanban.

KanbanChecklistMap

The checklist mapping: a property path/fn whose value is a `{ done, total }` object, or an object `{ done, total }` naming the two fields separately. Rendered as a `3/5` count.

type KanbanChecklistMap = KanbanFieldMap | { done: string; total: string }

Declared in lattice-grid/modules/kanban.

KanbanColumnDef

A column definition: an id string, or an object configuring one column.

type KanbanColumnDef = string | { id: string; title?: string; color?: string; wipLimit?: number; collapsed?: boolean; sla?: KanbanSlaThreshold | { warn?: KanbanSlaThreshold; breach?: KanbanSlaThreshold }; slaWarn?: KanbanSlaThreshold; slaBreach?: KanbanSlaThreshold; }

Declared in lattice-grid/modules/kanban.

KanbanColumnWidth

The column-width mode. A number fixes the width in pixels; `'fill'` (the default) shares the board width equally between the columns, never below {@link KanbanConfig.minColumnWidth}; `'auto'` keeps the natural fixed width the `--lattice-board-column-width` token declares (default 280px). The token, when the host sets it, still overrides the option.

type KanbanColumnWidth = number | 'fill' | 'auto'

Declared in lattice-grid/modules/kanban.

KanbanDensity

The card density: `'compact'` tightens each card's padding and drops the subtitle so a column fits more cards; `'comfortable'` (the default) keeps the roomier card.

type KanbanDensity = 'compact' | 'comfortable'

Declared in lattice-grid/modules/kanban.

KanbanDueMap

The due-date mapping: a property path/fn (as any other field), or an object `{ field, dueSoon }` where `dueSoon` is the number of days that counts as "due soon". The date is drawn in the grid's date format when bound to a date column, and coloured with an icon when overdue or due soon.

type KanbanDueMap = KanbanFieldMap | { field: string; dueSoon?: number }

Declared in lattice-grid/modules/kanban.

KanbanEventName

The events a board raises. The board's own, not the grid's: `grid.on` takes {@link EventName} and knows nothing about these, and a grid-bound board follows the grid's events itself rather than re-publishing them. `on()` warns once on any other name, because a binding to an event that can never fire is a silent no-op. The `before…` six are cancellable on the same contract the grid core uses: call `preventDefault(reason?)` on the payload, or return a Promise to hold the action until it settles; a veto fires the matching `<action>:cancelled` carrying the reason.

type KanbanEventName = 'card:click' | 'card:dblclick' | 'card:contextmenu' | 'card:move' | 'card:reverted' | 'card:confirmed' | 'selection:changed' | 'column:collapse' | 'card:add' | 'drag:start' | 'drag:end' | 'swimlane:collapse' | 'swimlane:reorder' | 'column:reorder' | 'filter:changed' | 'sprint:changed' | 'epic:changed' | 'card:expand' | 'card:drill' | 'card:edit' | 'card:sla' | 'cards:loaded' | 'beforeMove' | 'beforeAdd' | 'beforeEdit' | 'beforeLaneReorder' | 'beforeColumnReorder' | 'beforeColumnChange' | 'move:cancelled' | 'add:cancelled' | 'edit:cancelled' | 'laneReorder:cancelled' | 'columnReorder:cancelled' | 'columnChange:cancelled' | 'history'

Declared in lattice-grid/modules/kanban.

KanbanFieldMap

A card field mapping: a property path, a function, or an object opting into inline edit.

type KanbanFieldMap = string | ((row: KanbanRow) => unknown) | { field: string; edit?: boolean; editor?: (ctx: { card: KanbanCard; field: string; value: string; commit: (value: unknown) => void; cancel: () => void }) => KanbanEditor; }

Declared in lattice-grid/modules/kanban.

KanbanLaneDef

A swimlane definition. A lane may also carry workflow-rule overrides: its `transitions`/`require` maps replace the board-level maps per key for cards in that lane.

type KanbanLaneDef = { id: string; title?: string; transitions?: Record<string, string[] | '*'>; require?: Record<string, KanbanRequiredField[]>; }

Declared in lattice-grid/modules/kanban.

KanbanReadonly

Granular readonly: the whole board, or selectively by column id and card key.

type KanbanReadonly = boolean | { board?: boolean; columns?: Record<string, boolean>; cards?: Record<string, boolean>; }

Declared in lattice-grid/modules/kanban.

KanbanRow

A row backing a card: any object. Its column comes from `columnProperty` and its identity from `rowKey`.

type KanbanRow = Record<string, unknown>

Declared in lattice-grid/modules/kanban.

KanbanSlaThreshold

A card-aging / SLA threshold: a raw millisecond count, or a `{ weeks, days, hours, minutes, seconds, ms }` spec whose fields are summed (`{ days: 3, hours: 12 }` → 3.5 days). A negative or non-finite value means "no threshold at this level".

type KanbanSlaThreshold = number | { weeks?: number; week?: number; w?: number; days?: number; day?: number; d?: number; hours?: number; hour?: number; h?: number; minutes?: number; minute?: number; m?: number; min?: number; seconds?: number; second?: number; s?: number; sec?: number; ms?: number; milliseconds?: number; }

Declared in lattice-grid/modules/kanban.

KPIAggregation

The aggregation kinds a tile can compute. `custom` is a host reducer over the rows.

type KPIAggregation = 'sum' | 'avg' | 'min' | 'max' | 'count' | 'countDistinct' | 'custom'

Declared in lattice-grid/modules/kpi.

KPIEventName

The events a KPI panel raises. The panel's own, not the grid's: `grid.on` takes {@link EventName} and knows nothing about these, and a grid-bound panel follows the grid's events itself rather than re-publishing them. `on()` warns once on any other name, because a binding to an event that can never fire is a silent no-op.

type KPIEventName = 'tile:click' | 'tile:dblclick' | 'tile:contextmenu' | 'node:toggle' | 'change' | 'tile:status'

Declared in lattice-grid/modules/kpi.

KPIFormat

Number formatting for a tile value. `percent` treats the value as a ratio (0.42 → 42%).

type KPIFormat = 'number' | 'currency' | 'percent' | 'compact' | { type?: 'number' | 'currency' | 'percent' | 'compact'; decimals?: number; currency?: string; locale?: string }

Declared in lattice-grid/modules/kpi.

KpiRollupStatus

A KPI tile or node's status including the "measured nothing" state.

type KpiRollupStatus = 'good' | 'warn' | 'critical' | 'unknown'

Declared in lattice-grid/modules/kpi.

KPIRow

A row backing a KPI aggregate: any object. Its identity comes from `rowKey`.

type KPIRow = Record<string, unknown>

Declared in lattice-grid/modules/kpi.

KpiStatus

A KPI tile or node's status: good, a warning, or critical - never `unknown`.

type KpiStatus = 'good' | 'warn' | 'critical'

Declared in lattice-grid/modules/kpi.

KpiThresholdDirection

Which way is good for a KPI threshold: a higher value, or a lower one.

type KpiThresholdDirection = 'higherIsBetter' | 'lowerIsBetter'

Declared in lattice-grid/modules/kpi.

KPITile

One tile: a `kind`-discriminated aggregate stat tile (the default) or a clock tile.

type KPITile = KPIStatTile | KPIClockTile

Declared in lattice-grid/modules/kpi.

KpiTileKind

Which kind of tile a computed KPI tile is: an aggregate stat, or a clock.

type KpiTileKind = 'stat' | 'clock'

Declared in lattice-grid/modules/kpi.

LatticeChartProps

A chart's React props: the spec, the common ones, and its five events.

type LatticeChartProps = Record<string, unknown> & LatticeViewerCommonProps & { grid?: Grid | null; onClick?: (payload: unknown) => void; onHover?: (payload: unknown) => void; onLeave?: (payload: unknown) => void; onDraw?: (payload: unknown) => void; onLegend?: (payload: unknown) => void; }

Declared in lattice-grid/modules/react.

LatticeDesignerProps

The designer's React props.

type LatticeDesignerProps = Record<string, unknown> & { mode?: DesignerOptions['mode']; state?: DesignerOptions['state']; sources?: DesignerOptions['sources']; relationships?: DesignerOptions['relationships']; guardrails?: DesignerOptions['guardrails']; factories?: DesignerOptions['factories']; llm?: DesignerOptions['llm']; onStateChange?: (payload: DesignerStateEvent) => void; onMode?: (payload: DesignerModeEvent) => void; onPage?: (payload: DesignerPageEvent) => void; onSelect?: (payload: DesignerSelectEvent) => void; className?: string; style?: Record<string, unknown>; id?: string; }

Declared in lattice-grid/modules/react.

LatticeGanttProps

The Gantt's React props.

type LatticeGanttProps = Record<string, unknown> & LatticeViewerCommonProps & { tasks?: unknown[]; dependencies?: unknown[]; onSchedule?: (payload: unknown) => void; onError?: (payload: unknown) => void; }

Declared in lattice-grid/modules/react.

LatticeGridEventProps

Every grid event as a React callback prop, each receiving the `GridEvent`.

type LatticeGridEventProps = { [E in EventName as HandlerProp<E>]?: (event: GridEvent) => void; }

Declared in lattice-grid/modules/react.

LatticeGridGlobal

The namespace object the script-tag build publishes, as a type. Named so that the ambient global below can refer to it: inside a `declare global` block the identifier `LatticeGrid` is the global being declared, so `typeof LatticeGrid` there would describe itself.

type LatticeGridGlobal = typeof LatticeGrid

LatticeLayoutProps

The layout's React props.

type LatticeLayoutProps = Record<string, unknown> & LatticeViewerCommonProps

Declared in lattice-grid/modules/react.

LatticeSchedulerProps

The scheduler's React props.

type LatticeSchedulerProps = Record<string, unknown> & LatticeViewerCommonProps & { resources?: SchedulerConfig['resources']; events?: SchedulerConfig['events']; zoom?: SchedulerConfig['zoom']; onZoomChange?: (payload: SchedulerZoomChangeEvent) => void; }

Declared in lattice-grid/modules/react.

LatticeSvelteCallbacks

Every event of a set, as the optional callback props a caller may bind.

type LatticeSvelteCallbacks<Events extends string, Payload> = { [E in Events as `on${CamelJoin<E>}`]?: (payload: Payload) => void; }

Declared in lattice-grid/modules/svelte.

LatticeSvelteDesignerProps

The designer's Svelte prop shape, for `Designer.svelte`.

type LatticeSvelteDesignerProps = LatticeSvelteHostProps & { mode?: DesignerOptions['mode']; state?: DesignerOptions['state']; sources?: DesignerOptions['sources']; relationships?: DesignerOptions['relationships']; guardrails?: DesignerOptions['guardrails']; factories?: DesignerOptions['factories']; llm?: DesignerOptions['llm']; onStateChange?: (payload: DesignerStateEvent) => void; onMode?: (payload: DesignerModeEvent) => void; onPage?: (payload: DesignerPageEvent) => void; onSelect?: (payload: DesignerSelectEvent) => void; }

Declared in lattice-grid/modules/svelte.

LatticeSvelteGridRegistry

The registry `GridProvider.svelte` puts in context and every viewer reads.

type LatticeSvelteGridRegistry = { publish: (name: string, grid: Grid | null) => void; get: (name?: string) => Grid | null; names: () => string[]; subscribe: (fn: () => void) => () => void; }

Declared in lattice-grid/modules/svelte.

LatticeSvelteHostProps

Host-element bindings every component here puts on its wrapper `div`.

type LatticeSvelteHostProps = { class?: string; style?: string; id?: string; }

Declared in lattice-grid/modules/svelte.

LatticeSvelteRouterHandle

The router handle `Router.svelte` puts in context.

type LatticeSvelteRouterHandle = { readonly router: unknown; attach: (grid: Grid, route: unknown, routeOptions?: Record<string, unknown>) => void; detach: (grid: Grid) => void; destroy: () => void; }

Declared in lattice-grid/modules/svelte.

LatticeTabsProps

The tab strip's React props.

type LatticeTabsProps = Record<string, unknown> & { tabs: LatticeTabSpec[]; active?: string; onBeforeTabChange?: (payload: unknown) => void; onTabChanged?: (payload: unknown) => void; onTabChangeCancelled?: (payload: unknown) => void; className?: string; style?: Record<string, unknown>; id?: string; }

Declared in lattice-grid/modules/react.

LatticeVueChartProps

A chart's Vue props: the spec, the common ones, and its five events.

type LatticeVueChartProps = Record<string, unknown> & LatticeVueViewerCommonProps & LatticeVueListeners<'click' | 'hover' | 'leave' | 'draw' | 'legend', unknown>

Declared in lattice-grid/modules/vue.

LatticeVueDesignerEmit

What `<LatticeDesigner>` emits: its four events under their own names.

type LatticeVueDesignerEmit = { (event: 'state', payload: DesignerStateEvent): void; (event: 'mode', payload: DesignerModeEvent): void; (event: 'page', payload: DesignerPageEvent): void; (event: 'select', payload: DesignerSelectEvent): void; }

Declared in lattice-grid/modules/vue.

LatticeVueDesignerProps

The designer's Vue props.

type LatticeVueDesignerProps = Record<string, unknown> & LatticeVueHostProps & { mode?: DesignerOptions['mode']; state?: DesignerOptions['state']; sources?: DesignerOptions['sources']; relationships?: DesignerOptions['relationships']; guardrails?: DesignerOptions['guardrails']; factories?: DesignerOptions['factories']; llm?: DesignerOptions['llm']; } & LatticeVueListeners<'state' | 'mode' | 'page' | 'select'

Declared in lattice-grid/modules/vue.

LatticeVueFormProps

The form's Vue props: the configuration, the common ones, and its seven events.

type LatticeVueFormProps = Record<string, unknown> & LatticeVueViewerCommonProps & LatticeVueListeners< 'beforeChange' | 'change' | 'input' | 'click' | 'focus' | 'blur' | 'validated', unknown>

Declared in lattice-grid/modules/vue.

LatticeVueGanttProps

The Gantt's Vue props.

type LatticeVueGanttProps = Record<string, unknown> & LatticeVueViewerCommonProps & { tasks?: unknown[]; dependencies?: unknown[]; } & LatticeVueListeners<'schedule' | 'error', unknown>

Declared in lattice-grid/modules/vue.

LatticeVueGridEmit

What `<LatticeGrid>` emits. `grid-ready` and `grid-destroyed` are named that way because `ready` and `destroy` are **grid event names** already re-emitted here, and React and Angular name their lifecycle pair the same.

type LatticeVueGridEmit = { (event: DashJoin<EventName>, payload: GridEvent): void; (event: 'grid-ready', grid: Grid): void; (event: 'grid-destroyed'): void; }

Declared in lattice-grid/modules/vue.

LatticeVueHostProps

Host-element bindings every component here forwards to its wrapper `div`.

type LatticeVueHostProps = { class?: unknown; style?: unknown; id?: string; }

Declared in lattice-grid/modules/vue.

LatticeVueLayoutProps

The layout's Vue props.

type LatticeVueLayoutProps = Record<string, unknown> & LatticeVueViewerCommonProps

Declared in lattice-grid/modules/vue.

LatticeVueListeners

Every event of a set, as the optional listener props a caller may bind.

type LatticeVueListeners<Events extends string, Payload> = { [E in Events as ListenerProp<E>]?: (payload: Payload) => void; }

Declared in lattice-grid/modules/vue.

LatticeVueSchedulerProps

The scheduler's Vue props.

type LatticeVueSchedulerProps = Record<string, unknown> & LatticeVueViewerCommonProps & { resources?: SchedulerConfig['resources']; events?: SchedulerConfig['events']; zoom?: SchedulerConfig['zoom']; } & LatticeVueListeners<'zoom-change', SchedulerZoomChangeEvent>

Declared in lattice-grid/modules/vue.

LatticeVueShellProps

The shell's Vue props: the arrangement, the common ones, and its state event.

type LatticeVueShellProps = Record<string, unknown> & LatticeVueViewerCommonProps & LatticeVueListeners<'state-change', ShellStateChangeEvent>

Declared in lattice-grid/modules/vue.

LatticeVueTabsProps

The tab strip's Vue props.

type LatticeVueTabsProps = Record<string, unknown> & LatticeVueHostProps & { tabs: LatticeVueTabSpec[]; active?: string; onReady?: (strip: unknown) => void; onDestroyed?: () => void; } & LatticeVueListeners<'before-tab-change' | 'tab-changed' | 'tab-change-cancelled', unknown>

Declared in lattice-grid/modules/vue.

LatticeVueViewerCommonProps

What every viewer component takes beyond its own configuration.

type LatticeVueViewerCommonProps = LatticeVueHostProps & { grid?: Grid | null; gridName?: string; onReady?: (instance: unknown) => void; onDestroyed?: () => void; }

Declared in lattice-grid/modules/vue.

LatticeVueViewerEmit

A viewer's emitter: its own events under dashed names, plus the lifecycle pair.

type LatticeVueViewerEmit<Events extends string> = { (event: Events, payload: unknown): void; (event: 'ready', instance: unknown): void; (event: 'destroyed'): void; }

Declared in lattice-grid/modules/vue.

LayoutCompaction

Which way displaced windows are pushed, and floated, when the arrangement compacts.

type LayoutCompaction = 'vertical' | 'horizontal' | 'none'

Declared in lattice-grid/modules/layout.

LayoutCorners

A window frame's corner style (default `'rounded'`,. `'square'` zeroes the radius on the window, its title bar, the minimised strip and the maximised frame - all the same element in a different state - with no other visual change.

type LayoutCorners = 'rounded' | 'square'

Declared in lattice-grid/modules/layout.

LayoutEventName

The events a dashboard layout raises. The layout's own, not a grid's: `grid.on` takes {@link EventName} and knows nothing about these. Each has a matching `on…` config callback (`onWindowMoved`, `onBeforeWindowClose`, …) and both routes fire. The three `before…` events are cancellable: call `preventDefault(reason?)` on the payload, or return a Promise to hold the gesture until it settles; a veto fires the matching `…:cancelled` carrying the reason. Subscribing to `'*'` receives every past-tense event and never gates.

type LayoutEventName = 'window:moved' | 'window:resized' | 'window:closed' | 'layout:changed' | 'beforeWindowMove' | 'beforeWindowResize' | 'beforeWindowClose' | 'windowMove:cancelled' | 'windowResize:cancelled' | 'windowClose:cancelled'

Declared in lattice-grid/modules/layout.

LayoutOverflow

Whether a layout axis clips its content at the edge or scrolls past it.

type LayoutOverflow = 'static' | 'scroll'

Declared in lattice-grid/modules/layout.

LicenceState

What a deployment is treated as, for licensing purposes.

type LicenceState = 'licensed' | 'localhost' | 'trial'

ListenerProp

One dashed event, as the listener prop Vue's template compiler produces: `'cell-changed'` becomes `'onCell-changed'`. Vue resolves `@cell-changed` to that prop name, so listing them is what makes a template binding type-check.

type ListenerProp<E extends string> = `on${Capitalize<E>}`

Declared in lattice-grid/modules/vue.

ListOperator

The four operators of a `list` column (declared by the type the opt-in `modules/list` registers), questions about the whole list. They compare items exactly (case matters), as SQL's `list_has_any` does. - `hasAny` - the list holds at least one of the operand's items. - `hasAll` - the list holds every one of them (an empty operand: every row). - `hasNone` - the list holds none of them (an empty or absent list included). - `listCount` - the number of items compares as a {@link ListCount} says. Every operator of the item type applies to a list column too, with "any item matches" semantics; see `DataType.items`.

type ListOperator = 'hasAny' | 'hasAll' | 'hasNone' | 'listCount'

LookupSortBy

How a lookup's option list is ordered for display.

type LookupSortBy = 'label' | 'value' | 'optionOrder' | 'count'

MaintenanceExactness

Whether a kernel's exact tier is maintained incrementally, or rescans.

type MaintenanceExactness = 'maintained' | 'rescan'

MapProjection

A geomap's named projection; a caller may also supply a projection function directly.

type MapProjection = 'equalEarth' | 'robinson' | 'mercator' | 'equirectangular' | 'albers' | 'transverseMercator' | 'britishNationalGrid' | 'orthographic' | 'globe'

MapViewCamera

A camera: centre `[lng, lat]`, zoom, pitch and bearing in degrees.

type MapViewCamera = { center?: [number, number]; zoom?: number; pitch?: number; bearing?: number }

Declared in lattice-grid/modules/mapview.

MapViewColour

How rows are coloured: one colour (a CSS hex or `rgb()` colour, or `[r, g, b, a?]`); a category per value of a column (`map` names the colour of each value, and any other value takes the next colour of the charts palette); or a number placed along a ramp by the charts module's own scale code, between the `colours` stops (default the default scheme's sequential ramp), over `domain` (default the drawn values' range), on a `rampScale` (`linear`, `log` or `quantile`; chosen from the values when unset, as a heat map's is).

type MapViewColour = string | number[] | { field: string; map?: Record<string, string | number[]> } | { field: string; scale: 'ramp'; domain?: [number, number]; colours?: string[]; rampScale?: 'linear' | 'log' | 'quantile'; }

Declared in lattice-grid/modules/mapview.

MapViewDash

How lines are dashed: one pattern for every line, or a pattern per value of a column (`map`; a value it does not name is drawn solid). The pattern is in pixels and holds its length on screen while the camera zooms and pitches. Needs deck.gl's `PathStyleExtension` on the page's deck (the full `deck.gl` bundle has it); without it `mapview:dash` warns and lines are solid. A pattern that is none of these warns `mapview:dash:spec`.

type MapViewDash = MapViewDashPattern | { field: string; map: Record<string, MapViewDashPattern> }

Declared in lattice-grid/modules/mapview.

MapViewDashPattern

A line pattern as `[dash, gap]` in pixels, or a name: `solid`, `dashed` (10 px dash, 6 px gap) or `dotted` (2 px dash, 5 px gap).

type MapViewDashPattern = 'solid' | 'dashed' | 'dotted' | [number, number]

Declared in lattice-grid/modules/mapview.

MapViewEnd

One end of a segment row: the columns holding its latitude and longitude (`lng`, or `lon`).

type MapViewEnd = { lat: string; lng: string } | { lat: string; lon: string }

Declared in lattice-grid/modules/mapview.

MapViewEventName

The events a map view emits.

type MapViewEventName = 'feature:click' | 'feature:hover' | 'draw' | 'load' | 'close'

Declared in lattice-grid/modules/mapview.

MapViewFlow

An animated flow along routes: `speed` is traversals of a route per second (default 0.25), `trail` the share of a route the moving trail lights (default 0.3).

type MapViewFlow = boolean | { speed?: number; trail?: number }

Declared in lattice-grid/modules/mapview.

MapViewGeometry

Where a row's place is read from: a latitude and a longitude column (`lng`, or `lon`), optionally with a `route` to join rows into lines; a `from` and a `to` (each a latitude and a longitude column) for a row that is one segment; a GeoJSON column (a `Geometry` or a `Feature`, as an object or its JSON text, or WKT or WKB); or a path column holding an array of `[lng, lat]` pairs (or its JSON text).

type MapViewGeometry = { lat: string; lng: string; route?: MapViewRoute } | { lat: string; lon: string; route?: MapViewRoute } | { from: MapViewEnd; to: MapViewEnd } | { geojson: string } | { path: string }

Declared in lattice-grid/modules/mapview.

MapViewIcon

Icon markers for point rows. A point's icon is `map[value of field]`, else `default`; with a `field` and no `map` the value is itself the icon. A point with no icon is drawn as a circle. A name that is no glyph, path or URL warns `mapview:icon:<name>`; with no canvas to draw on, `mapview:icons`. Registry glyphs are tinted by the `color` mapping (an image URL is drawn as it is). In 3D an icon is a billboard: it always faces the camera, is drawn whole at ground level over the routes and the extruded buildings (it is not depth-tested, so a building never hides it), and keeps its pixel size at every zoom. All the icons live in one atlas, packed once and again only when a point asks for an icon it does not hold.

type MapViewIcon = MapViewIconRef | { field?: string; map?: Record<string, MapViewIconRef>; default?: MapViewIconRef; size?: string | number; anchor?: 'center' | 'bottom' | 'top' | 'left' | 'right'; badge?: boolean | 'circle' | 'square' | 'diamond'; }

Declared in lattice-grid/modules/mapview.

MapViewIconRef

An icon for a point row: the name of a glyph of the grid's icon registry (`grid.icons`: `cabinet`, `splice`, `exchange`, `pole`, `chamber`, `premises`, `fault` and the rest, and any you register), an SVG path (in a 16 x 16 box), an icon definition (`{ viewBox, paths }`), or an image URL.

type MapViewIconRef = string | { viewBox?: string; paths?: string[]; path?: string; paint?: 'stroke' | 'fill' }

Declared in lattice-grid/modules/mapview.

MapViewLayer

The layer kinds a map view draws a row with.

type MapViewLayer = 'point' | 'column' | 'polygon' | 'path'

Declared in lattice-grid/modules/mapview.

NumberFormatNegative

How a negative number is marked: a leading minus, parentheses, or a trailing suffix.

type NumberFormatNegative = 'minus' | 'parentheses' | 'suffix'

NumberFormatNotation

A number format's magnitude notation, mirroring `Intl.NumberFormatOptions.notation`.

type NumberFormatNotation = 'standard' | 'compact' | 'scientific'

NumberFormatStyle

A number format's family: plain decimal, currency, or a percentage.

type NumberFormatStyle = 'decimal' | 'currency' | 'percent'

Operator

The comparison a filter condition makes. Every operator has an exact negation - `eq`/`ne`, `contains`/`notContains`, `between`/`notBetween`, `in`/`notIn`, `blank`/`notBlank` - so a rule and its inverse are always both expressible. Which of them a column offers depends on its type, and a source that pushes filtering down to a query engine may accept a narrower set again.

type Operator = 'eq' | 'ne' | 'lt' | 'lte' | 'gt' | 'gte' | 'between' | 'notBetween' | 'in' | 'notIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'matches' | 'blank' | 'notBlank' | 'containsAny' | 'containsAll' | 'containsNone' | SpatialOperator | ListOperator

OutlierMethod

Every anomaly-detection method the statistics surface offers, widest set: the robust modified z-score and Tukey's IQR fences (static or rolling), and multivariate Mahalanobis distance. A narrower site accepts a subset via `Extract<OutlierMethod, …>` rather than minting a fourth named alias.

type OutlierMethod = 'modifiedZScore' | 'iqr' | 'mahalanobis' | 'rollingModifiedZScore' | 'rollingIqr'

Paint

How an SVG shape's paths are painted: a stroked outline, or a solid fill.

type Paint = 'stroke' | 'fill'

PascalJoin

The handler prop name one event maps to, as a type: `'cell:changed'` becomes `'onCellChanged'`. Recursive over the `:` segments, so a three-part name like `'cell:edit:start'` becomes `'onCellEditStart'` - the same rule `handlerName` applies at runtime, stated once so the props type and the implementation cannot disagree.

type PascalJoin<E extends string> = E extends `${infer Head}:${infer Tail}` ? `${Capitalize<Head>}${PascalJoin<Tail>}` : Capitalize<E>

Declared in lattice-grid/modules/react.

PermissionLevel

The four corners of read × write. `writeOnly` is a secret: the column is present and editable, its value never shown, exported, copied or searched.

type PermissionLevel = 'hidden' | 'read' | 'writeOnly' | 'write'

PermissionPolicy

Who may read and write which columns, from the blunt answer to the precise one: one level for every column, a level per column id, a list of rules, a function asked once per column, or an object pairing a default with per-column overrides.

type PermissionPolicy = PermissionLevel | Record<string, PermissionLevel> | { field?: string; id?: string; permission: PermissionLevel }[] | ((column: ResolvedColumn, params: { colId: string; context?: unknown; grid?: unknown }) => PermissionLevel | undefined) | { default?: PermissionLevel; columns?: Record<string, PermissionLevel>; resolve?(column: ResolvedColumn, params: { colId: string; context?: unknown }): PermissionLevel | undefined; }

PivotGroupTotalsPlacement

Where a pivot's grand-total column group sits relative to the pivoted columns.

type PivotGroupTotalsPlacement = 'before' | 'after'

PresenceOperation

Which presence-transport call failed.

type PresenceOperation = 'subscribe' | 'publish'

Presentation

Where a card's pop-out child view appears.

type Presentation = 'drawer' | 'modal' | 'inline'

Declared in lattice-grid/modules/kanban.

PushdownClass

How a pushed-down aggregate's engine result relates to the grid's own kernel.

type PushdownClass = 'identical' | 'may-differ' | 'fallback'

QuickFilterMode

How the quick filter's text is matched against a cell.

type QuickFilterMode = 'contains' | 'words' | 'fuzzy' | 'regex'

RailActionName

The rail's built-in action names, plus `'-'` for a divider.

type RailActionName = 'undo' | 'redo' | 'pause' | 'restore' | 'maximise' | 'export' | 'excel' | 'clipboard' | 'print'

RateSource

A caller-supplied exchange-rate source. The grid ships and fetches no rates. Either a function `(from, to) => rate|null`, or a table of rates per unit of a common base (the base being whichever code maps to 1, or `rateBase`). A source that cannot answer returns `null`, which is surfaced loudly, never as zero.

type RateSource = ((from: string, to: string) => number | null) | Record<string, number>

RegressionMethod

A regression shadow's fitting method.

type RegressionMethod = 'ols' | 'wls' | 'robust' | 'quantile'

RejectedRowOperation

Which part of a rejected change a row was in.

type RejectedRowOperation = 'add' | 'update' | 'remove'

RejectedRowReason

Why a row in a change was rejected: an unknown key, or one already taken.

type RejectedRowReason = 'unknown-id' | 'duplicate-id'

RendererCtor

A renderer class. The grid instantiates one per cell element and reuses it as that element is recycled down the viewport.

type RendererCtor = new () => Renderer

RendererName

The built-in cell renderers, addressable by name through `cell.render`. Anything registered through `components` is also valid here.

type RendererName = 'area' | 'bullet' | 'checkbox' | 'colour' | 'column' | 'delta' | 'detailExpander' | 'donut' | 'gauge' | 'group' | 'icon' | 'image' | 'line' | 'link' | 'pie' | 'pill' | 'progress' | 'qrcode' | 'range' | 'rating' | 'skeleton' | 'stage' | 'stacked' | 'twoline' | 'winloss' | (string & {})

RenderFn

The short form of a renderer: a function handed the cell and returning the HTML string or the element to show. Reach for a `Renderer` class instead when the cell has to hold state or release something as it is recycled.

type RenderFn = (p: CellParams) => string | HTMLElement

ResolvedCapabilities

A capability set with every key present, as `capabilitiesOf` returns it. `operators` becomes a `Set` rather than staying an array: it is tested once per condition per query, and membership on an array is a scan. The declared form and the resolved form differ, which is why this is its own type.

type ResolvedCapabilities = Omit<Required<PushdownCapabilities>, 'operators' | 'mutate'> & { operators: ReadonlySet<string>; mutate: false | Required<MutateCapability>; }

Returning

What a server hands back after a successful mutation: the full row, just the key, or nothing.

type Returning = 'row' | 'key' | 'none'

RollingOutlierMethod

The rolling (windowed) anomaly methods alone, without the static ones.

type RollingOutlierMethod = 'rollingModifiedZScore' | 'rollingIqr'

RoutePredicate

What a route matches: a partition VALUE (the record is routed when `row[key] === value`), or a `fn(row)` predicate for a composite route. Declared as `unknown` because any value can be a partition key; the function form is the only one TypeScript can check.

type RoutePredicate = unknown

Declared in lattice-grid/modules/data-router.

RouterDateFieldFormat

The input format a `date` field reads: `'iso'` (the default - ISO 8601, a `Date`, or an epoch number), `'epoch-s'` (seconds since the epoch), `'epoch-ms'` (milliseconds), or an explicit pattern such as `'dd/MM/yyyy'`, parsed with the grid's own date-pattern token vocabulary.

type RouterDateFieldFormat = 'iso' | 'epoch-s' | 'epoch-ms' | string

Declared in lattice-grid/modules/data-router.

RouterEventName

The events a data router raises. Routing itself is reported to each attached viewer through its own `rows.apply`, not through an event here. `metrics` is the periodic observability timer, running only while at least one listener is registered so collection costs nothing until someone asks for it. `fields:changed` (v16) fires when a spread join's field set for a route changes.

type RouterEventName = 'metrics' | 'fields:changed'

Declared in lattice-grid/modules/data-router.

RouterFieldSpec

One entry of `addSource`'s `fields` option: a type name, or an options object. The object form narrows a `number`'s decimal separator (`decimal: ','`), gives a `boolean` its own true/false marker sets, chooses a `date`'s input `format`, and lists `nulls` - strings that mean null for this field, mapped before any coercion. A field with only `nulls` (no `type`) maps its null markers and passes every other value through untouched. A value that fails to coerce is stored as null and warns once per source+field (`router:coerce-failed`).

type RouterFieldSpec = RouterFieldType | { type?: RouterFieldType; format?: RouterDateFieldFormat; decimal?: ',' | '.'; true?: string[]; false?: string[]; nulls?: string[]; }

Declared in lattice-grid/modules/data-router.

RouterFieldType

The field types `addSource`'s `fields` option can coerce a raw value to: text, number (decimal comma and thousands separators), integer, boolean (configurable true/false sets), date (ISO, epoch s/ms or a small explicit pattern set) and json (parse a string).

type RouterFieldType = 'text' | 'number' | 'integer' | 'boolean' | 'date' | 'json'

Declared in lattice-grid/modules/data-router.

RouterJoinMissing

What a fan-in join does with a row while its match has not arrived.

type RouterJoinMissing = 'hold' | 'passthrough' | 'null'

Declared in lattice-grid/modules/data-router.

RouterKey

A property name, or a function reading the value off a row, returning a string or number. Composite (`string[]`) keys are core-grid-only: a route (or an alert, or a group) keys its own partition by one value, so there is nothing for an array to join into here.

type RouterKey = string | ((row: RouterRecord) => string | number)

Declared in lattice-grid/modules/data-router.

RouterParentDelete

What a parent's delete does to its children (v18,, on a COLLECT join, on an unnest, and standalone via `relateRows`. `'cascade'` deletes every child whose foreign key matches the deleted parent (recursively); `'orphan'` keeps them, marked `__orphan: true`, warned once; `'keep'` keeps them bare. The default for a collect join and `relateRows` is `'keep'` - the unchanged behaviour - while an unnest defaults to `'cascade'` (its unchanged behaviour already removes its embedded children).

type RouterParentDelete = 'cascade' | 'orphan' | 'keep'

Declared in lattice-grid/modules/data-router.

RouterRecord

A record routed through a data router: any object. Its partition comes from the router's `key` and its identity within a grid from `rowKey`.

type RouterRecord = Record<string, unknown>

Declared in lattice-grid/modules/data-router.

RouterSpreadType

The value types a SPREAD join's `type` map can coerce an attribute to.

type RouterSpreadType = 'number' | 'date' | 'boolean' | 'text'

Declared in lattice-grid/modules/data-router.

RouterWrite

A write captured off a writable route's grid, handed to `onWrite`.

type RouterWrite = Record<string, unknown>

Declared in lattice-grid/modules/data-router.

RouteSort

A route's `sort`: a comparator, or a key and direction (`'asc'` unless `'desc'`).

type RouteSort = ((a: RouterRecord, b: RouterRecord) => number) | { key: string; dir?: 'asc' | 'desc' }

Declared in lattice-grid/modules/data-router.

RouteWhere

A filter-wire condition for a route's `where` (v7): `{ col, op, value }`, or an `and` / `or` / `not` group of them.

type RouteWhere = Record<string, unknown>

Declared in lattice-grid/modules/data-router.

RowChangeKind

Whether a structural row op is an append or a delete.

type RowChangeKind = 'append' | 'delete'

RowFormMode

Whether `GridConfig.rowForm` opens as a side drawer or a centred dialog.

type RowFormMode = 'drawer' | 'dialog'

RowPin

Which sticky strip a row is pinned in, top or bottom.

type RowPin = 'top' | 'bottom'

RowScope

Which rows a column's positional shadow (a rank or similar) is computed against.

type RowScope = 'all' | 'filtered'

RowTransferMode

Whether a row dragged out of the grid via `rowTransfer` is moved or left in place.

type RowTransferMode = 'move' | 'copy'

RunningTotalMode

A running total's shape: a running sum, a running percentage, or a period-over-period delta.

type RunningTotalMode = 'total' | 'percent' | 'delta'

ScaleFrom

Where a colour or bar scale's bounds are derived from, when `min`/`max` are not given.

type ScaleFrom = 'minmax' | 'quantile' | 'stddev'

SchedulerEventFieldChanges

The field-level edit an event edit reports: each changed field's old and new value.

type SchedulerEventFieldChanges = Record<string, { from: unknown; to: unknown }>

Declared in lattice-grid/modules/scheduler.

SchedulerEventName

The event names a scheduler emits.

type SchedulerEventName = 'zoom:change' | 'change' | 'beforeEventChange' | 'eventChange:cancelled' | 'event:change'

Declared in lattice-grid/modules/scheduler.

SchedulerRow

A row backing a scheduler resource or event: any object. Its identity comes from `resourceKey`/`eventKey`.

type SchedulerRow = Record<string, unknown>

Declared in lattice-grid/modules/scheduler.

SchedulerZoom

A scheduler zoom level name (`'fit'` sizes px-per-day to the timeline width), or a bare pixels-per-day number.

type SchedulerZoom = 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'fit' | number

Declared in lattice-grid/modules/scheduler.

ScrollbarMode

How the grid's scroll viewport draws its scrollbars,. `auto` is the platform's native behaviour - overlay scrollbars fade away when idle. `always` keeps that native bar shown whether or not the pointer is over the grid, so the affordance never disappears on a touchpad or an overlay OS. `custom` replaces it with a bar the grid draws itself: the same size, colour and hit area in every browser, sized by the `--lattice-scrollbar-*` tokens, for a target bigger than the platform's own thin overlay ribbon.

type ScrollbarMode = 'auto' | 'always' | 'custom'

SelectionMode

What a grid's rows and cells may have selected, and whether it is one thing or several.

type SelectionMode = 'none' | 'single' | 'multiple'

SelectionPredicate

A row selection as a descriptor, from {@link SelectionApi.predicate}. `all: true` is a predicate selection: every row `filter` (and `quick`, when a quick search was active) matched at the moment of select-all, less the rows in `except`. The filter is the one captured then: a later filter change does not widen or narrow it. `all: false` is the ordinary key list.

type SelectionPredicate = { all: true; filter: FilterSet | null; quick?: string; except: string[]; } | { all: false; include: string[]; }

SelectionRelation

A cross-grid selection relation (v2,: a key map (target rows whose `to` value is among the selected source rows' `from` values - an IN set), or a function handed the selected source rows that returns a target-row predicate.

type SelectionRelation = { from: string; to: string } | ((selected: RouterRecord[]) => ((row: RouterRecord) => boolean))

Declared in lattice-grid/modules/data-router.

ShadowDecomposition

A seasonal decomposition's model: additive, or multiplicative.

type ShadowDecomposition = 'additive' | 'multiplicative'

ShadowKind

What a shadow column computes about a value the grid is tracking: how it has changed (updates, delta, rate, streak), when it last changed, where it sits among the other rows (rank, percentile, share of total), or how unusual it is. A shadow column sorts, filters, groups and exports like any other.

type ShadowKind = 'updates' | 'updatedAt' | 'sinceUpdate' | 'delta' | 'deltaPercent' | 'rate' | 'history' | 'firstValue' | 'streak' | 'rank' | 'rankAsc' | 'rankChange' | 'percentile' | 'quartile' | 'zScore' | 'shareOfTotal'

ShadowWithin

Whether a rolling shadow is computed per group, or across the whole dataset.

type ShadowWithin = 'group' | 'all'

ShellContent

Anything `attach()` mounts: a Lattice view, a DOM element, or an HTML string (converted once and reused).

type ShellContent = HTMLElement | string | ShellWidget

Declared in lattice-grid/modules/shell.

ShellEventName

The events a shell raises, on `shell.on()`,,,,. The shell's own, not a grid's: `grid.on` takes {@link EventName} and knows nothing about these. `on()` warns once on any other name, because a binding to an event that can never fire is a silent no-op. The cancellable `before*` events - `beforeCollapse`, `beforeExpand`, `beforeAddCell`, `beforeRemoveCell`, `beforeHide`, `beforeShow` and `beforeResizeStart` - run before the cell moves, on the same contract the grid core uses: call `preventDefault(reason?)` on the payload, or return `false`; a veto keeps the cell (or the two cells' sizes) unchanged. The past-tense events - `afterCollapse`, `afterExpand`, `afterAddCell`, `afterRemoveCell`, `afterHide`, `afterShow`, `resize`, `afterResizeEnd`, `tabChange` and `stateChange` - report a change already applied and carry no `preventDefault`.

type ShellEventName = 'beforeCollapse' | 'beforeExpand' | 'afterCollapse' | 'afterExpand' | 'beforeAddCell' | 'afterAddCell' | 'beforeRemoveCell' | 'afterRemoveCell' | 'beforeHide' | 'afterHide' | 'beforeShow' | 'afterShow' | 'tabChange' | 'stateChange' | 'beforeResizeStart' | 'resize' | 'afterResizeEnd'

Declared in lattice-grid/modules/shell.

ShellSize

A cell size: pixels as a number, or any CSS length string such as `'30%'`.

type ShellSize = number | string

Declared in lattice-grid/modules/shell.

ShellType

The separator between cells: thin lines, wide lines, an even gap, or none.

type ShellType = 'line' | 'wide' | 'space' | 'none'

Declared in lattice-grid/modules/shell.

ShowWhen

When a leaf column or a column group is shown, relative to an ancestor band's open state.

type ShowWhen = 'open' | 'closed' | 'always'

Side

The left or right side of a chart: a measure axis, or a combo measure's side.

type Side = 'left' | 'right'

SignificanceTest

Which two-sample significance test is used, or `auto` to pick by column family.

type SignificanceTest = 'auto' | 'welch' | 'mannWhitney' | 'chiSquare'

SlaAgeChipVisibility

Whether a card's age chip shows always, or only once it reaches warn or breach.

type SlaAgeChipVisibility = 'always' | 'threshold'

Declared in lattice-grid/modules/kanban.

SlaAgeingBasis

Where a card's ageing clock starts: in its current column, or since it arrived on the board.

type SlaAgeingBasis = 'column' | 'board'

Declared in lattice-grid/modules/kanban.

SmoothingMethod

An exponential-smoothing shadow's model: single smoothing, or Holt's level+trend.

type SmoothingMethod = 'ses' | 'holt'

SortDirection

A sort direction: ascending or descending.

type SortDirection = 'asc' | 'desc'

SourceConfig

Where a grid's rows come from: an array held in memory, a paged endpoint, a remote query, a live stream, or rows derived from another grid. The `type` field picks which, and the rest of the object is that source's own options.

type SourceConfig = MemorySourceConfig | PagedSourceConfig | RemoteSourceConfig | StreamSourceConfig | DerivedSourceConfig

SourceMode

Which kind of data source a grid is bound to.

type SourceMode = 'memory' | 'paged' | 'remote' | 'stream'

SpatialBbox

A box in degrees, `[minLon, minLat, maxLon, maxLat]`: the operand of `withinBbox`.

type SpatialBbox = [number, number, number, number]

SpatialOperator

The four operators of a `geometry` column (declared by the type the opt-in `modules/geometry` registers), evaluated in memory for any source that does not push them down. A `geometry` column accepts these and `blank`/`notBlank` only, and these are refused on any other column. - `withinBbox` - the whole geometry lies inside a {@link SpatialBbox}. - `withinPolygon` - a Point or MultiPoint lies inside a Polygon or MultiPolygon operand (holes excluded); any other geometry is tested by its centroid. - `intersects` - the two share a point: a bounding-box test, then an edge test with edges straight in longitude/latitude rather than great circles. The operand is a geometry or a {@link SpatialBbox}. - `withinDistance` - the centroid is within a {@link SpatialDistance}, by great-circle (haversine) distance. The antimeridian is not handled: a box whose west edge is east of its east edge is refused; split it into two conditions joined by `or`.

type SpatialOperator = 'withinBbox' | 'withinPolygon' | 'intersects' | 'withinDistance'

SpcStatistic

Which statistic a confidence interval reads: a mean, or a proportion.

type SpcStatistic = 'mean' | 'proportion'

SpecStatus

The three verdicts a `specStatus` shadow can report.

type SpecStatus = 'PASS' | 'WARN' | 'FAIL'

StateChangeCause

What caused a `state:changed`. `'user'` is a change to one part of the view - a sort, a filter, a column moved, resized, pinned or hidden, a grouping, a page - whether it arrived as a gesture or as the equivalent API call. `'apply'` is `state.apply()`, including the restore an undo performs and a `config.state` seed at construction. `'reset'` is `state.reset()`, and is the one a persistence layer skips: saving the reset arrangement writes the default straight back over the view the user had just abandoned.

type StateChangeCause = 'user' | 'apply' | 'reset'

StateSection

Every top-level section of a {@link GridState} bar `version` - the vocabulary `state.apply`'s `skip` list, `StateApplyReport.applied` and `StateChangedEvent.sections` all speak, derived from `GridState` itself so a new section cannot appear in one and be missing from the others.

type StateSection = Exclude<keyof GridState, 'version'>

StatFollowScope

Which of a grid's rows feed a KPI stat's value.

type StatFollowScope = 'filtered' | 'all' | 'selected'

StatGoodDirection

Whether a rise in a KPI stat's value counts as good news.

type StatGoodDirection = 'up' | 'down' | 'neither'

TabsEventName

The events a tabbed grid raises. The strip's own, not a grid's: `grid.on` takes {@link EventName} and knows nothing about these, and each tab's grid keeps raising its own events itself. `on()` warns once on any other name, because a binding to an event that can never fire is a silent no-op. Each event also has a config callback (`onBeforeTabChange`, `onTabChange`, `onTabChangeCancelled`); both routes fire. Only `beforeTabChange` is cancellable - it is the one that runs before anything moves. `tab:changed` and `tabChange:cancelled` report a decision already taken and carry no `preventDefault`.

type TabsEventName = 'beforeTabChange' | 'tab:changed' | 'tabChange:cancelled'

Declared in lattice-grid/modules/tabs.

TargetSize

Whether interactive targets are sized for a fine pointer or raised for touch.

type TargetSize = 'default' | 'large'

TestSelection

Whether a two-sample test was chosen automatically, or forced by the caller.

type TestSelection = 'auto' | 'override'

TextTransform

A locale-aware case change for text display: upper, lower, title, or none.

type TextTransform = 'none' | 'upper' | 'lower' | 'title'

Theme

A shipped theme, or your own name, the value is written to `data-theme` on the grid's root, so `.lattice[data-theme="mine"]` is all a custom one needs. One switch reaches every module: `data-theme="dark"` on any ancestor (a layout's root, or `<html>`) darkens the grid, the layout chrome, charts, KPI tiles, tabs, kanban and gantt together. The nearest `data-theme` wins, so `'light'` here forces a light grid inside a dark page. `'auto'` follows the viewer's `prefers-color-scheme`. Unset writes no attribute: the grid follows the nearest themed ancestor, and is light when there is none.

type Theme = 'light' | 'dark' | 'auto' | 'high-contrast' | 'terminal' | (string & {})

ThresholdLevel

An SLA threshold classification: on time, past the warn threshold, or past the breach one.

type ThresholdLevel = 'ok' | 'warn' | 'breach'

Declared in lattice-grid/modules/kanban.

TimeStyle

A locale-chosen time form, mirroring `Intl.DateTimeFormatOptions.timeStyle`.

type TimeStyle = 'short' | 'medium' | 'long'

ToolPanelName

The built-in tool panels, addressable by name from configuration.

type ToolPanelName = 'columns' | 'filters' | 'views' | 'quick' | 'formatting' | (string & {})

ToolPanelSide

Which edge a docked tool panel sits against.

type ToolPanelSide = 'left' | 'right'

TotalFn

Your own aggregation: handed every value in the group, plus the row the total is being computed for and the grid it belongs to, and returning the value to show.

type TotalFn = (values: unknown[], ctx: { row: Row; column: Column; grid: Grid; context: unknown }) => unknown

TotalName

The built-in aggregations, used for group totals, the footer row and pivot values. `countValues` counts the non-blank ones; `first` and `last` take the value at the ends of the group in its current order. Anything registered as a custom total is also valid here.

type TotalName = 'sum' | 'min' | 'max' | 'avg' | 'count' | 'first' | 'last' | 'countValues' | (string & {})

TraceMissingReason

The named reasons `trace.missing()` can report a row dropped for (v19,.

type TraceMissingReason = 'predicate-false' | 'filter-rejected' | 'join-no-partner' | 'deduped-stale-seq' | 'removed-by-cascade' | 'coerced-invalid-key' | 'not-yet-flushed' | 'unrouted'

Declared in lattice-grid/modules/data-router.

TraceStep

One step of a traced row's path (v19,: the shape varies by `kind`, mirroring the pipeline stage `explain()` already counts in aggregate - this is the same accounting, kept per row instead of summed.

type TraceStep = { kind: 'fields'; changes: { field: string; before: unknown; after: unknown }[] } | { kind: 'unnest'; parentKey: unknown } | { kind: 'join'; from: string; matchedKey: unknown; matched: boolean } | { kind: 'collect'; from: string; matchedKey: unknown; matched: boolean } | { kind: 'relate'; parentKey: unknown; matchedKey: unknown } | { kind: 'rollup'; groupKey: unknown; memberCount: number } | { kind: 'spread'; origin: string } | { kind: 'cascade'; origin: string } | { kind: 'filter'; passed: boolean } | { kind: 'sort'; passed: true } | { kind: 'transform'; passed: true } | { kind: 'route'; label: string | null; op: 'add' | 'update'; seq: number | undefined }

Declared in lattice-grid/modules/data-router.

TypeName

What kind of value a column holds, which is what decides how it is parsed, sorted, filtered, aligned and formatted before you configure anything else. The first few are inferred from the data. Everything after them is asked for by name on the column, because a number is a number until you say it is a bitrate, a decibel, an IPv4 address or a duration.

type TypeName = 'text' | 'number' | 'boolean' | 'date' | 'dateString' | 'object' | 'lookup' | 'image'

UnitSymbolPlacement

Whether a unit's symbol is written before the number or after it.

type UnitSymbolPlacement = 'suffix' | 'prefix'

Unsubscribe

What a subscription hands back: call it to stop listening, without having to keep hold of the handler for an `off()`.

type Unsubscribe = () => void

UpdateKind

Which mutation a `MutationOp` carries: an insert, a patch, or a delete.

type UpdateKind = 'append' | 'update' | 'delete'

UpdatesFlushMode

When a queued update batch applies: on a paint boundary, at end of task, on the coalescing window, or only when asked.

type UpdatesFlushMode = 'frame' | 'microtask' | 'interval' | 'manual'

UpdateState

Whether an outstanding write or row op is still the live one, or was superseded.

type UpdateState = 'pending' | 'superseded'

UrlSourceFormat

A URL source's file format: a whole JSON document, or newline-delimited JSON.

type UrlSourceFormat = 'json' | 'ndjson'

VAlign

Vertical alignment of a cell's content within its row. The vertical counterpart to {@link Align}. `top` sits the content at the top of the row, `middle` centres it and `bottom` drops it to the bottom. It is most visible on tall or `autoHeight` rows, where a wrapped-text column can be `top` while its single-line neighbours are `middle`.

type VAlign = 'top' | 'middle' | 'bottom'

VariantName

The colour role a decoration takes, named by meaning rather than by hue so that a theme restyles every grid at once. `none` draws no decoration at all, and your own name is accepted for a variant you have defined through `variants`.

type VariantName = 'neutral' | 'info' | 'success' | 'warning' | 'danger' | 'accent' | 'none' | (string & {})

VariantSpec

Which variant a cell takes, from the simplest answer to the most conditional: one name for the whole column, a lookup keyed on the cell's value, a list of rules tried in order, or a function of the cell.

type VariantSpec = VariantName | { map: Record<string, VariantName>; default?: VariantName } | { when: VariantWhen[]; default?: VariantName } | ((p: CellParams) => VariantName)

ViewChangeReason

What happened to a saved view, or the whole set.

type ViewChangeReason = 'save' | 'update' | 'rename' | 'remove' | 'default' | 'import' | 'seed' | 'replace'

ViewConflictPolicy

What an imported view named the same as an existing one does: keep both, overwrite, or skip.

type ViewConflictPolicy = 'rename' | 'overwrite' | 'skip'

ViewerKind

Every viewer a framework adapter's generic `createLatticeViewer`/`bindViewer` helper can bind to. The widest set across React, Vue and Svelte; a helper that supports fewer of them still takes this type; the ones it cannot actually build fail at the call, not at the type.

type ViewerKind = 'kpi' | 'kanban' | 'calendar' | 'tabs' | 'chart' | 'gantt' | 'layout' | 'router' | 'form'

ViewerOrigin

Who asked for a viewer-chrome change - a tab switch, a layout window moved or closed - narrower than {@link EventOrigin} because these are always either a direct interaction or an API call, never the grid's own startup or an AI write.

type ViewerOrigin = 'api' | 'user'

ViewPresentation

Which responsive layout the grid's body is rendered as: cards, or a table.

type ViewPresentation = 'cards' | 'table'

WindowedFn

A named aggregate a windowed reduction can return.

type WindowedFn = 'sum' | 'avg' | 'mean' | 'min' | 'max' | 'count' | 'variance' | 'stddev'

WindowKind

How a rolling shadow's window is measured: a row count, a time span, or the whole session.

type WindowKind = 'count' | 'time' | 'session'