MAIDR JavaScript API
    Preparing search index...

    Interface DisplayDescriptionState

    A description whose values have been rounded for display — what DescriptionService hands the ViewModel, and what the dialog renders.

    The one difference from DescriptionState is the cell type: a multi-value cell has been rounded value by value and joined by the time it gets here, so the view never has to deal with an array.

    interface DisplayDescriptionState {
        chartType: string;
        title: string;
        axes: { x?: string; y?: string; z?: string };
        stats: DescriptionStat[];
        guide?: ChartGuide;
        subplots?: SubplotSummary[];
        layers?: LayerSummary[];
        dataTable: { headers: string[]; rows: (string | number)[][] };
        titleSource?: "figure" | "layer";
    }

    Hierarchy

    Index

    Properties

    chartType: string

    Chart/trace type label (e.g., "Bar Chart", "Line Plot")

    title: string

    Chart title

    axes: { x?: string; y?: string; z?: string }

    Axes information

    Chart-specific summary statistics

    guide?: ChartGuide

    A plain-language introduction to the chart type named by chartType. Absent when there is nothing to introduce.

    subplots?: SubplotSummary[]

    List of all subplots in the figure, populated only when the figure has more than one subplot. Lets users see what other subplots are available without having to navigate through them.

    layers?: LayerSummary[]

    Every layer of the subplot this description was taken from, populated only when the subplot has more than one. The dialog renders these as tabs, so a reader is told how many layers there are and which one they are on, and can switch to another without leaving the description.

    dataTable: { headers: string[]; rows: (string | number)[][] }
    titleSource?: "figure" | "layer"

    Where title came from: the layer the reader is on, or the figure it sits in. Absent when there is no authored title at all.

    The dialog resolves one from the other, and used to render the winner as a bare "Title" either way — while l t, which implements the same precedence, is careful to say "Subplot title" or "Figure title" in a multi-panel figure so the announcement names its own source.