MAIDR JavaScript API
    Preparing search index...

    Interface SubplotSummary

    Summary of a single subplot in a multi-panel figure, used to give users an at-a-glance list of what's available before they navigate in.

    interface SubplotSummary {
        index: number;
        title: string;
        traceTypes: string[];
        isActive: boolean;
    }
    Index

    Properties

    index title traceTypes isActive

    Properties

    index: number

    1-based visual index (top-left = 1, reading order).

    title: string

    Layer title for the subplot, or empty string if not available.

    traceTypes: string[]

    Display labels for the subplot's layers, one per layer (e.g. Scatter Plot), not the raw TraceType values -- the dialog prints these verbatim. Figure.getSubplotSummaries maps them.

    isActive: boolean

    True if this is the subplot the user is currently focused on.

    Settings

    Member Visibility

    On This Page

    Properties