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

    Interface Maidr

    Root MAIDR data structure containing figure metadata and subplot grid. This is the type for the data prop passed to the <Maidr> React component.

    const data: Maidr = {
      id: 'my-chart',
      title: 'Sales by Quarter',
      subplots: [[{
        layers: [{
          id: '0',
          type: 'bar',
          axes: { x: 'Quarter', y: 'Revenue' },
          data: [{ x: 'Q1', y: 120 }, { x: 'Q2', y: 200 }],
        }],
      }]],
    };
    interface Maidr {
        id: string;
        title?: string;
        subtitle?: string;
        caption?: string;
        subplots: MaidrSubplot[][];
    }
    Index

    Properties

    id title? subtitle? caption? subplots

    Properties

    id: string

    Unique identifier for the chart. Used for DOM element IDs.

    title?: string

    Chart title displayed in text descriptions.

    subtitle?: string

    Chart subtitle.

    caption?: string

    Chart caption.

    subplots: MaidrSubplot[][]

    2D grid of subplots. Each row is an array of subplots. For a single chart, use [[{ layers: [...] }]].

    Settings

    Member Visibility

    On This Page

    Properties