MAIDR Documentation - v4.4.0
    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[];
        subplots?: SubplotSummary[];
        dataTable: { headers: string[]; rows: (string | number)[][] };
    }

    Hierarchy

    Index

    Properties

    chartType title axes stats subplots? dataTable

    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

    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.

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

    Settings

    Member Visibility

    On This Page

    Properties