Class Heatmap

Interface representing a trace with navigation and observation capabilities

Hierarchy (View Summary)

AbstractTrace
- Heatmap

Index

Constructors

Properties

observers isWarning id type title xAxis yAxis fill navigationService layer supportsExtrema movable highlightValues highlightCenters

Accessors

isInitialEntry isOutOfBounds row col state outOfBoundsState highlight hasMultiPoints values audio braille text dimension

Constructors

constructor

new Heatmap(layer: MaidrLayer): Heatmap
Creates a new Heatmap instance from a MAIDR layer
Parameters
- layer: MaidrLayer
  The MAIDR layer containing heatmap data
Returns Heatmap
Overrides AbstractTrace.constructor
- Defined in src/model/heatmap.ts:33

Properties

`Protected` `Readonly`observers

observers: Observer<TraceState>[]

`Protected`isWarning

isWarning: boolean

`Protected` `Readonly`id

id: string

`Protected` `Readonly`type

type: TraceType

`Protected` `Readonly`title

title: string

`Protected` `Readonly`xAxis

xAxis: string

`Protected` `Readonly`yAxis

yAxis: string

`Protected` `Readonly`fill

fill: string

`Protected` `Readonly`navigationService

navigationService: NavigationService

`Protected` `Readonly`layer

layer: MaidrLayer

`Protected` `Readonly`supportsExtrema

supportsExtrema: false

Abstract property that subclasses must implement to indicate extrema support

`Protected` `Readonly`movable

movable: Movable

`Protected` `Readonly`highlightValues

highlightValues: SVGElement[][] | null

`Protected`highlightCenters

highlightCenters:
    | {
        x: number;
        y: number;
        row: number;
        col: number;
        element: SVGElement;
    }[]
    | null

Accessors

isInitialEntry

get isInitialEntry(): boolean
Returns boolean
Inherited from AbstractTrace.isInitialEntry
- Defined in src/model/abstract.ts:50
set isInitialEntry(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractTrace.isInitialEntry
- Defined in src/model/abstract.ts:54

isOutOfBounds

get isOutOfBounds(): boolean
Returns boolean
Inherited from AbstractTrace.isOutOfBounds
- Defined in src/model/abstract.ts:58
set isOutOfBounds(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractTrace.isOutOfBounds
- Defined in src/model/abstract.ts:62

row

get row(): number
Returns number
Inherited from AbstractTrace.row
- Defined in src/model/abstract.ts:66
set row(value: number): void
Parameters
- value: number
Returns void
Inherited from AbstractTrace.row
- Defined in src/model/abstract.ts:74

col

get col(): number
Returns number
Inherited from AbstractTrace.col
- Defined in src/model/abstract.ts:70
set col(value: number): void
Parameters
- value: number
Returns void
Inherited from AbstractTrace.col
- Defined in src/model/abstract.ts:78

state

get state(): TraceState
Gets the current state of the trace including audio, braille, text, and highlight information.

Returns TraceState
The current TraceState
Inherited from AbstractTrace.state
- Defined in src/model/abstract.ts:305

`Protected`outOfBoundsState

get outOfBoundsState(): TraceState
Returns TraceState
Inherited from AbstractTrace.outOfBoundsState
- Defined in src/model/abstract.ts:339

`Protected`highlight

get highlight(): HighlightState
Returns HighlightState
Inherited from AbstractTrace.highlight
- Defined in src/model/abstract.ts:353

`Protected`hasMultiPoints

get hasMultiPoints(): boolean
Returns boolean
Inherited from AbstractTrace.hasMultiPoints
- Defined in src/model/abstract.ts:448

`Protected`values

get values(): number[][]
Returns number[][]
Overrides AbstractTrace.values
- Defined in src/model/heatmap.ts:11

`Protected`audio

get audio(): AudioState
Returns AudioState
Overrides AbstractTrace.audio
- Defined in src/model/heatmap.ts:62

`Protected`braille

get braille(): BrailleState
Returns BrailleState
Overrides AbstractTrace.braille
- Defined in src/model/heatmap.ts:78

`Protected`text

get text(): TextState
Returns TextState
Overrides AbstractTrace.text
- Defined in src/model/heatmap.ts:90

`Protected`dimension

get dimension(): Dimension
Returns Dimension
Overrides AbstractTrace.dimension
- Defined in src/model/heatmap.ts:101

Methods

notifyRotorBounds

notifyRotorBounds(): void
Returns void
Inherited from AbstractTrace.notifyRotorBounds
- Defined in src/model/abstract.ts:44

`Protected`getSafeIndices

getSafeIndices(): { row: number; col: number }
Gets safe row and column indices to prevent accessing undefined values

Returns { row: number; col: number }
Object with safe row and column indices
Inherited from AbstractTrace.getSafeIndices
- Defined in src/model/abstract.ts:86

addObserver

addObserver(observer: Observer<TraceState>): void
Registers an observer to receive state updates.
Parameters
- observer: Observer<TraceState>
  The observer to add
Returns void
Inherited from AbstractTrace.addObserver
- Defined in src/model/abstract.ts:97

removeObserver

removeObserver(observer: Observer<TraceState>): void
Removes an observer from receiving state updates.
Parameters
- observer: Observer<TraceState>
  The observer to remove
Returns void
Inherited from AbstractTrace.removeObserver
- Defined in src/model/abstract.ts:105

notifyStateUpdate

notifyStateUpdate(): void
Notifies all registered observers with the current state.

Returns void
Inherited from AbstractTrace.notifyStateUpdate
- Defined in src/model/abstract.ts:115

notifyOutOfBounds

notifyOutOfBounds(): void
Notifies observers that an out-of-bounds condition occurred.

Returns void
Inherited from AbstractTrace.notifyOutOfBounds
- Defined in src/model/abstract.ts:123

moveOnce

moveOnce(direction: MovableDirection): boolean
Parameters
- direction: MovableDirection
Returns boolean
Inherited from AbstractTrace.moveOnce
- Defined in src/model/abstract.ts:128

moveToExtreme

moveToExtreme(direction: MovableDirection): boolean
Parameters
- direction: MovableDirection
Returns boolean
Inherited from AbstractTrace.moveToExtreme
- Defined in src/model/abstract.ts:138

moveToIndex

moveToIndex(row: number, col: number): boolean
Parameters
- row: number
- col: number
Returns boolean
Inherited from AbstractTrace.moveToIndex
- Defined in src/model/abstract.ts:148

isMovable

isMovable(target: MovableDirection | [number, number]): boolean
Parameters
- target: MovableDirection | [number, number]
Returns boolean
Inherited from AbstractTrace.isMovable
- Defined in src/model/abstract.ts:158

notifyObserversWithState

notifyObserversWithState(state: TraceState): void
Parameters
- state: TraceState
Returns void
Inherited from AbstractTrace.notifyObserversWithState
- Defined in src/model/abstract.ts:168

compare

compare(a: number, b: number, type: "lower" | "higher"): boolean
Parameters
- a: number
  Utility function to compare point values for rotor functionality
- b: number
- type: "lower" | "higher"
Returns boolean
boolean value
Inherited from AbstractTrace.compare
- Defined in src/model/abstract.ts:194

moveLeftRotor

moveLeftRotor(_mode?: "lower" | "higher"): boolean
Moves left in rotor mode, optionally filtering by lower or higher values.
Parameters
- Optional_mode: "lower" | "higher"
  Optional mode for filtering (lower or higher)
Returns boolean
Throws
Error always - subclasses must override this method
Inherited from AbstractTrace.moveLeftRotor
- Defined in src/model/abstract.ts:230

moveRightRotor

moveRightRotor(_mode?: "lower" | "higher"): boolean
Moves right in rotor mode, optionally filtering by lower or higher values.
Parameters
- Optional_mode: "lower" | "higher"
  Optional mode for filtering (lower or higher)
Returns boolean
Throws
Error always - subclasses must override this method
Inherited from AbstractTrace.moveRightRotor
- Defined in src/model/abstract.ts:239

getAllHighlightElements

getAllHighlightElements(): SVGElement[]
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
Inherited from AbstractTrace.getAllHighlightElements
- Defined in src/model/abstract.ts:369

getAllOriginalElements

getAllOriginalElements(): SVGElement[]
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
Inherited from AbstractTrace.getAllOriginalElements
- Defined in src/model/abstract.ts:393

`Protected`getAudioGroupIndex

getAudioGroupIndex(): { groupIndex?: number }
Returns { groupIndex?: number }
Inherited from AbstractTrace.getAudioGroupIndex
- Defined in src/model/abstract.ts:423

resetToInitialEntry

resetToInitialEntry(): void
Resets the trace to initial entry state

Returns void
Inherited from AbstractTrace.resetToInitialEntry
- Defined in src/model/abstract.ts:442

getExtremaTargets

getExtremaTargets(): ExtremaTarget[]
Get available extrema targets for the current navigation context

Returns ExtremaTarget[]
Array of extrema targets that can be navigated to Default implementation returns empty array (no extrema support)
Inherited from AbstractTrace.getExtremaTargets
- Defined in src/model/abstract.ts:469

navigateToExtrema

navigateToExtrema(_target: ExtremaTarget): void
Base implementation for navigateToExtrema Subclasses must override to provide actual implementation
Parameters
- _target: ExtremaTarget
  The extrema target to navigate to
Returns void
Inherited from AbstractTrace.navigateToExtrema
- Defined in src/model/abstract.ts:478

`Protected`finalizeExtremaNavigation

finalizeExtremaNavigation(): void
Common post-navigation cleanup that should be called by subclasses after they update their internal state

Returns void
Inherited from AbstractTrace.finalizeExtremaNavigation
- Defined in src/model/abstract.ts:489

supportsExtremaNavigation

supportsExtremaNavigation(): boolean
Checks if this plot supports extrema navigation.

Returns boolean
True if extrema navigation is supported
Inherited from AbstractTrace.supportsExtremaNavigation
- Defined in src/model/abstract.ts:514

getCurrentXValue

getCurrentXValue(): XValue | null
Base implementation for getting current X value Subclasses can override if they have different data structures

Returns XValue | null
Inherited from AbstractTrace.getCurrentXValue
- Defined in src/model/abstract.ts:528

moveToXValue

moveToXValue(xValue: XValue): boolean
Moves to a specific X value in the trace.
Parameters
- xValue: XValue
  The X value to navigate to
Returns boolean
True if the move was successful, false otherwise
Inherited from AbstractTrace.moveToXValue
- Defined in src/model/abstract.ts:561

getId

getId(): string
Gets the unique identifier for this trace.

Returns string
The trace ID
Inherited from AbstractTrace.getId
- Defined in src/model/abstract.ts:635

moveToPoint

moveToPoint(x: number, y: number): void
Moves to the nearest point at the specified coordinates (used for hover functionality).
Parameters
- x: number
  The x-coordinate
- y: number
  The y-coordinate
Returns void
Inherited from AbstractTrace.moveToPoint
- Defined in src/model/abstract.ts:649

isPointInBounds

isPointInBounds(
    x: number,
    y: number,
    element: { element: SVGElement; row: number; col: number },
): boolean
Checks if the specified coordinates are within bounds of the element.
Parameters
- x: number
  The x-coordinate
- y: number
  The y-coordinate
- element: { element: SVGElement; row: number; col: number }
  Object containing the SVG element and its position
  - element: SVGElement
    The SVG element to check bounds against
  - row: number
    The row position of the element
  - col: number
    The column position of the element
Returns boolean
True if the point is in bounds, false otherwise
Inherited from AbstractTrace.isPointInBounds
- Defined in src/model/abstract.ts:672

dispose

dispose(): void
Cleans up resources and disposes of the heatmap instance

Returns void
Overrides AbstractTrace.dispose
- Defined in src/model/heatmap.ts:53

`Protected`updateVisualPointPosition

updateVisualPointPosition(): void
Updates the visual position of the current point to safe bounds

Returns void
Overrides AbstractTrace.updateVisualPointPosition
- Defined in src/model/heatmap.ts:161

moveToNextCompareValue

moveToNextCompareValue(
direction: "left" | "right" | "up" | "down",
type: "lower" | "higher",
): boolean
Moves to the next cell matching the comparison criteria in the specified direction
Parameters
- direction: "left" | "right" | "up" | "down"
  Direction to search (left, right, up, or down)
- type: "lower" | "higher"
  Comparison type (lower or higher than current value)
Returns boolean
True if a matching cell was found and moved to
Overrides AbstractTrace.moveToNextCompareValue
- Defined in src/model/heatmap.ts:174

search_in_row

search_in_row(direction: "left" | "right", type: "lower" | "higher"): boolean
Searches for a matching value in the current row
Parameters
- direction: "left" | "right"
  Search direction (left or right)
- type: "lower" | "higher"
  Comparison type (lower or higher)
Returns boolean
True if a matching value was found
- Defined in src/model/heatmap.ts:194

search_in_col

search_in_col(direction: "up" | "down", type: "lower" | "higher"): boolean
Searches for a matching value in the current column
Parameters
- direction: "up" | "down"
  Search direction (up or down)
- type: "lower" | "higher"
  Comparison type (lower or higher)
Returns boolean
True if a matching value was found
- Defined in src/model/heatmap.ts:219

moveUpRotor

moveUpRotor(mode: "lower" | "higher"): boolean
Moves upward in rotor mode to find lower or higher values
Parameters
- mode: "lower" | "higher"
  Comparison mode (lower or higher)
Returns boolean
True if movement was successful
Overrides AbstractTrace.moveUpRotor
- Defined in src/model/heatmap.ts:242

moveDownRotor

moveDownRotor(mode: "lower" | "higher"): boolean
Moves downward in rotor mode to find lower or higher values
Parameters
- mode: "lower" | "higher"
  Comparison mode (lower or higher)
Returns boolean
True if movement was successful
Overrides AbstractTrace.moveDownRotor
- Defined in src/model/heatmap.ts:251

`Protected`mapSvgElementsToCenters

mapSvgElementsToCenters(): | {
    x: number;
    y: number;
    row: number;
    col: number;
    element: SVGElement;
}[]
| null
Maps SVG elements to their center coordinates for click navigation

Returns { x: number; y: number; row: number; col: number; element: SVGElement }[] | null
Array of center coordinates with row/col indices or null
- Defined in src/model/heatmap.ts:259

findNearestPoint

findNearestPoint(
x: number,
y: number,
): { element: SVGElement; row: number; col: number } | null
Finds the nearest heatmap cell to the given coordinates
Parameters
- x: number
  X coordinate
- y: number
  Y coordinate
Returns { element: SVGElement; row: number; col: number } | null
Nearest cell information or null
Overrides AbstractTrace.findNearestPoint
- Defined in src/model/heatmap.ts:301

Class Heatmap

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Heatmap

Properties

Protected Readonlyobservers

ProtectedisWarning

Protected Readonlyid

Protected Readonlytype

Protected Readonlytitle

Protected ReadonlyxAxis

Protected ReadonlyyAxis

Protected Readonlyfill

Protected ReadonlynavigationService

Protected Readonlylayer

Protected ReadonlysupportsExtrema

Protected Readonlymovable

Protected ReadonlyhighlightValues

ProtectedhighlightCenters

Accessors

isInitialEntry

Returns boolean

Parameters

Returns void

isOutOfBounds

Returns boolean

Parameters

Returns void

row

Returns number

Parameters

Returns void

col

Returns number

Parameters

Returns void

state

Returns TraceState

ProtectedoutOfBoundsState

Returns TraceState

Protectedhighlight

Returns HighlightState

ProtectedhasMultiPoints

Returns boolean

Protectedvalues

Returns number[][]

Protectedaudio

Returns AudioState

Protectedbraille

Returns BrailleState

Protectedtext

Returns TextState

Protecteddimension

Returns Dimension

Methods

notifyRotorBounds

Returns void

ProtectedgetSafeIndices

Returns { row: number; col: number }

addObserver

Parameters

Returns void

removeObserver

Parameters

Returns void

notifyStateUpdate

Returns void

notifyOutOfBounds

Returns void

moveOnce

Parameters

Returns boolean

moveToExtreme

`Protected` `Readonly`observers

`Protected`isWarning

`Protected` `Readonly`id

`Protected` `Readonly`type

`Protected` `Readonly`title

`Protected` `Readonly`xAxis

`Protected` `Readonly`yAxis

`Protected` `Readonly`fill

`Protected` `Readonly`navigationService

`Protected` `Readonly`layer

`Protected` `Readonly`supportsExtrema

`Protected` `Readonly`movable

`Protected` `Readonly`highlightValues

`Protected`highlightCenters

`Protected`outOfBoundsState

`Protected`highlight

`Protected`hasMultiPoints

`Protected`values

`Protected`audio

`Protected`braille

`Protected`text

`Protected`dimension

`Protected`getSafeIndices

`Protected`getAudioGroupIndex

`Protected`finalizeExtremaNavigation

`Protected`updateVisualPointPosition