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

    Interface TextState

    Text description state containing labels and values for screen reader output.

    interface TextState {
        main: { label: string; value: string | number | number[] };
        cross: { label: string; value: string | number | number[] };
        z?: { label: string; value: string | number };
        range?: { min: number; max: number };
        section?: string;
        mainAxis?: AxisType;
        crossAxis?: AxisType;
        crossRange?: { min: number; max: number };
        gridPoints?: { x: number; y: number }[];
        gridPosition?: { row: number; col: number };
    }
    Index

    Properties

    main cross z? range? section? mainAxis? crossAxis? crossRange? gridPoints? gridPosition?

    Properties

    main: { label: string; value: string | number | number[] }
    cross: { label: string; value: string | number | number[] }
    z?: { label: string; value: string | number }
    range?: { min: number; max: number }
    section?: string
    mainAxis?: AxisType

    Original axis identity for main value. For vertical plots: 'x', for horizontal plots: 'y'. Used to apply correct formatter regardless of orientation.

    crossAxis?: AxisType

    Original axis identity for cross value. For vertical plots: 'y', for horizontal plots: 'x'. Used to apply correct formatter regardless of orientation.

    crossRange?: { min: number; max: number }

    Range for the cross axis, used in grid navigation to show both axis ranges.

    gridPoints?: { x: number; y: number }[]

    Points in the current grid cell, listed as coordinate pairs.

    gridPosition?: { row: number; col: number }

    Current grid cell position (1-indexed for display).

    Settings

    Member Visibility

    On This Page

    Properties