Creates a new funnel trace.
The MAIDR layer carrying the stages
Protected ReadonlyobserversProtectedisProtectedisTrue while AbstractTrace.getStateAt computes state at a temporarily moved cursor. Enforces (structurally, not just by documentation) that state getters never notify observers.
Protected ReadonlyidProtected ReadonlytypeProtected ReadonlytitleProtected ReadonlynameWhat this layer is, when the producer named it. See MaidrLayer.name.
Protected ReadonlyxProtected ReadonlyyProtected ReadonlyzProtected ReadonlynavigationProtected ReadonlylayerProtected ReadonlymovableProtected ReadonlypointsProtected ReadonlybarProtected ReadonlyhighlightProtected ReadonlyorientationProtected ReadonlyminProtected ReadonlymaxProtected ReadonlysupportsAbstract property that subclasses must implement to indicate extrema support
ProtectedisWhether 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.
True when there is nothing at (row, col) to describe
ProtectedoutThe 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.
The empty trace state, positioned for out-of-bounds audio panning.
ProtectedhighlightProtectedautoplayProtectedhasThe 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.
ProtectedbrailleProtecteddimensionProtectedvaluesProtectedaudioProtectedtextGets the description state for the bar plot trace.
The description state containing chart metadata and data table
Gets the current state of the trace including audio, braille, text, and highlight information.
The current TraceState
ProtectedgetGets safe row and column indices to prevent accessing undefined values
Object with safe row and column indices
Registers an observer to receive state updates.
The observer to add
Removes an observer from receiving state updates.
The observer to remove
Notifies all registered observers with the current state.
Notifies observers that an out-of-bounds condition occurred.
Utility function to compare point values for rotor functionality
boolean value
Returns true if this trace supports compare (lower/higher value) navigation. Override to false for trace types that don't use compare modes (e.g., scatter, which is all we currently have).
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 the rotor's compare-mode labels and boundary-message nouns. Override to rename the two compare units for a trace-specific semantic (e.g., the candlestick delta layer uses "above line" / "below line").
Get all highlight SVG elements for this trace Used by HighlightService for high contrast mode
Array of all SVG elements, or empty array if none
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.
Array of all original SVG elements, or empty array if none
ProtectedgetComputes 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.
The row of the position to compute state for
The column of the position to compute state for
The trace state at the requested position
Resets the trace to initial entry state
ProtectedgetReturns 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.
ProtectedgetBuilds the axes object for the description state, including z only when the layer explicitly provides a z-axis label. Subclasses should call this instead of constructing the axes object inline so charts without a real z dimension don't surface the placeholder default.
ProtectedfinalizeCommon post-navigation cleanup that should be called by subclasses after they update their internal state
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 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.
Move to the next point intersection (right arrow in intersection rotor mode). Default is a no-op returning false; subclasses that advertise supportsIntersectionMode must override to provide real behavior.
Move to the previous point intersection (left arrow in intersection rotor mode). Default is a no-op returning false; subclasses that advertise supportsIntersectionMode must override to provide real behavior.
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.
True when entering intersection mode, false when leaving.
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.
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.
The RotorFilterUnit.key of the active unit
The direction to search
True if the cursor moved, false otherwise
Checks if this plot supports extrema navigation.
True if extrema navigation is supported
Base implementation for getting current X value Subclasses can override if they have different data structures
Moves to a specific X value in the trace.
The X value to navigate to
True if the move was successful, false otherwise
Gets the unique identifier for this trace.
The trace ID
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.
Screen-space x position of the pointer/finger
Screen-space y position of the pointer/finger
Guidance state relative to nearest point, or null when unavailable
ProtectedmoveMoves 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:
Cleans up bar plot resources including points and min/max arrays.
ProtectedrangeThe chart's min and max description stats.
A chart of nothing but gaps has no range at all, and safeMin/safeMax
answer an empty set with positive and negative Infinity. Report that the
way every other modality reports an absent value rather than announcing an
infinity.
Shared so SegmentedTrace, which replaces the whole stats block rather
than extending it, cannot drift back to announcing an infinity.
The min and max stats, in that order
ProtectedmapOptionalselector: string | string[] | (string | null)[][]Finds the bar element under the specified coordinates.
Unlike line/scatter/box traces (which return the nearest center regardless of cursor position), bar charts hit-test against each bar's bounding box and return null when the cursor is between bars. As a consequence, pointer guidance beeps fire only when the pointer is inside a bar — there is no directional guidance toward the closest bar from outside. This is intentional: bars are area marks (not points), and "nearest bar" from an arbitrary position is rarely the user's intent.
The x-coordinate
The y-coordinate
Object containing the element and its position, or null if not found
ProtectedcompareShared rotor compare-search across the bars in the current row. Steps through barValues from the current column in the given direction, moving to the first bar whose value satisfies the comparison.
The direction to search (left or right)
The comparison type (lower or higher)
True if a matching bar was found, false otherwise
Checks if coordinates are within the bounding box of the bar element.
The x-coordinate
The y-coordinate
Object containing the SVG element and its position
The SVG element to check bounds against
The row position of the element
The column position of the element
True if coordinates are within bounds, false otherwise
Get extrema targets for the current bar plot trace Returns min and max values within the current group
Array of extrema targets for navigation
Navigate to a specific extrema target
The extrema target to navigate to
ProtectedupdateUpdates the visual position of the current point ensuring it's within bounds.
Moves to the next bar that matches the comparison criteria in rotor mode.
The direction to move (left or right)
The comparison type (lower or higher)
True if a target was found, false otherwise
Trace implementation for funnel charts -- a population shrinking across ordered stages.
Structurally a bar chart whose order is meaningful, so navigation, braille and highlighting transfer. What is different is that the number a reader wants is not the one the chart plots. A funnel is read for its drop-offs: which stage loses people, and how badly. That is a ratio between adjacent bars, and a listener cannot take a ratio by ear from two heights heard one at a time.
So the pitch carries the retention -- what fraction of the previous stage survived -- rather than the count. On a raw scale the worst stage in a funnel is routinely not the biggest fall: going from 10,000 to 2,400 drops three quarters of the range and keeps 24%, while 2,300 to 100 drops only a fifth of the range and keeps 4%. The second is the catastrophe and the first is the ordinary top of a funnel, and a reader listening to absolute heights hears them the other way round.
The count is not lost -- it is announced, alongside the retention and the share of the population that entered. Ratios are what the ear is given, because ratios are what it cannot compute.