MAIDR Documentation - v3.46.2
    Preparing search index...

    Interface representing a trace with navigation and observation capabilities

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    observers: Observer<TraceState>[]
    isWarning: boolean
    id: string
    type: TraceType
    title: string
    xAxis: string
    yAxis: string
    fill: string
    layer: MaidrLayer
    supportsExtrema: true

    Abstract property that subclasses must implement to indicate extrema support

    movable: Movable
    highlightValues: HighlightValue[][] | null
    highlightCenters:
        | {
            x: number;
            y: number;
            row: number;
            col: number;
            element: SVGElement;
        }[]
        | null
    navigationService: NavigationService

    Accessors

    • get isInitialEntry(): boolean

      Returns boolean

    • set isInitialEntry(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isOutOfBounds(): boolean

      Returns boolean

    • set isOutOfBounds(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get state(): TraceState

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

      Returns TraceState

      The current TraceState

    • get values(): number[][]

      Gets the 2D array of candlestick values

      Returns number[][]

      Array of candlestick values for all segments

    Methods

    • 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

    • 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

      Error always - subclasses must override this method

    • 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

      Error always - subclasses must override this method

    • 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

    • 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

    • 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

    • Handles initial entry into the candlestick chart, setting default position

      Returns void

    • Maps candlestick selectors to 2D array of SVG elements for highlighting

      Parameters

      • selectors: string | string[] | CandlestickSelector | undefined

        CSS selectors or structured candlestick selectors

      Returns HighlightValue[][] | null

      2D array of SVG elements or null if no selectors provided

    • Moves to the next value in the specified direction that matches the comparison type

      Parameters

      • direction: "left" | "right"

        Direction to search (left or right)

      • type: "lower" | "higher"

        Comparison type (lower or higher)

      Returns boolean

      True if a matching value was found and moved to

    • 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

    • Finds the nearest candlestick point to the given coordinates

      Parameters

      • x: number

        X coordinate

      • y: number

        Y coordinate

      Returns { element: SVGElement; row: number; col: number } | null

      Nearest point information or null