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

    Interface DescriptionState

    Description state containing objective chart metadata for the description modal. Fetched on-demand when the user opens the description dialog.

    interface DescriptionState {
        chartType: string;
        title: string;
        axes: { x?: string; y?: string; z?: string };
        stats: DescriptionStat[];
        dataTable: { headers: string[]; rows: (string | number)[][] };
        subplots?: SubplotSummary[];
    }
    Index

    Properties

    chartType title axes stats dataTable subplots?

    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

    stats: DescriptionStat[]

    Chart-specific summary statistics

    dataTable: { headers: string[]; rows: (string | number)[][] }

    Data table for raw data display

    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.

    Settings

    Member Visibility

    On This Page

    Properties