MAIDR JavaScript API
    Preparing search index...

    Class WaterfallTrace

    Trace implementation for waterfall charts — a starting value carried to an ending value through a sequence of signed contributions.

    The chart draws each step as a bar floating between the running total before it and the running total after it, which means a step carries two numbers a bar chart would conflate: the contribution (the bar's height) and the total it produced (the bar's position). Announcing only one of them answers half the question the chart was drawn for — "how big was marketing's effect" and "where did that leave us" are different questions, and a reader needs both.

    So the contribution is what is heard and what cross announces, and the running total travels alongside it in stack. Pitching the contribution rather than the total is the deliberate choice: the totals of a waterfall drift within a narrow band around the running value, so scaling pitch to them compresses every step into a near-identical tone, while the deltas span the full signed range and make the large contributors audible immediately — which is what a waterfall is read to find.

    Navigation is one column per step, as with a bar chart. The steps are a sequence rather than a grid: there is no second dimension to move in.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    observers: Observer<TraceState>[]
    isWarning: boolean
    isComputingStateAt: boolean

    True while AbstractTrace.getStateAt computes state at a temporarily moved cursor. Enforces (structurally, not just by documentation) that state getters never notify observers.

    id: string
    type: TraceType
    title: string
    name: string | undefined

    What this layer is, when the producer named it. See MaidrLayer.name.

    layer: MaidrLayer
    supportsExtrema: true

    Abstract property that subclasses must implement to indicate extrema support

    movable: Movable
    highlightValues: SVGElement[][] | null

    highlightValues[row][col], or null for the whole trace when it highlights nothing.

    A single cell may also be null, meaning the chart drew no element there. That is a narrower claim than the trace-wide null: the rest of the grid still highlights, and only this position falls back to the out-of-bounds state. A Google Charts calendar is the case it exists for -- its first and last columns are ragged, so a handful of grid positions have no rect at all while every other day does (#1174).

    Accessors

    • get isInitialEntry(): boolean

      Returns boolean

    • set isInitialEntry(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get row(): number

      Returns number

    • set row(value: number): void

      Parameters

      • value: number

      Returns void

    • get col(): number

      Returns number

    • set col(value: number): void

      Parameters

      • value: number

      Returns void

    • get categoriesRunDown(): boolean

      Whether this trace's grid lists its categories as columns while the chart draws them one above another: a horizontal bar, dot, lollipop, funnel, dumbbell or forest chart. Its arrow keys are then turned to follow the drawing (keyDirection), as a horizontal box plot's already were: Up and Down move between the categories, and Left and Right along one, between the series, ends or sections drawn across it.

      Returns boolean

      False here; true on the traces of that shape drawn on their side

    • get xAxis(): string

      The x axis's name, falling back to a generic one the layer authored none.

      A getter rather than a field set in the constructor: the fallback is a translated word, and a trace outlives a language change — a name resolved once at construction would keep the language the chart was built in.

      Returns string

    • get yAxis(): string

      The y axis's name, or a generic one. See xAxis.

      Returns string

    • get z(): string

      The z axis's name, or a generic one. See xAxis.

      Returns string

    • get isEmptyAtCursor(): boolean

      Whether the cursor has no point to report.

      Read from dimension rather than from any one trace's data, because that is the one shape every trace already answers in. It is also evaluated at the cursor — LineTrace returns the current series' length as cols — so this covers a ragged layer, where one series has points and another has none, and not only a layer that is empty throughout.

      Returns boolean

      True when there is nothing at (row, col) to describe

    • get state(): TraceState

      Gets the current state of the trace including audio, braille, text, and highlight information.

      Returns TraceState

      The current TraceState

    • get outOfBoundsState(): TraceEmptyState

      The state pushed to observers when navigation leaves the data.

      Declared as TraceEmptyState rather than the whole TraceState union because that is what every implementation actually returns — the accessor exists so AbstractPlot.notifyOutOfBounds has an empty state to push. Narrowing it here is what lets the braille and highlight callers hand the value straight on: those states accept the empty trace shape but not a populated one, so a wider declaration would force each of them to cast, and a cast is exactly what stops the compiler from noticing if an override ever starts returning a populated state.

      Returns TraceEmptyState

      The empty trace state, positioned for out-of-bounds audio panning.

    • get hasMultiPoints(): boolean

      Returns boolean

    • get layerLabel(): string

      How this layer names itself in the description dialog's layer tabs.

      The producer's name when there is one, and the chart-type label otherwise — the same fallback order TextService.layerIdentity uses for the spoken layer-switch announcement, so a tab and the announcement single out the same layer by the same name. The two differ only in register: the announcement says "point plot" where the dialog says "Scatter Plot", because that written form is what the dialog's own Chart Type line has always shown and a tab sitting above it should agree with it.

      Returns string

    • get placeAxisLabel(): string

      Returns string

      Trace.placeAxisLabel

    • get guide(): ChartGuide | undefined

      A plain-language introduction to this layer's chart type, for the description dialog. See chartGuide.

      A layer that names its own chart type never gets the trace type's: that guide explains the type the chart is read as, which is not what the chart is, and a gantt's tasks, dates and project plans said of a packet's bit fields are false. It gets the guide to the diagram it names (MaidrLayer.diagramType), or the one it gives to its own chart (MaidrLayer.typeGuide), or none.

      Returns ChartGuide | undefined

    • get orientationLabel(): string | undefined

      Which way this chart is drawn, or undefined for a type that has no orientation to speak of.

      Entering the chart already announces it -- "This is a maidr plot of type: horizontal bar" -- but the description dialog said only "Chart Type: Bar Chart", and for the box, violin and boxen families the orientation also silently reverses the order of the rows in the table underneath, because their constructors reverse the groups when the chart is horizontal. A reader comparing the table with what they walked had no way to know why the two disagreed.

      Exposed here, and read once by the description service, rather than pushed as a stat by each of the thirty-odd traces that has one. Named apart from the bar and distribution families' own orientation fields, which hold the declared* value and default it to vertical for every type -- including the ones that have no orientation at all.

      Returns string | undefined

      horizontal or vertical, or undefined when the type has no orientation to report.

    • get valueSpan(): number

      How far the layer's measured values spread: its largest less its smallest, or 0 with fewer than two. The scale at which [, ] and the Go To dialog read two values as one extreme (MathUtil.nearlyEqualInRange).

      Read from values, the numbers the layer is sounded and brailled from; a trace whose extrema rank something else says so by overriding it.

      Returns number

      The span, never negative

    • get traceType(): TraceType

      The trace's chart type. Lightweight alternative to reading state.traceType, which eagerly computes the full audio/braille/text/ highlight state just to expose this one string.

      Returns TraceType

    • get level(): "trace"

      Returns "trace"

      Trace.level

    Methods

    • Runs action with this element's observers muted.

      A cursor move normally is the announcement -- moveToIndex notifies, and everything downstream of it speaks, brailles and highlights. That is wrong for a move the reader did not make and is not waiting to hear: the description dialog's layer tabs relocate the reader in the chart while the modal is open, and the trace's announcement would land in the same live region the dialog is using, so one of the two is dropped. The caller announces afterwards, once, when the reader is back on the chart.

      Nesting is safe and the flag is restored on every path, including a throw, because a flag left raised would silence the chart for good.

      Parameters

      • action: () => void

        The moves to make in silence

      Returns void

    • Gets safe row and column indices to prevent accessing undefined values

      Returns { row: number; col: number }

      Object with safe row and column indices

    • Parameters

      • a: number

        Utility function to compare point values for rotor functionality

      • b: number
      • type: "lower" | "higher"

      Returns boolean

      boolean value

    • Rotor compare search along one row of numeric values.

      Steps from the current column in the given direction and moves to the first value that satisfies the comparison; reports the rotor boundary when nothing further qualifies. For the traces whose values are a plain numeric grid indexed [row][col]; a trace with a richer layout (the bar's orientation-normalised rows, the candlestick's segments) keeps its own.

      Parameters

      • rowValues: readonly number[]

        The values of the row being searched

      • direction: "left" | "right"

        Which way to search

      • type: "lower" | "higher"

        Whether a lower or a higher value is sought

      Returns boolean

      True when a matching value was found and moved to

    • Whether the rotor offers its lower and higher value modes on this trace.

      Exactly when the trace overrides moveToNextCompareValue. The base search is a no-op that reports a boundary, so offering the modes without one told a reader "No lower value found" with a lower value beside them, or said nothing at all; tying the offer to the search keeps the two from drifting apart again. A subclass can still override this to withhold the modes (scatter, whose arrows walk points rather than values), and a trace that compares only through the rotor's arrow methods must override it to offer them.

      Returns boolean

    • Returns the display name for the default data navigation mode. Override to provide a trace-specific name (e.g., "ROW AND COLUMN NAVIGATION" for scatter).

      Returns string

    • The rotor's lower and higher value search, Up: on a chart drawn on its side, along the categories toward the one drawn above, as Up moves. Elsewhere the rotor reads Up as Right.

      Parameters

      • Optionalmode: "lower" | "higher"

        Whether a lower or a higher value is sought

      Returns boolean

      Whether the cursor moved

    • The rotor's search, Down: toward the category drawn below. See moveUpRotor.

      Parameters

      • Optionalmode: "lower" | "higher"

        Whether a lower or a higher value is sought

      Returns boolean

      Whether the cursor moved

    • The rotor, Left: on a chart drawn on its side, the plain move along the category, as a horizontal box plot's rotor moves along its box. The search runs along the categories, which Up and Down walk there.

      Parameters

      • Optionalmode: "lower" | "higher"

        Whether a lower or a higher value is sought

      Returns boolean

      Whether the cursor moved. False at the end of the category -- on a chart of one series, always -- so the rotor says there is nothing further that way; it reported true, and the rotor said nothing.

    • The rotor, Right. See moveLeftRotor.

      Parameters

      • Optionalmode: "lower" | "higher"

        Whether a lower or a higher value is sought

      Returns boolean

      Whether the cursor moved, false at the end of the category

    • The direction to move the grid for a key, which is the key's own except on a trace whose categories run down the page. There the grid's columns are drawn one above another and its rows across them, so Up and Down step the columns, toward the category drawn above or below, and Right and Left step the rows. On a horizontal bar chart Right and Left moved down and up the page between the bars, and Up and Down said there was no more data: the other way round from a horizontal box plot or violin.

      Parameters

      Returns MovableDirection

      The direction to move the grid in

    • Whether the first category is drawn above the last.

      Producers list a horizontal chart's categories both ways: matplotlib, ggplot2, base R and Plotly draw the first at the bottom, and Highcharts, ApexCharts, Vega-Lite, seaborn and most hand-drawn charts at the top. So it is measured, as a Gantt chart measures its lanes, from the marks the highlight holds: in the first row that has two, the first category's mark is above the last one's, or below it. Measured on every vertical key, an autoplay step included, rather than once. That is two boxes a key, however many categories the chart has: the two marks are found from the ends of the row, and the read forces at most the layout the highlight's move would cause before the next paint. An answer kept from the first key was kept from a chart not yet laid out, or one since re-rendered the other way round, and a cache would have to be cleared on every redraw and resize to avoid that.

      Where nothing can be measured now, the last measurement holds, so a chart hidden for a moment does not turn the keys round under the reader. Where nothing has ever been measured -- a chart drawn to a canvas, one with no highlight, one not laid out yet, or one category -- the layer's MaidrLayer.firstCategory says where the first is drawn. Without it, the first is taken to be at the bottom, as row 0 of a grid is, and Up moves to the next.

      Returns boolean

      True when the first category is drawn at the top

    • The format the layer's author declared for an axis, or null when they declared none.

      For a number the description states rather than tabulates. The table reads each column through the axis's declared format, and so does every announcement, but a stat printed the raw number: a margin drawn as a percentage was "Min value: 0.12" over a table and a cursor saying 12%. Null rather than the default format when nothing was declared, so a chart nobody formatted reads as it did, which is the rule the table follows.

      Taken from FormatUtil.axisFormat, as the announcements and the table take theirs, so a histogram's bin edges read with the same decimals in all three.

      Parameters

      • axis: AxisType

        The axis whose format to read

      Returns FormatFunction | null

      The format, or null when the layer declared none

    • Cleans up trace resources including values and highlighted SVG elements.

      Only removes elements MAIDR created (hidden clones, synthetic markers); traces that highlight the chart's original live elements in place (e.g. heatmap cells, line dots) merely drop their references so the visible chart geometry survives focusout and live-data rebuilds.

      Returns void

    • Get all highlight SVG elements for this trace Used by HighlightService for high contrast mode

      Returns SVGElement[]

      Array of all SVG elements, or empty array if none

    • The chart's own element a marker this trace drew stands for, where the trace marks a point with a dot of its own rather than with a copy of the mark. None by default.

      Parameters

      • _marker: SVGElement

        A marker in this trace's highlight values

      Returns SVGElement | null

      The element the marker stands for, or null

    • Get all original (visible) SVG elements for this trace. These are the actual rendered elements, not the hidden clones used for highlighting. Used by HighlightService for high contrast mode color changes.

      Returns SVGElement[]

      Array of all original SVG elements, or empty array if none

    • Computes the trace state at an arbitrary position without moving the user's cursor or notifying observers. Used by monitor mode to sonify and announce a newly appended point while the user stays put.

      The state getters read this.row/this.col internally, so the cursor is moved temporarily and always restored in a finally block — this method is the single owner of that pattern.

      Re-entrancy hazard: this is only safe because the entire call chain is synchronous (no await points), so timers (e.g. autoplay ticks) cannot interleave before the finally-restore, and state getters never notify observers. If a getter ever becomes async or triggers notifications, callers could observe the temporary cursor.

      Parameters

      • row: number

        The row of the position to compute state for

      • col: number

        The column of the position to compute state for

      Returns TraceState

      The trace state at the requested position

    • Returns a human-readable label for this trace's chart type (e.g., 'Bar Chart', 'Scatter Plot') for display in the description modal. Falls back to the raw layer type if no mapping is registered.

      Returns string

    • What the entry instruction calls this chart: the name the layer gives its own chart type (MaidrLayer.diagramType or MaidrLayer.typeLabel), or the trace's word.

      A trace that names itself -- a line "single line" or "multiline", a radar "polar area" -- passes its word through here, so a layer that names its chart type is called by that name whichever trace reads it, and the instruction a reader hears once in the chart says what the one built from the layer before it said.

      Parameters

      • own: string

        The trace's word for its type

      Returns string

      The word the instruction uses

    • Builds the axes object for the description state, carrying only the axes the layer actually authored a label for. Subclasses should call this instead of constructing the axes object inline so charts without a real z dimension don't surface the placeholder default.

      Every axis is gated, not just z. xAxis and yAxis fall back to the literal 'X' and 'Y' when the JSON authors no label -- legal, and common in adapter-generated specs -- and the dialog rendered that as "X: X", a line that says nothing twice. The figure-level branch of the description already showed only authored labels (DescriptionService.getFigureAxes), so gating here is what makes the two levels of the same dialog follow one rule.

      Blankness is tested with trim(), the same rule named applies when it decides whether to substitute the fallback in the first place. A whitespace-only z label is truthy but blank, so the untrimmed guard used to pass it through and then print the 'Level' placeholder the guard existed to keep out.

      Returns { x?: string; y?: string; z?: string }

    • Whether the cursor stands on an extremum target, for a trace whose cursor its row and column do not hold: a scatter plot in point navigation keeps a point's index instead. Null leaves the answer to the row and column, which is how every other trace's cursor is read.

      Parameters

      Returns boolean | null

      True or false where the trace keeps its cursor elsewhere, and otherwise null

    • Returns true if this trace supports intersection navigation mode. Opt-in per trace type: override to return true (possibly conditionally, e.g. based on data shape) for trace types that expose point intersections between series. Intersection navigation is a trace-level capability — it has no meaning at the figure or subplot level, which is why it lives on AbstractTrace rather than AbstractPlot.

      Returns boolean

    • Returns true if this trace supports point-by-point navigation mode. Opt-in per trace type: override to return true for traces that expose individual data points navigable in reading order (left/right) and column-major order (up/down). Currently only ScatterTrace.

      Returns boolean

    • Notifies the trace that the rotor is entering or leaving INTERSECTION_MODE. Default is a no-op; line-style traces don't need to track mode state because their state output is unchanged by the rotor mode. Traces whose audio/text output differs in intersection mode (e.g. ScatterTrace, which normally plays the whole x-column as a chord and must instead focus a single point) override this to flip an internal flag.

      Parameters

      • _enabled: boolean

        True when entering intersection mode, false when leaving.

      Returns void

    • Trace-specific rotor filter units appended to the rotor cycle after the built-in data/compare/grid/intersection modes. Each unit restricts navigation to points matching a predicate (e.g. only bullish candles). Default: none. Override to opt in (e.g. Candlestick exposes bullish/bearish/neutral units). The returned list is treated as read-only by the rotor service.

      Returns readonly RotorFilterUnit[]

    • Notifies the trace which of its getRotorFilterUnits the rotor is on, or null when it is on none of them. Default is a no-op: a unit usually changes only where Left and Right go, which moveToRotorFilter answers. A trace whose unit also changes what Control with them should reach -- a tree's Level, where Left and Right walk the whole level -- overrides this, because the jump is not routed through the rotor.

      Parameters

      Returns void

    • Moves within an active rotor filter unit along the filtered axis.

      Called by RotorNavigationService when the current rotor mode is one of this trace's getRotorFilterUnits. Filter units navigate a single axis, so only left/right are dispatched here — the service announces up/down as unavailable without calling the model (matching intersection mode). Implementations should move to the nearest point matching the unit identified by key and notify observers, returning true; when no such point exists they should call notifyRotorBounds and return false.

      Default is a no-op that reports bounds, so a trace advertising a filter unit but forgetting to implement movement fails safe (announces "no point found") rather than moving unexpectedly.

      Parameters

      • _key: string

        The RotorFilterUnit.key of the active unit

      • _direction: "left" | "right"

        The direction to search

      Returns boolean

      True if the cursor moved, false otherwise

    • Every object the o list offers on this chart, or null where there is none to offer.

      Null for every chart walked along x and y axes: the arrows already reach each point in order there, and a list of them would repeat the axis. A chart whose objects have no such order -- the nodes of a network, the tiles of a treemap -- overrides this and builds the list from its own structure, with the sorts and filters that make sense for it.

      List only, as the rotor units are, with no flag beside it: a flag that said yes over an empty list would open a dialog with nothing to choose. Labels are built on each call, because the trace outlives a change of language; anything expensive to compute is kept by the trace that computes it.

      Returns ChartObjectList | null

      The list, or null

    • Moves to the object the list knows by this key, announcing it through the usual observer chain.

      Looks the key up in a list built now rather than trusting a cell the dialog was handed when it opened, so a chart whose data changed under the dialog moves the reader to the object they chose or nowhere at all.

      Parameters

      • key: string

        The key the object list gave the object

      Returns boolean

      True when the cursor moved, false when no object has the key or its cell cannot be reached

    • Why this layer has no extremum for [, ] and G to go to, where that is by design: what the layer lacks, as a phrase in the reader's language, which the refusal says after it says there is nothing to go to. Null where the layer has extrema, or has none only because of its data.

      Asked with the extreme a bracket key wants, a layer that has one of the two by design and not the other can say why for the one it lacks, as a ROC curve does for [. G, which lists both, asks without one.

      Parameters

      • Optional_extreme: "min" | "max"

        The extreme [ ('min') or ] ('max') asked for, or nothing for the layer as a whole

      Returns string | null

      The reason, or null

    • Whether a mark of this trace sits at exactly this X, as moveToXValue finds one before it falls back to the nearest.

      A layer switch asks this to choose between the two X values a position can offer (see Trace.getAlternateXValue). Reads the x of each point; a trace that keeps its X some other way answers false unless it says otherwise, and the switch then carries what it always carried.

      Parameters

      • xValue: XValue

        The X a layer switch would carry

      Returns boolean

      True when some point's x is exactly xValue

    • How this layer's x axis writes an x: through the format the layer declares for it, or null where it declares none.

      A layer switch carries a number this way to a layer that holds the same place as text (see Subplot.carriedXValue).

      Parameters

      • xValue: XValue

        An x of this layer's

      Returns string | null

      Its reading, or null

    • The x of this layer's that its axis writes as reading: the first in the order the points are held, or null where the layer declares no x format or none of its x reads that way.

      A layer switch carries text this way to a layer that holds the same place as a number its axis formats (see Subplot.carriedXValue).

      Parameters

      • reading: string

        The text another layer holds the place as

      Returns XValue | null

      The x, or null

    • Moves the active point to the pointer location and returns directional guidance toward the nearest data geometry in a single call.

      Combining both operations avoids running findNearestPoint twice per pointermove event — important on dense plots where the scan is the hot path.

      Parameters

      • x: number

        Screen-space x position of the pointer/finger

      • y: number

        Screen-space y position of the pointer/finger

      Returns PointerGuidanceState | null

      Guidance state relative to nearest point, or null when unavailable

    • Moves the trace to the nearest point when the pointer is within its bounds and the trace is not already focused on that point.

      onCurve is intentionally non-optional: the caller has already paid the cost of isPointInBounds to assemble guidance state, and forcing subclasses to accept the value makes the contract explicit so a future override cannot silently recompute (or worse, ignore) it.

      Subclasses override this to customise hover-driven navigation:

      • Box / ViolinBox no-op the move while still surfacing guidance.
      • Scatter switches into column navigation mode before delegating.

      Parameters

      Returns void

    • Checks if the specified coordinates are within bounds of the element.

      Parameters

      • x: number

        The x-coordinate

      • y: number

        The y-coordinate

      • element: NearestPoint

        Object containing the SVG element and its position

        • element: SVGElement
        • row: number
        • col: number
        • centerX: number
        • centerY: number

      Returns boolean

      True if the point is in bounds, false otherwise

    • The step under the cursor. points is a flat list, which the inherited reading -- built for one list per row -- cannot index, and a trace that answers no x is offered rotor compare modes that then do nothing and cannot keep the reader's category across a layer switch.

      Returns XValue | null

      The current step's x

    • The rotor's LOWER and HIGHER VALUE search. The base is a no-op that reports the boundary: a trace that can compare overrides it, and supportsCompareMode offers the two modes exactly where it does.

      Parameters

      • direction: "left" | "right"
      • type: "lower" | "higher"

      Returns boolean

    • Offers the biggest mover in each direction as an extrema target.

      "What drove the change" is the question a waterfall is read to answer, and finding it by ear otherwise means walking every step and holding the running maximum in your head.

      Totals are excluded. The opening and closing bars carry the largest magnitudes on most charts — they restate the whole running value — so including them would make "largest increase" mean "the closing balance" on nearly every waterfall and bury the answer the reader wanted. Same exclusion as the Largest contribution description stat, for the same reason.

      Returns ExtremaTarget[]

      The largest increase and the largest decrease, when the chart draws any step that moves the total

    • Finds the step whose bar contains a pointer position.

      Hit-tests the bounding box rather than resolving to the nearest centre, matching BarTrace: a waterfall step is an area mark, and a bar floating far up the value axis can have its centre closer to the pointer than the bar the pointer is actually inside.

      Parameters

      • x: number

        Viewport x of the pointer

      • y: number

        Viewport y of the pointer

      Returns NearestPoint | null

      The step under the pointer, or null when it is between bars