@cdc/chart 4.24.1 → 4.24.3

package/src/types/ChartConfig.ts

@@ -5,23 +5,16 @@ import { type Series } from '@cdc/core/types/Series'
 import { Runtime } from '@cdc/core/types/Runtime'
 import { FilterBehavior } from '@cdc/core/types/FilterBehavior'
 import { Table } from '@cdc/core/types/Table'
+import { BoxPlot } from '@cdc/core/types/BoxPlot'
+import { General } from '@cdc/core/types/General'
+import { type Link } from './../components/Sankey/types'
+import { Legend } from '@cdc/core/types/Legend'
+import { ConfidenceInterval } from '@cdc/core/types/ConfidenceInterval'
+import { Region } from '@cdc/core/types/Region'
+import { type PreliminaryDataItem } from '../components/LineChart/LineChartProps'
 
 export type ChartColumns = Record<string, Column>
 
-type Region = {
-  from: string
-  to: string
-  label: string
-  color: string
-  background: string
-  range: 'Custom' | string
-}
-
-type BoxPlot = {
-  firstQuartilePercentage: number
-  [key: string]: any
-}
-
 type DataFormat = {
   abbreviated: boolean
   bottomAbbreviated: boolean
@@ -47,6 +40,7 @@ type Exclusions = {
 }
 
 type Filter = {
+  active: string
   type: 'url'
   columnName: string
   showDropdown: boolean
@@ -54,12 +48,15 @@ type Filter = {
   label: string
   order: 'asc' | 'desc' | 'cust'
   values: string[]
+  queryParameter: string
 }
 
 export type Legend = {
+  seriesHighlight: string[]
   additionalCategories: string[]
   // general legend onClick behavior
   behavior: 'highlight' | 'isolate' | string
+  axisAlign: boolean
   colorCode: string
   description: string
   // show or hide the legend
@@ -86,9 +83,7 @@ type Visual = {
 
 type AllChartsConfig = {
   animate: boolean
-  general: {
-    boxplot: BoxPlot
-  }
+  general: General
   barHasBorder: 'true' | 'false'
   barHeight: number
   barSpace: number
@@ -100,11 +95,15 @@ type AllChartsConfig = {
     height: number
   }
   chartMessage: { noData?: string }
+  color: string
   colorMatchLineSeriesLabels: boolean
   columns: ChartColumns
-  confidenceKeys: Record<string, any>
+  confidenceKeys: ConfidenceInterval
+  customColors: string[]
   data: Object[]
+  dataUrl: string
   dataCutoff: number
+  dataDescription: string
   dataFormat: DataFormat
   dataKey: string
   description: string
@@ -115,6 +114,7 @@ type AllChartsConfig = {
   fontSize: 'small' | 'medium' | 'large'
   footnotes: string
   forestPlot: ForestPlotConfigSettings
+  formattedData: Object[] & { urlFiltered: boolean }
   heights: {
     vertical: number
   }
@@ -135,11 +135,16 @@ type AllChartsConfig = {
   orientation: 'vertical' | 'horizontal'
   palette: string
   pieType?: string
+  preliminaryData: PreliminaryDataItem[]
+  primary?: DataFormat
   roundingStyle: string
   runtime: Runtime
+  runtimeDataUrl: string
   series: Series
   showLineSeriesLabels: boolean
+  showSidebar: boolean
   showTitle: boolean
+  sortData: 'ascending' | 'descending'
   stackedAreaChartLineType: string
   suppressedData?: { label: string; icon: string; value: string }[]
   superTitle: string
@@ -150,19 +155,41 @@ type AllChartsConfig = {
   tooltips: {
     singleSeries: boolean
     opacity: number
+    dateDisplayFormat: string
   }
   topAxis: { hasLine: boolean }
   twoColor: { palette: string }
-  type: string
+  type: 'chart' | 'dashboard'
   useLogScale: boolean
   visual: Visual
-  visualizationType: 'Area Chart' | 'Bar' | 'Box Plot' | 'Deviation Bar' | 'Forest Plot' | 'Line' | 'Paired Bar' | 'Pie' | 'Scatter Plot' | 'Spark Line' | 'Combo' | 'Forecasting'
+  visualizationType: 'Area Chart' | 'Bar' | 'Box Plot' | 'Deviation Bar' | 'Forest Plot' | 'Line' | 'Paired Bar' | 'Pie' | 'Scatter Plot' | 'Spark Line' | 'Combo' | 'Forecasting' | 'Sankey'
   visualizationSubType: string
   xAxis: Axis
   yAxis: Axis
   xScale: Function
   yScale: Function
   regions: Region[]
+  sankey: {
+    data: { links: Link[]; storyNodeText: Object[]; tooltips: Object[] }[]
+    nodePadding: number
+    iterations: number
+    nodeSize: {
+      nodeWidth: number
+    }
+    margin: { margin_x: number; margin_y: number }
+    nodeColor: { default: boolean; inactive: boolean }
+    opacity: { LinkOpacityInactive: string; LinkOpacityDefault: string; nodeOpacityInactive: boolean; nodeOpacityDefault: boolean }
+    rxValue: number
+    nodeFontColor: string
+    nodeValueStyle: {
+      textBefore: string
+      textAfter: string
+    }
+    linkColor: {
+      inactive: string
+      default: string
+    }
+  }
 }
 
 export type ForestPlotConfig = {

package/src/types/ChartContext.ts

@@ -1,36 +1,46 @@
 import { type ChartConfig } from './ChartConfig'
 import { PickD3Scale } from '@visx/scale'
+import { type SharedFilter } from '@cdc/dashboard/src/types/SharedFilter'
 
-type ColorScale = PickD3Scale<'ordinal', any, any>
+export type ColorScale = PickD3Scale<'ordinal', any, any>
 
-type TransformedData = {
+export type TransformedData = {
   dataKey?: string
   [key: string]: any
 }
 
 type SharedChartContext = {
+  animatedChart?: boolean
+  // process top level chart aria label for each chart type
+  handleChartAriaLabels: (config: any) => string
   colorScale?: ColorScale
   config: ChartConfig
   currentViewport?: string
   highlight?: Function
   highlightReset?: Function
+  legendIsolateValues?: string[]
+  setLegendIsolateValues?: Function
+  getTextWidth?: () => string | number
 }
 
 // Line Chart Specific Context
 type LineChartContext = SharedChartContext & {
   dimensions: [screenWidth: number, screenHeight: number]
   formatDate: Function
+  formatTooltipsDate: Function
   formatNumber: Function
   handleLineType: Function
   isNumber: unknown
   isDebug?: boolean
   parseDate: Function
   rawData: Object[]
-  seriesHighlight: String[]
+  seriesHighlight: string[]
   tableData: Object[]
   transformedData: TransformedData[]
   updateConfig: Function
   visualizationType: 'Line'
+  colorPalettes: Record<string, string[]>
+  twoColorPalette: Record<string, string[]>
 }
 
 export type ChartContext =
@@ -38,6 +48,7 @@ export type ChartContext =
   | (SharedChartContext & {
       dimensions: [screenWidth: number, screenHeight: number]
       formatDate?: Function
+      formatTooltipsDate: Function
       formatNumber?: Function
       handleLineType?: Function
       isNumber?: boolean
@@ -45,10 +56,12 @@ export type ChartContext =
       isDebug?: boolean
       parseDate?: Function
       rawData?: Object[]
-      seriesHighlight?: String[]
+      seriesHighlight?: string[]
       tableData?: Object[]
       transformedData?: TransformedData[]
       setSharedFilter?: Function
       sharedFilterValue?: string
       updateConfig?: Function
+      colorPalettes: any
+      twoColorPalette: any
     })

package/src/types/Label.ts

@@ -0,0 +1,7 @@
+export type Label = {
+  datum: string
+  index: number
+  text: string
+  value: string
+  icon?: any
+}