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

    Class BoxTrace

    Concrete implementation of a box plot trace supporting vertical and horizontal orientations. Handles boxplot sections (min, Q1, Q2, Q3, max, outliers) and rotor-based navigation.

    This is a pure box plot — violin-specific behavior lives in ViolinBoxTrace.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

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

    Abstract property that subclasses must implement to indicate extrema support

    movable: Movable
    highlightValues: (SVGElement | SVGElement[])[][] | null
    highlightCenters:
        | {
            x: number;
            y: number;
            row: number;
            col: number;
            element: SVGElement;
        }[]
        | null

    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 | number[])[][]

      Returns (number | number[])[][]

    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

    • 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

    • 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

    • Moves to the next boxplot section that matches the comparison criteria.

      Parameters

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

      Returns boolean

    • Sets the current point based on direction and index.

      Parameters

      • direction: "left" | "right" | "up" | "down"
      • pointIndex: number

      Returns void

    • Moves up in rotor mode, optionally filtering by lower or higher values.

      Parameters

      • mode: "lower" | "higher"

      Returns boolean

      Error always - subclasses must override this method

    • Moves down in rotor mode, optionally filtering by lower or higher values.

      Parameters

      • mode: "lower" | "higher"

      Returns boolean

      Error always - subclasses must override this method

    • Moves left in rotor mode, optionally filtering by lower or higher values.

      Parameters

      • mode: "lower" | "higher"

      Returns boolean

      Error always - subclasses must override this method

    • Moves right in rotor mode, optionally filtering by lower or higher values.

      Parameters

      • mode: "lower" | "higher"

      Returns boolean

      Error always - subclasses must override this method

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

    • Parameters

      • x: number
      • y: number

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

    • Moves to the nearest point at the specified coordinates (disabled for boxplots).

      Parameters

      • _x: number
      • _y: number

      Returns void