Type Alias FigureState

Type Declaration

• { empty: true; type: "figure"; warning?: boolean }
• {
      empty: false;
      type: "figure";
      title: string;
      subtitle: string;
      caption: string;
      xAxis: string;
      yAxis: string;
      size: number;
      index: number;
      subplot: SubplotState;
      traceTypes: string[];
      highlight: HighlightState;
  }

  • empty: false

  • type: "figure"

  • title: string

  • subtitle: string

  • caption: string

  • xAxis: string

    Figure-wide X axis label shared across all subplots (facet grids). Empty string when the JSON authored no figure-level x label; callers then fall back to the focused subplot's own axis.

  • yAxis: string

    Figure-wide Y axis label shared across all subplots (facet grids). Empty string when the JSON authored no figure-level y label.

  • size: number

  • index: number

  • subplot: SubplotState

  • traceTypes: string[]

  • highlight: HighlightState