@cdc/chart 4.24.4 → 4.24.7

package/src/hooks/useMinMax.ts

@@ -1,4 +1,6 @@
 import { ChartConfig } from '../types/ChartConfig'
+import _ from 'lodash'
+import { isConvertLineToBarGraph } from '../helpers/isConvertLineToBarGraph'
 
 type UseMinMaxProps = {
   /** config - standard chart config */
@@ -11,11 +13,13 @@ type UseMinMaxProps = {
   existPositiveValue: boolean
   /** data - standard data array */
   data: Object[]
+  /** Table data -data array Filtered & Excluded */
+  tableData: Object[]
   /** isAllLine: if all series are line type including dashed lines */
   isAllLine: boolean
 }
 
-const useMinMax = ({ config, minValue, maxValue, existPositiveValue, data, isAllLine }: UseMinMaxProps) => {
+const useMinMax = ({ config, minValue, maxValue, existPositiveValue, data, isAllLine, tableData }: UseMinMaxProps) => {
   let min = 0
   let max = 0
 
@@ -27,6 +31,10 @@ const useMinMax = ({ config, minValue, maxValue, existPositiveValue, data, isAll
     return { min, max }
   }
 
+  const checkLineToBarGraph = () => {
+    return isConvertLineToBarGraph(config.visualizationType, data, config.allowLineToBarGraph)
+  }
+
   const { visualizationType, series } = config
   const { max: enteredMaxValue, min: enteredMinValue } = config.runtime.yAxis
   const minRequiredCIPadding = 1.15 // regardless of Editor if CI data, there must be 10% padding added
@@ -123,10 +131,10 @@ const useMinMax = ({ config, minValue, maxValue, existPositiveValue, data, isAll
   }
 
   // this should not apply to bar charts if there is negative CI data
-  if ((visualizationType === 'Bar' || (visualizationType === 'Combo' && !isAllLine)) && min > 0) {
+  if ((visualizationType === 'Bar' || checkLineToBarGraph() || (visualizationType === 'Combo' && !isAllLine)) && min > 0) {
     min = 0
   }
-  if ((config.visualizationType === 'Bar' || (config.visualizationType === 'Combo' && !isAllLine)) && min < 0) {
+  if ((config.visualizationType === 'Bar' || checkLineToBarGraph() || (config.visualizationType === 'Combo' && !isAllLine)) && min < 0) {
     min = min * 1.1
   }
 
@@ -145,9 +153,25 @@ const useMinMax = ({ config, minValue, maxValue, existPositiveValue, data, isAll
     min = enteredMinValue && isMinValid ? enteredMinValue : 0
   }
 
-  if (config.visualizationType === 'Line') {
+  if (config.visualizationType === 'Line' && !checkLineToBarGraph()) {
     const isMinValid = config.useLogScale ? enteredMinValue >= 0 && enteredMinValue < minValue : enteredMinValue < minValue
-    min = enteredMinValue && isMinValid ? enteredMinValue : minValue
+    // update minValue for (0) Suppression points
+    const suppressedMinValue = tableData?.some((dataItem, index) => {
+      return config.preliminaryData?.some(pd => {
+        if (pd.type !== 'suppression' || !pd.style) return false
+
+        // Filter data item based on current series keys and check if pd.value is present
+        const relevantData = _.pick(dataItem, config.runtime?.seriesKeys)
+        const isValuePresent = _.values(relevantData).includes(pd.value)
+
+        // Check for value match condition
+        const valueMatch = pd.column ? dataItem[pd.column] === pd.value : isValuePresent
+
+        // Return true if the value matches and it's either the first or the last item
+        return valueMatch && (index === 0 || index === tableData.length - 1)
+      })
+    })
+    min = enteredMinValue && isMinValid ? enteredMinValue : suppressedMinValue ? 0 : minValue
   }
   //If data value max wasn't provided, calculate it
   if (max === Number.MIN_VALUE) {

package/src/hooks/useScales.ts

@@ -44,6 +44,10 @@ const useScales = (properties: useScaleProps) => {
   let seriesScale = null
   let xScaleNoPadding = null
   let xScaleBrush = null
+  let xScaleAnnotation = scaleLinear({
+    domain: [0, 100],
+    range: [0, xMax]
+  })
 
   // handle  Horizontal bars
   if (isHorizontal) {
@@ -62,7 +66,12 @@ const useScales = (properties: useScaleProps) => {
     seriesScale = composeScaleBand(seriesDomain, [0, xScale.bandwidth()], 0)
   }
 
-  // handle Area chart
+  // handle Linear scaled viz
+  if (config.xAxis.type === 'date' && !isHorizontal) {
+    const xAxisDataMappedSorted = xAxisDataMapped ? xAxisDataMapped.sort() : []
+    xScale = composeScaleBand(xAxisDataMappedSorted, [0, xMax], 1 - config.barThickness)
+  }
+
   if (config.xAxis.type === 'date-time') {
     let xAxisMin = Math.min(...xAxisDataMapped)
     let xAxisMax = Math.max(...xAxisDataMapped)
@@ -72,9 +81,22 @@ const useScales = (properties: useScaleProps) => {
       domain: [xAxisMin, xAxisMax],
       range: [0, xMax]
     })
-    xScaleBrush = xScale
+
     xScale.type = scaleTypes.TIME
-    seriesScale = composeScaleBand(seriesDomain, [0, config.barThickness * xMax], 0)
+
+    let minDistance = Number.MAX_VALUE
+    let xAxisDataMappedSorted = xAxisDataMapped ? xAxisDataMapped.sort() : []
+    for (let i = 0; i < xAxisDataMappedSorted.length - 1; i++) {
+      let distance = xScale(xAxisDataMappedSorted[i + 1]) - xScale(xAxisDataMappedSorted[i])
+
+      if (distance < minDistance) minDistance = distance
+    }
+
+    if (xAxisDataMapped.length === 1 || minDistance > xMax / 4) {
+      minDistance = xMax / 4
+    }
+
+    seriesScale = composeScaleBand(seriesDomain, [0, (config.barThickness || 1) * minDistance], 0)
   }
 
   // handle Deviation bar
@@ -233,40 +255,40 @@ const useScales = (properties: useScaleProps) => {
       }
     }
   }
-  return { xScale, yScale, seriesScale, g1xScale, g2xScale, xScaleNoPadding, xScaleBrush }
+  return { xScale, yScale, seriesScale, g1xScale, g2xScale, xScaleNoPadding, xScaleBrush, xScaleAnnotation }
 }
 
 export default useScales
 
 export const getTickValues = (xAxisDataMapped, xScale, num) => {
-  const xDomain = xScale.domain();
-
-  if(xScale.type === 'time'){
-    const xDomainMax = xAxisDataMapped[xAxisDataMapped.length - 1];
-    const xDomainMin = xAxisDataMapped[0];
-    const step = (xDomainMax - xDomainMin) / (num - 1);
-    const tickValues = [];
-    for(let i = xDomainMax; i >= xDomainMin; i -= step){
-      tickValues.push(i);
+  const xDomain = xScale.domain()
+
+  if (xScale.type === 'time') {
+    const xDomainMax = xAxisDataMapped[xAxisDataMapped.length - 1]
+    const xDomainMin = xAxisDataMapped[0]
+    const step = (xDomainMax - xDomainMin) / (num - 1)
+    const tickValues = []
+    for (let i = xDomainMax; i >= xDomainMin; i -= step) {
+      tickValues.push(i)
     }
-    if(tickValues[tickValues.length - 1] !== xDomainMin){
-      tickValues.push(xDomainMin);
+    if (tickValues[tickValues.length - 1] !== xDomainMin) {
+      tickValues.push(xDomainMin)
     }
-    tickValues.reverse();
-    
-    return tickValues;
+    tickValues.reverse()
+
+    return tickValues
   }
 
-  if(xDomain.length > 2){
-    const step = num || 1;
-    const tickValues = [];
-    for(let i = xDomain.length; i > 0; i -= step){
-      const adjustedIndex = Math.max(Math.round(i) - 1, 0);
-      tickValues.push(xDomain[adjustedIndex]);
+  if (xDomain.length > 2) {
+    const step = num || 1
+    const tickValues = []
+    for (let i = xDomain.length; i > 0; i -= step) {
+      const adjustedIndex = Math.max(Math.round(i) - 1, 0)
+      tickValues.push(xDomain[adjustedIndex])
     }
-    tickValues.reverse();
+    tickValues.reverse()
 
-    return tickValues;
+    return tickValues
   }
 }
 

package/src/hooks/useTooltip.tsx

@@ -1,21 +1,18 @@
 import { useContext } from 'react'
+// Local imports
 import ConfigContext from '../ConfigContext'
 import { type ChartContext } from '../types/ChartContext'
-
-// third party
-import { localPoint } from '@visx/event'
-import { bisector } from 'd3-array'
-import { DataTransform } from '@cdc/core/helpers/DataTransform'
-const transform = new DataTransform()
-
 import { formatNumber as formatColNumber } from '@cdc/core/helpers/cove/number'
 import { isDateScale } from '@cdc/core/helpers/cove/date'
+// Third-party library imports
+import { localPoint } from '@visx/event'
+import { bisector } from 'd3-array'
 
 export const useTooltip = props => {
-  const { tableData, config, formatNumber, capitalize, formatDate, formatTooltipsDate, parseDate, setSharedFilter } = useContext<ChartContext>(ConfigContext)
+  const { tableData: data, config, formatNumber, capitalize, formatDate, formatTooltipsDate, parseDate, setSharedFilter, isDraggingAnnotation } = useContext<ChartContext>(ConfigContext)
   const { xScale, yScale, showTooltip, hideTooltip } = props
   const { xAxis, visualizationType, orientation, yAxis, runtime } = config
-  const data = transform.applySuppression(tableData, config.suppressedData)
+
   /**
    * Provides the tooltip information based on the tooltip data array and svg cursor coordinates
    * @function getTooltipInformation
@@ -23,6 +20,44 @@ export const useTooltip = props => {
    * @param {Object} eventSvgCoords - The object containing the SVG coordinates of the event.
    * @return {Object} - The tooltip information with tooltip data.
    */
+
+  // function handles only Single series hovred data tooltips
+  const findDataKeyByThreshold = (mouseY, datapoint) => {
+    let sum = 0
+    let threshold = Number(yScale.invert(mouseY))
+    let hoveredKey = null
+    let hoveredValue = null
+
+    for (let key of config.runtime?.seriesKeys) {
+      if (datapoint.hasOwnProperty(key)) {
+        sum += Number(datapoint[key])
+        if (sum >= threshold) {
+          hoveredValue = datapoint[key]
+          hoveredKey = key
+          break
+        }
+      }
+    }
+
+    // Return null if no matching data is found
+    return [hoveredKey, hoveredValue]
+  }
+
+  const getFormattedValue = (seriesKey, value, config, getAxisPosition) => {
+    // handle case where data is missing
+    const showMissingDataValue = config.general.showMissingDataLabel && (!value || value === 'null')
+    let formattedValue = seriesKey === config.xAxis.dataKey ? value : formatNumber(value, getAxisPosition(seriesKey))
+    formattedValue = showMissingDataValue ? 'N/A' : formattedValue
+
+    const suppressed = config.preliminaryData?.find(pd => pd.label && pd.type === 'suppression' && pd.displayTooltip && value === pd.value && (!pd.column || seriesKey === pd.column))
+
+    if (suppressed) {
+      formattedValue = suppressed.label
+    }
+
+    return formattedValue
+  }
+
   const getTooltipInformation = (tooltipDataArray, eventSvgCoords) => {
     const { x, y } = eventSvgCoords
     let initialTooltipData = tooltipDataArray || {}
@@ -50,6 +85,8 @@ export const useTooltip = props => {
    */
   const handleTooltipMouseOver = (e, additionalChartData) => {
     e.stopPropagation()
+    if (isDraggingAnnotation) return
+
     const eventSvgCoords = localPoint(e)
     const { x, y } = eventSvgCoords
 
@@ -137,18 +174,29 @@ export const useTooltip = props => {
       if (visualizationType === 'Forest Plot') {
         tooltipItems.push([config.xAxis.dataKey, getClosestYValue(y)])
       }
-
-      if (visualizationType !== 'Pie' && visualizationType !== 'Forest Plot') {
+      // handle tooltip for all  hovered series
+      if (visualizationType !== 'Pie' && visualizationType !== 'Forest Plot' && !config.tooltips.singleSeries) {
         tooltipItems.push(
           ...getIncludedTooltipSeries()
-            ?.filter(Boolean)
+            ?.filter(seriesKey => config.series?.find(item => item.dataKey === seriesKey && item?.tooltip) || config.xAxis?.dataKey == seriesKey || visualizationType === 'Forecasting')
             ?.flatMap(seriesKey => {
-              const formattedValue = seriesKey === config.xAxis.dataKey ? resolvedScaleValues[0]?.[seriesKey] : formatNumber(resolvedScaleValues[0]?.[seriesKey], getAxisPosition(seriesKey))
-              return resolvedScaleValues?.[0]?.[seriesKey] ? [[seriesKey, formattedValue, getAxisPosition(seriesKey)]] : []
+              const value = resolvedScaleValues[0]?.[seriesKey]
+              const formattedValue = getFormattedValue(seriesKey, value, config, getAxisPosition)
+              return [[seriesKey, formattedValue, getAxisPosition(seriesKey)]]
             })
         )
       }
 
+      // handle tooltip for single hovered series
+      if (visualizationType !== 'Pie' && visualizationType !== 'Forest Plot' && config.tooltips.singleSeries) {
+        const [seriesKey, value] = findDataKeyByThreshold(y, resolvedScaleValues[0])
+        if (seriesKey && value) {
+          tooltipItems.push([config.xAxis.dataKey, closestXScaleValue])
+          const formattedValue = getFormattedValue(seriesKey, value, config, getAxisPosition)
+          tooltipItems.push([seriesKey, formattedValue])
+        }
+      }
+
       return [...tooltipItems, ...additionalTooltipItems]
     }
 
@@ -323,7 +371,6 @@ export const useTooltip = props => {
       const yScaleValues = dataToSearch.map(object => {
         return Object.fromEntries(Object.entries(object).filter(([key, value]) => includedSeries.includes(key)))
       })
-
       return yScaleValues
     } catch (error) {
       console.error('COVE', error)

package/src/scss/main.scss

@@ -13,9 +13,21 @@
   flex-direction: column-reverse;
 }
 
+.cdc-open-viz-module.type-dashboard {
+  .cdc-open-viz-module.type-chart.isEditor {
+    .cdc-chart-inner-container {
+      background: white;
+    }
+  }
+}
+
 .cdc-open-viz-module.type-chart {
   @import 'DataTable';
 
+  &.isEditor .cdc-chart-inner-container {
+    background: white;
+  }
+
   border-radius: 3px;
 
   .checkbox-group {
@@ -75,11 +87,19 @@
     margin-bottom: 20px;
   }
 
+  .subtext,
+  .subtext--responsive-ticks,
   .section-subtext {
-    padding: 15px;
+    padding: 0 1rem;
+    &--brush-active {
+      margin-top: 2.5em;
+    }
   }
-  .subtext--responsive-ticks {
-    margin-top: 3em;
+
+  .type-pie {
+    svg.animated-pie {
+      width: auto !important;
+    }
   }
 
   .legend-container {
@@ -130,9 +150,6 @@
         word-wrap: break-word;
         white-space: pre-wrap;
         word-break: break-word;
-        @include breakpoint(xs) {
-          font-size: $font-small;
-        }
       }
     }
 
@@ -153,10 +170,8 @@
     h3,
     p {
       margin-bottom: 0.8em;
-      @include breakpoint(xs) {
-        font-size: $font-small + 0.2em;
-      }
     }
+
     & div.legend-item {
       margin-bottom: 0.5em !important;
 
@@ -198,18 +213,47 @@
     }
   }
 
+  .div[class*='Asterisk'] {
+    transform: 0;
+  }
+
   .legend-preliminary {
     display: flex;
     flex-direction: row;
     align-items: center;
-    @include breakpoint(xs) {
-      font-size: $font-small;
+    font-size: 1em;
+    vertical-align: middle;
+    margin-bottom: 0.5em;
+
+    & > span {
+      display: flex;
+      justify-items: center;
+      align-items: center;
+      white-space: nowrap;
+      font-size: 1em;
+      margin-right: 8px;
+      max-height: 1px;
+    }
+
+    & > span[class*='Asterisk'] {
+      transform: scale(1.8);
+      margin-top: 15px;
+    }
+    & > span[class*='Dagger'] {
+      margin-top: 2px;
+    }
+    & > span[class*='Sign'] {
+      margin-top: 1px;
     }
 
     & > svg {
       width: 50px;
       height: 23px;
     }
+
+    & > p {
+      margin: 0;
+    }
   }
 
   .visx-tooltip {
@@ -236,6 +280,17 @@
     &.legend-hidden > svg {
       width: 100% !important;
     }
+    &.dashboard-brush {
+      margin-bottom: 2.5em;
+    }
+
+    svg.dragging-annotation * {
+      user-select: none;
+    }
+
+    svg.dragging-annotation path {
+      pointer-events: none;
+    }
 
     > svg {
       overflow: visible;
@@ -651,8 +706,10 @@
     padding: 1em;
   }
 
-  .subtext {
+  .subtext,
+  .subtext--responsive-ticks {
     margin-top: 0px;
+    padding: 0 1rem;
   }
 
   .isEditor {

package/src/types/ChartConfig.ts

@@ -12,7 +12,10 @@ 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'
+import { VizFilter } from '@cdc/core/types/VizFilter'
+import { type Annotation } from '@cdc/core/types/Annotation'
 
+export type ViewportSize = 'sm' | 'xs' | 'xxs' | 'lg'
 export type ChartColumns = Record<string, Column>
 
 type DataFormat = {
@@ -39,18 +42,6 @@ type Exclusions = {
   dateEnd: string
 }
 
-type Filter = {
-  active: string
-  type: 'url'
-  columnName: string
-  showDropdown: boolean
-  filterStyle: string
-  label: string
-  order: 'asc' | 'desc' | 'cust'
-  values: string[]
-  queryParameter: string
-}
-
 export type Legend = {
   seriesHighlight: string[]
   additionalCategories: string[]
@@ -81,7 +72,8 @@ type Visual = {
   horizontalHoverLine?: boolean
 }
 
-type AllChartsConfig = {
+export type AllChartsConfig = {
+  annotations: Annotation[]
   animate: boolean
   general: General
   barHasBorder: 'true' | 'false'
@@ -109,7 +101,7 @@ type AllChartsConfig = {
   description: string
   dynamicMarginTop: number
   exclusions: Exclusions
-  filters: Filter[]
+  filters: VizFilter[]
   filterBehavior: FilterBehavior
   fontSize: 'small' | 'medium' | 'large'
   footnotes: string
@@ -161,6 +153,7 @@ type AllChartsConfig = {
   twoColor: { palette: string }
   type: 'chart' | 'dashboard'
   useLogScale: boolean
+  uid: string | number
   visual: Visual
   visualizationType: 'Area Chart' | 'Bar' | 'Box Plot' | 'Deviation Bar' | 'Forest Plot' | 'Line' | 'Paired Bar' | 'Pie' | 'Scatter Plot' | 'Spark Line' | 'Combo' | 'Forecasting' | 'Sankey'
   visualizationSubType: string
@@ -198,8 +191,52 @@ export type ForestPlotConfig = {
 } & AllChartsConfig
 
 export type LineChartConfig = {
-  visualizationType: 'Line'
+  allowLineToBarGraph: boolean
+  convertLineToBarGraph: boolean
   lineDatapointStyle: 'hidden' | 'always show' | 'hover'
+  visualizationType: 'Line'
+} & AllChartsConfig
+
+export type SankeyLink = {
+  depth: number
+  height: number
+  id: string
+  index: number
+  layer: number
+  sourceLinks: SankeyLink[]
+  targetLinks: SankeyLink[]
+  value: number
+  x0: number
+  x1: number
+  y0: number
+  y1: number
+}
+
+type StoryNode = {
+  StoryNode: string
+  segmentTextAfter: string
+  segmentTextBefore: string
+}
+
+export type SankeyChartConfig = {
+  enableTooltips: boolean
+  data: [
+    {
+      tooltips: Object[]
+      // data to display in the sankey chart tooltips
+      tooltipData: Object[]
+      // data to display in the data table, bypasses the default data table output
+      tableData: Object[]
+      links: {
+        source: SankeyLink
+        target: SankeyLink
+        value: number
+      }[],
+      storyNodeText: StoryNode[]
+:
+    }
+  ]
+  visualizationType: 'Sankey'
 } & AllChartsConfig
 
-export type ChartConfig = LineChartConfig | ForestPlotConfig | AllChartsConfig
+export type ChartConfig = SankeyChartConfig | LineChartConfig | ForestPlotConfig | AllChartsConfig

package/src/types/ChartContext.ts

@@ -1,6 +1,7 @@
 import { type ChartConfig } from './ChartConfig'
 import { PickD3Scale } from '@visx/scale'
 import { type SharedFilter } from '@cdc/dashboard/src/types/SharedFilter'
+import { type Annotation } from '@cdc/core/types/Annotation'
 
 export type ColorScale = PickD3Scale<'ordinal', any, any>
 
@@ -21,10 +22,21 @@ type SharedChartContext = {
   legendIsolateValues?: string[]
   setLegendIsolateValues?: Function
   getTextWidth?: () => string | number
+  brushConfig: { data: []; isBrushing: boolean; isActive: boolean }
+  setBrushConfig: Function
+  clean: Function
+  capitalize: (value: string) => string
+  // whether or not the legend is appearing below the chart
+  isLegendBottom?: boolean
+  // whether or not the chart is viewed within the editor screen
+  isEditor?: boolean
+  // whether or not the user is dragging an annotation
+  isDraggingAnnotation?: boolean
 }
 
 // Line Chart Specific Context
 type LineChartContext = SharedChartContext & {
+  convertLineToBarGraph: boolean
   dimensions: [screenWidth: number, screenHeight: number]
   formatDate: Function
   formatTooltipsDate: Function
@@ -46,6 +58,7 @@ type LineChartContext = SharedChartContext & {
 export type ChartContext =
   | LineChartContext
   | (SharedChartContext & {
+      annotations: Annotation[]
       dimensions: [screenWidth: number, screenHeight: number]
       formatDate?: Function
       formatTooltipsDate: Function

package/tests-examples/helpers/testZeroValue.test.ts

@@ -0,0 +1,30 @@
+import { testZeroValue } from '../../src/components/BarChart/helpers'
+
+describe('testZeroValue', () => {
+  test('returns true for "0" as string', () => {
+    expect(testZeroValue('0')).toBe(true)
+  })
+
+  test('returns true for "0" as number', () => {
+    expect(testZeroValue(0)).toBe(true)
+  })
+
+  test('returns true for 0.0 as number', () => {
+    expect(testZeroValue(0.0)).toBe(true)
+  })
+
+  // check false case
+  test('returns false for "ABC" as string', () => {
+    expect(testZeroValue('ABC')).toBe(false)
+  })
+  test('returns false for 999 as number', () => {
+    expect(testZeroValue(999)).toBe(false)
+  })
+  // test for null & undefined cases
+  test('returns undefined for a null', () => {
+    expect(testZeroValue(null)).toBe(undefined)
+  })
+  test('returns undefined for a undefined', () => {
+    expect(testZeroValue(undefined)).toBe(undefined)
+  })
+})