All files / src/pages/flowsheet-page/economics/results-panel/charts chartRenderers.tsx

95.65% Statements 22/23
50% Branches 4/8
94.73% Functions 18/19
95.65% Lines 22/23

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184                                                                                                                        103x 60x   20x   18x   20x           103x     5x               5x               5x               5x             15x 5x   5x 5x             3x                       3x             5x             5x                 5x                 5x                 103x               92x        
import type { CSSProperties, ReactNode } from "react";
import type {
  ChartDatum,
  DrillbackHandler,
  ParsedChartDataset,
} from "../model/types";
import { CashFlowChart } from "./CashFlowChart";
import type { ChartMetricMenuOption } from "./ChartMetricMenu";
import { manualBaselineMetricKey, metricKeyForChartPoint } from "./chartData";
import { ManualBaselineComparisonChart } from "./comparison/ManualBaselineComparisonChart";
import {
  CostBreakdownComparisonChart,
  LineOverlayComparisonChart,
} from "./comparison/StudyComparisonOverlayCharts";
import { comparisonChartHeightStyle } from "./comparison/studyComparisonOverlayData";
import {
  CHART_CAPEX_BREAKDOWN,
  CHART_CASH_FLOW_NPV,
  CHART_MANUAL_BASELINE_COMPARISON,
  CHART_OPERATING_COST_CUMULATIVE,
  CHART_OPERATING_COST_PROFILE,
  CHART_OPEX_BREAKDOWN,
  COMPARISON_CHART_CASH_FLOW,
  COMPARISON_CHART_COST_BREAKDOWN,
  COMPARISON_CHART_OPERATING_CUMULATIVE,
  COMPARISON_CHART_OPERATING_PROFILE,
  COMPARISON_METRIC_FILTERS,
  DEFAULT_COMPARISON_METRIC_KEYS,
} from "./constants";
import { OperatingCostTimelineChart } from "./OperatingCostTimelineChart";
import { RankedBreakdownChart } from "./RankedBreakdownChart";
 
type ChartRenderer = (props: {
  dataset: ParsedChartDataset;
  onDrillback: DrillbackHandler;
}) => ReactNode;
 
export type ChartCardDefinition = {
  render: ChartRenderer;
  heightClassName: string;
  heightStyle?: (dataset: ParsedChartDataset) => CSSProperties | undefined;
  metricFilter?: ChartMetricFilterDefinition;
  operatingSeriesFilter?: ChartOperatingSeriesFilterDefinition;
  wide: boolean;
  showSourceRows: boolean;
};
 
export type ChartMetricFilterDefinition = {
  options: (dataset: ParsedChartDataset) => readonly ChartMetricMenuOption[];
  defaultKeys: (dataset: ParsedChartDataset) => readonly string[];
  pointKey: (point: ChartDatum, seriesKey: string) => string;
  ariaLabel: (dataset: ParsedChartDataset) => string;
  selectionKey: (dataset: ParsedChartDataset) => string;
};
 
export type ChartOperatingSeriesFilterDefinition = {
  ariaLabel: string;
  defaultSourceCount: number;
};
 
const studyComparisonMetricFilter: ChartMetricFilterDefinition = {
  options: (dataset) => dataset.rendering_metadata.metric_options ?? [],
  defaultKeys: (dataset) =>
    dataset.rendering_metadata.default_metric_keys ?? [],
  pointKey: metricKeyForChartPoint,
  ariaLabel: (dataset) => `${dataset.title} metrics`,
  selectionKey: (dataset) =>
    [
      dataset.rendering_metadata.chart_family || dataset.chart_key,
      dataset.id,
    ].join(":"),
};
 
const CHART_CARD_DEFINITIONS: Record<string, ChartCardDefinition> = {
  [CHART_CASH_FLOW_NPV]: {
    render: ({ dataset, onDrillback }) => (
      <CashFlowChart dataset={dataset} onDrillback={onDrillback} />
    ),
    heightClassName: "h-[350px]",
    wide: true,
    showSourceRows: false,
  },
  [CHART_CAPEX_BREAKDOWN]: {
    render: ({ dataset, onDrillback }) => (
      <RankedBreakdownChart dataset={dataset} onDrillback={onDrillback} />
    ),
    heightClassName: "h-[260px]",
    wide: false,
    showSourceRows: true,
  },
  [CHART_OPEX_BREAKDOWN]: {
    render: ({ dataset, onDrillback }) => (
      <RankedBreakdownChart dataset={dataset} onDrillback={onDrillback} />
    ),
    heightClassName: "h-[260px]",
    wide: false,
    showSourceRows: true,
  },
  [CHART_MANUAL_BASELINE_COMPARISON]: {
    render: ({ dataset, onDrillback }) => (
      <ManualBaselineComparisonChart
        dataset={dataset}
        onDrillback={onDrillback}
      />
    ),
    heightClassName: "h-[260px]",
    metricFilter: {
      options: () => COMPARISON_METRIC_FILTERS,
      defaultKeys: () => Array.from(DEFAULT_COMPARISON_METRIC_KEYS),
      pointKey: manualBaselineMetricKey,
      ariaLabel: () => "Comparison chart metrics",
      selectionKey: (dataset) => dataset.chart_key,
    },
    wide: false,
    showSourceRows: true,
  },
  [CHART_OPERATING_COST_CUMULATIVE]: {
    render: ({ dataset, onDrillback }) => (
      <OperatingCostTimelineChart dataset={dataset} onDrillback={onDrillback} />
    ),
    heightClassName: "h-[320px]",
    operatingSeriesFilter: {
      ariaLabel: "Cumulative operating cost metrics",
      defaultSourceCount: 3,
    },
    wide: true,
    showSourceRows: true,
  },
  [CHART_OPERATING_COST_PROFILE]: {
    render: ({ dataset, onDrillback }) => (
      <OperatingCostTimelineChart dataset={dataset} onDrillback={onDrillback} />
    ),
    heightClassName: "h-[300px]",
    wide: true,
    showSourceRows: true,
  },
  [COMPARISON_CHART_CASH_FLOW]: {
    render: ({ dataset }) => <LineOverlayComparisonChart dataset={dataset} />,
    heightClassName: "h-[320px]",
    metricFilter: studyComparisonMetricFilter,
    wide: false,
    showSourceRows: false,
  },
  [COMPARISON_CHART_COST_BREAKDOWN]: {
    render: ({ dataset }) => <CostBreakdownComparisonChart dataset={dataset} />,
    heightClassName: "h-[320px]",
    heightStyle: comparisonChartHeightStyle,
    metricFilter: studyComparisonMetricFilter,
    wide: false,
    showSourceRows: false,
  },
  [COMPARISON_CHART_OPERATING_CUMULATIVE]: {
    render: ({ dataset, onDrillback }) => (
      <OperatingCostTimelineChart dataset={dataset} onDrillback={onDrillback} />
    ),
    heightClassName: "h-[320px]",
    metricFilter: studyComparisonMetricFilter,
    wide: false,
    showSourceRows: false,
  },
  [COMPARISON_CHART_OPERATING_PROFILE]: {
    render: ({ dataset, onDrillback }) => (
      <OperatingCostTimelineChart dataset={dataset} onDrillback={onDrillback} />
    ),
    heightClassName: "h-[320px]",
    metricFilter: studyComparisonMetricFilter,
    wide: false,
    showSourceRows: false,
  },
};
 
const DEFAULT_CHART_CARD_DEFINITION: ChartCardDefinition = {
  render: () => null,
  heightClassName: "h-[260px]",
  wide: false,
  showSourceRows: true,
};
 
export function chartCardDefinition(dataset: ParsedChartDataset) {
  return (
    CHART_CARD_DEFINITIONS[dataset.chart_key] ?? DEFAULT_CHART_CARD_DEFINITION
  );
}