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

    Interface HighchartsGridOptions

    Options for customizing the highchartsGridToMaidr adapter output.

    interface HighchartsGridOptions {
        id?: string;
        title?: string;
        subtitle?: string;
        caption?: string;
        layout?: { rows?: number; columns?: number };
    }
    Index

    Properties

    id? title? subtitle? caption? layout?

    Properties

    id?: string

    Override the generated figure ID. Defaults to highcharts-grid-{n}.

    title?: string

    Figure-level title announced for the whole grid.

    subtitle?: string

    Figure-level subtitle.

    caption?: string

    Figure-level caption.

    layout?: { rows?: number; columns?: number }

    Chunks a flat chart list into a grid. Ignored when a 2D chart array is passed (2D input maps 1:1 to the subplot grid). When omitted, a flat list becomes a single row.

    Type Declaration

    • Optionalrows?: number

      Number of grid rows (columns are derived when only rows is set).

    • Optionalcolumns?: number

      Number of charts per row. Takes precedence over rows.

    Settings

    Member Visibility

    On This Page

    Properties