Creates a new Heatmap instance from a MAIDR layer
The MAIDR layer containing heatmap data
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 ReadonlyxProtected ReadonlyyProtected ReadonlyzProtected ReadonlynavigationProtected ReadonlylayerProtected ReadonlysupportsAbstract property that subclasses must implement to indicate extrema support
Protected ReadonlymovableProtected ReadonlyhighlightProtectedhighlightGets the current state of the trace including audio, braille, text, and highlight information.
The current TraceState
ProtectedoutProtectedhighlightProtectedautoplayProtectedhasProtectedvaluesProtectedaudioProtectedbrailleProtectedtextGets the description state for the heatmap trace.
The description state containing chart metadata and data table
ProtecteddimensionProtectedgetGets 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).
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.
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.
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 to the nearest point at the specified coordinates (used for hover functionality).
The x-coordinate
The y-coordinate
Checks if the specified coordinates are within bounds of the element.
The x-coordinate
The y-coordinate
Object containing the SVG element and its position
True if the point is in bounds, false otherwise
Cleans up resources and disposes of the heatmap instance
ProtectedupdateUpdates the visual position of the current point to safe bounds
Moves to the next cell matching the comparison criteria in the specified direction
Direction to search (left, right, up, or down)
Comparison type (lower or higher than current value)
True if a matching cell was found and moved to
Searches for a matching value in the current row
Search direction (left or right)
Comparison type (lower or higher)
True if a matching value was found
Searches for a matching value in the current column
Search direction (up or down)
Comparison type (lower or higher)
True if a matching value was found
Moves upward in rotor mode to find lower or higher values
Comparison mode (lower or higher)
True if movement was successful
Moves downward in rotor mode to find lower or higher values
Comparison mode (lower or higher)
True if movement was successful
ProtectedmapMaps SVG elements to their center coordinates for click navigation
Array of center coordinates with row/col indices or null
Finds the nearest heatmap cell to the given coordinates
X coordinate
Y coordinate
Nearest cell information or null
Gets extrema targets for the heatmap trace
Array of extrema targets for navigation
Navigates to a specific extrema target in the heatmap
The extrema target to navigate to
Interface representing a trace with navigation and observation capabilities