@cdc/chart 4.24.7 → 4.24.9

package/src/hooks/useTooltip.tsx

@@ -9,7 +9,17 @@ import { localPoint } from '@visx/event'
 import { bisector } from 'd3-array'
 
 export const useTooltip = props => {
-  const { tableData: data, config, formatNumber, capitalize, formatDate, formatTooltipsDate, parseDate, setSharedFilter, isDraggingAnnotation } = 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
 
@@ -47,13 +57,11 @@ export const useTooltip = props => {
     // 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
-    }
+    formattedValue =
+      showMissingDataValue && (config.visualizationSubType === 'stacked' ? !config.general.hideNullValue : true)
+        ? 'N/A'
+        : formattedValue
 
     return formattedValue
   }
@@ -84,6 +92,7 @@ export const useTooltip = props => {
    * @return {void} - The tooltip information is displayed
    */
   const handleTooltipMouseOver = (e, additionalChartData) => {
+    if (visualizationType === 'Bump Chart') return
     e.stopPropagation()
     if (isDraggingAnnotation) return
 
@@ -95,10 +104,13 @@ export const useTooltip = props => {
 
     const closestXScaleValue = getXValueFromCoordinate(x - Number(config.yAxis.size || 0))
 
-    const includedSeries = visualizationType !== 'Pie' ? config.series.filter(series => series.tooltip === true).map(item => item.dataKey) : config.series.map(item => item.dataKey)
+    const includedSeries =
+      visualizationType !== 'Pie'
+        ? config.runtime.series.filter(series => series.tooltip === true).map(item => item.dataKey)
+        : config.runtime.series.map(item => item.dataKey)
     includedSeries.push(config.xAxis.dataKey)
     if (config.visualizationType === 'Forecasting') {
-      config.series.map(s => {
+      config.runtime.series.map(s => {
         s.confidenceIntervals.map(c => {
           if (c.showInTooltip) {
             includedSeries.push(c.high)
@@ -125,7 +137,7 @@ export const useTooltip = props => {
     const resolvedScaleValues = orientation === 'vertical' ? yScaleValues : xScaleValues
 
     const getAxisPosition = seriesKey => {
-      const seriesObj = config.series.filter(s => s.dataKey === seriesKey)[0]
+      const seriesObj = config.runtime.series.filter(s => s.dataKey === seriesKey)[0]
       const position = seriesObj?.axis ? String(seriesObj.axis).toLowerCase() : 'left'
       return position
     }
@@ -178,7 +190,12 @@ export const useTooltip = props => {
       if (visualizationType !== 'Pie' && visualizationType !== 'Forest Plot' && !config.tooltips.singleSeries) {
         tooltipItems.push(
           ...getIncludedTooltipSeries()
-            ?.filter(seriesKey => config.series?.find(item => item.dataKey === seriesKey && item?.tooltip) || config.xAxis?.dataKey == seriesKey || visualizationType === 'Forecasting')
+            ?.filter(
+              seriesKey =>
+                config.runtime.series?.find(item => item.dataKey === seriesKey && item?.tooltip) ||
+                config.xAxis?.dataKey == seriesKey ||
+                visualizationType === 'Forecasting'
+            )
             ?.flatMap(seriesKey => {
               const value = resolvedScaleValues[0]?.[seriesKey]
               const formattedValue = getFormattedValue(seriesKey, value, config, getAxisPosition)
@@ -275,7 +292,10 @@ export const useTooltip = props => {
       return closestX
     }
 
-    if (config.xAxis.type === 'categorical' || (visualizationType === 'Combo' && orientation !== 'horizontal' && visualizationType !== 'Forest Plot')) {
+    if (
+      config.xAxis.type === 'categorical' ||
+      (visualizationType === 'Combo' && orientation !== 'horizontal' && visualizationType !== 'Forest Plot')
+    ) {
       let range = xScale.range()[1] - xScale.range()[0]
       let eachBand = range / (xScale.domain().length + 1)
 
@@ -323,6 +343,7 @@ export const useTooltip = props => {
       // Get the closest x axis value from the pointer.
       // After getting the closest value, return the data entry with that x scale value.
       // Pass the config.visual uid (not uuid) along with that data entry to setSharedFilters
+      if (config.visualizationType === 'Bump Chart') return
       const eventSvgCoords = localPoint(e)
       const { x } = eventSvgCoords
       if (!x) throw new Error('COVE: no x value in handleTooltipClick.')
@@ -392,7 +413,7 @@ export const useTooltip = props => {
 
       // loop through series for items to add to tooltip.
       // there is probably a better way of doing this.
-      config.series?.forEach(s => {
+      config.runtime.series?.forEach(s => {
         if (s.type === 'Forecasting') {
           stageColumns.push(s.stageColumn)
 
@@ -420,7 +441,10 @@ export const useTooltip = props => {
             standardLoopItems = [runtime.xAxis.dataKey, ...runtime?.seriesKeys]
             break
           case 'Bar':
-            standardLoopItems = orientation === 'vertical' ? [runtime.xAxis.dataKey, ...runtime?.seriesKeys] : [runtime.yAxis.dataKey, ...runtime?.seriesKeys]
+            standardLoopItems =
+              orientation === 'vertical'
+                ? [runtime.xAxis.dataKey, ...runtime?.seriesKeys]
+                : [runtime.yAxis.dataKey, ...runtime?.seriesKeys]
             break
           case 'Pie':
             standardLoopItems = [runtime.xAxis.dataKey, ...runtime?.seriesKeys]
@@ -430,7 +454,13 @@ export const useTooltip = props => {
       }
 
       if (config.dashboard) {
-        standardLoopItems = [runtime.xAxis.dataKey, ...runtime?.barSeriesKeys, ...runtime?.lineSeriesKeys, ...stageColumns, ...ciItems]
+        standardLoopItems = [
+          runtime.xAxis.dataKey,
+          ...runtime?.barSeriesKeys,
+          ...runtime?.lineSeriesKeys,
+          ...stageColumns,
+          ...ciItems
+        ]
       }
 
       return standardLoopItems
@@ -463,7 +493,7 @@ export const useTooltip = props => {
    * @returns user defined series name.
    */
   const getSeriesNameFromLabel = originalColumnName => {
-    let series = config.series.filter(s => s.dataKey === originalColumnName)
+    let series = config.runtime.series.filter(s => s.dataKey === originalColumnName)
     if (series[0]?.name) return series[0]?.name
     return originalColumnName
   }
@@ -473,18 +503,51 @@ export const useTooltip = props => {
     const [key, value, axisPosition] = additionalData
 
     if (visualizationType === 'Forest Plot') {
-      if (key === config.xAxis.dataKey) return <li className='tooltip-heading'>{`${capitalize(config.xAxis.dataKey ? `${config.xAxis.dataKey}: ` : '')} ${isDateScale(yAxis) ? formatDate(parseDate(key, false)) : value}`}</li>
+      if (key === config.xAxis.dataKey)
+        return (
+          <li className='tooltip-heading'>{`${capitalize(config.xAxis.dataKey ? `${config.xAxis.dataKey}: ` : '')} ${
+            isDateScale(yAxis) ? formatDate(parseDate(key, false)) : value
+          }`}</li>
+        )
       return <li className='tooltip-body'>{`${getSeriesNameFromLabel(key)}: ${formatNumber(value, 'left')}`}</li>
     }
-    const formattedDate = config.tooltips.dateDisplayFormat ? formatTooltipsDate(parseDate(value, false)) : formatDate(parseDate(value, false))
+    const formattedDate = config.tooltips.dateDisplayFormat
+      ? formatTooltipsDate(parseDate(value, false))
+      : formatDate(parseDate(value, false))
 
     // TOOLTIP HEADING
-    if (visualizationType === 'Bar' && orientation === 'horizontal' && key === config.xAxis.dataKey) return <li className='tooltip-heading'>{`${capitalize(config.runtime.yAxis.label ? `${config.runtime.yAxis.label}: ` : '')} ${config.xAxis.type === 'date' ? formattedDate : value}`}</li>
-
-    if (key === config.xAxis.dataKey) return <li className='tooltip-heading'>{`${capitalize(config.runtime.xAxis.label ? `${config.runtime.xAxis.label}: ` : '')} ${isDateScale(xAxis) ? formattedDate : value}`}</li>
+    if (visualizationType === 'Bar' && orientation === 'horizontal' && key === config.xAxis.dataKey)
+      return (
+        <li className='tooltip-heading'>{`${capitalize(
+          config.runtime.yAxis.label ? `${config.runtime.yAxis.label}: ` : ''
+        )} ${config.xAxis.type === 'date' ? formattedDate : value}`}</li>
+      )
+
+    if (key === config.xAxis.dataKey)
+      return (
+        <li className='tooltip-heading'>{`${capitalize(
+          config.runtime.xAxis.label ? `${config.runtime.xAxis.label}: ` : ''
+        )} ${isDateScale(xAxis) ? formattedDate : value}`}</li>
+      )
 
     // TOOLTIP BODY
-    return <li className='tooltip-body'>{`${getSeriesNameFromLabel(key)}: ${value}`}</li>
+    // handle suppressed tooltip items
+    const { label, displayGray } =
+      (config.visualizationSubType !== 'stacked' &&
+        config.general.showSuppressedSymbol &&
+        config.preliminaryData?.find(
+          pd =>
+            pd.label &&
+            pd.type === 'suppression' &&
+            pd.displayTooltip &&
+            value === pd.value &&
+            (!pd.column || key === pd.column)
+        )) ||
+      {}
+    const newValue = label || value
+    const style = displayGray ? { color: '#8b8b8a' } : {}
+
+    return <li style={style} className='tooltip-body'>{`${getSeriesNameFromLabel(key)}: ${newValue}`}</li>
   }
 
   return {

package/src/scss/DataTable.scss

@@ -1,6 +1,7 @@
 @include breakpointClass(md) {
   .data-table-container {
-    margin: 5px 1em;
+    margin: 5px 0em;
+    width: 100%;
   }
 }
 

package/src/scss/main.scss

@@ -24,6 +24,28 @@
 .cdc-open-viz-module.type-chart {
   @import 'DataTable';
 
+  .legend-top {
+    .legend-wrapper .tooltip-boundary {
+      display: flex;
+      flex-wrap: wrap;
+      order: 2;
+      aside {
+        width: 100%;
+        order: 1;
+      }
+    }
+  }
+
+  .legend-bottom {
+    .legend-wrapper {
+      display: flex;
+      flex-wrap: wrap;
+      aside {
+        width: 100%;
+      }
+    }
+  }
+
   &.isEditor .cdc-chart-inner-container {
     background: white;
   }
@@ -90,7 +112,6 @@
   .subtext,
   .subtext--responsive-ticks,
   .section-subtext {
-    padding: 0 1rem;
     &--brush-active {
       margin-top: 2.5em;
     }
@@ -109,15 +130,20 @@
     vertical-align: top;
     text-align: left;
     border: 1px solid $lightGray;
-    order: 1;
     position: relative;
 
+    &.no-border {
+      border: 1px solid transparent;
+    }
+
     &__inner {
-      &.bottom {
+      &.double-column,
+      &.single-row {
         display: grid;
         grid-template-columns: 1fr 1fr;
         grid-column-gap: 1.5em;
       }
+
       &.vertical-sorted {
         display: block;
 
@@ -151,6 +177,10 @@
         white-space: pre-wrap;
         word-break: break-word;
       }
+
+      & > :first-child {
+        margin-top: 3px;
+      }
     }
 
     .vertical-sorted:not(.single-row) .legend-item {
@@ -189,6 +219,23 @@
         transition: 0.2s all;
       }
     }
+
+    &__outer {
+      &.definition-link {
+        display: flex;
+        flex-direction: row;
+        position: absolute;
+        left: 0%;
+        top: 108%;
+        & > * {
+          margin: 0;
+        }
+        & > p,
+        a {
+          margin-left: 5px;
+        }
+      }
+    }
   }
 
   .dynamic-legend-list {
@@ -272,7 +319,61 @@
     display: flex;
     align-items: flex-start;
     flex-wrap: wrap;
+    justify-content: space-between;
+
+    &.legend-top:not(.legend-hidden) {
+      .legend-wrapper {
+        & > div {
+          order: 2;
+          width: 100%;
+        }
+        aside {
+          width: 100%;
+          order: 1;
+          height: fit-content;
+        }
+      }
+    }
 
+    &.legend-left:not(.legend-hidden) {
+      .legend-wrapper {
+        & > div {
+          order: 2;
+          width: 75%;
+        }
+        aside {
+          width: 25%;
+          order: 1;
+          height: fit-content;
+        }
+      }
+    }
+
+    &.legend-right:not(.legend-hidden) {
+      .legend-wrapper {
+        & > div {
+          order: 1;
+          width: 75%;
+        }
+        aside {
+          width: 25%;
+          height: fit-content;
+          order: 2;
+        }
+      }
+    }
+
+    &.left {
+      display: flex;
+      flex-direction: row-reverse;
+    }
+    &.top {
+      flex-wrap: nowrap;
+      flex-direction: column-reverse;
+      & > div.tooltip-boundary {
+        margin-top: 1.5em;
+      }
+    }
     &.bottom {
       flex-wrap: nowrap;
       flex-direction: column;
@@ -422,15 +523,7 @@
   }
 
   @include breakpointClass(md) {
-    .filters-section,
-    .chart-container:not(.sparkline) {
-      margin-left: 1em;
-      margin-right: 1em;
-    }
-
     .chart-container {
-      flex-wrap: nowrap;
-
       .no-wrap {
         flex-wrap: nowrap;
       }
@@ -438,14 +531,15 @@
       .legend-container {
         width: 25%;
         margin-left: 1em;
-        order: 2;
+        height: fit-content;
 
         &.left {
           margin-left: 0;
           margin-right: 1em;
           order: 0;
         }
-        &.bottom {
+        &.bottom,
+        &.top {
           width: 100%;
           margin-left: 0;
         }
@@ -709,7 +803,6 @@
   .subtext,
   .subtext--responsive-ticks {
     margin-top: 0px;
-    padding: 0 1rem;
   }
 
   .isEditor {

package/src/types/ChartConfig.ts

@@ -8,16 +8,34 @@ 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'
+
 import { VizFilter } from '@cdc/core/types/VizFilter'
 import { type Annotation } from '@cdc/core/types/Annotation'
 
-export type ViewportSize = 'sm' | 'xs' | 'xxs' | 'lg'
+export type ViewportSize = 'xxs' | 'xs' | 'sm' | 'md' | 'lg'
 export type ChartColumns = Record<string, Column>
 
+export interface PreliminaryDataItem {
+  column: string
+  displayLegend: boolean
+  displayTable: boolean
+  displayTooltip: boolean
+  iconCode: string
+  label: string
+  lineCode: string
+  seriesKey: string
+  style: string
+  symbol: string
+  type: 'effect' | 'suppression'
+  value: string
+  hideBarSymbol: boolean
+  hideLineStyle: boolean
+  circleSize: number
+  displayGray: boolean
+}
+
 type DataFormat = {
   abbreviated: boolean
   bottomAbbreviated: boolean
@@ -54,12 +72,20 @@ export type Legend = {
   hide: boolean
   highlightOnHover: boolean
   label: string
-  lineMode: boolean
-  position: string
+  position: 'left' | 'bottom' | 'top' | 'right'
   reverseLabelOrder: boolean
   singleRow: boolean
   type: string
   verticalSorted: boolean
+  hideSuppressionLink:boolean
+  style:'circles'|'boxes'|'gradient'|'lines'
+  subStyle:'linear blocks'|'smooth'
+  hideSuppressedLabels:boolean
+  tickRotation:string
+  hideBorder:{
+    side:boolean
+    topBottom:boolean
+  }
 }
 
 type Visual = {
@@ -79,7 +105,7 @@ export type AllChartsConfig = {
   barHasBorder: 'true' | 'false'
   barHeight: number
   barSpace: number
-  barStyle: string
+  barStyle: 'lollipop'|'rounded'|'flat'
   barThickness: number
   boxplot: BoxPlot
   brush: {
@@ -109,6 +135,7 @@ export type AllChartsConfig = {
   formattedData: Object[] & { urlFiltered: boolean }
   heights: {
     vertical: number
+    mobileVertical: number
   }
   highlightedBarValues: { value: any; color: string; borderWidth: number; legendLabel: string }[]
   introText: string
@@ -152,10 +179,9 @@ export type AllChartsConfig = {
   topAxis: { hasLine: boolean }
   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'
+  visualizationType: 'Area Chart' | 'Bar' | 'Box Plot' | 'Deviation Bar' | 'Forest Plot' | 'Line' | 'Paired Bar' | 'Pie' | 'Scatter Plot' | 'Spark Line' | 'Combo' | 'Forecasting' | 'Sankey' | 'Bump Chart'
   visualizationSubType: string
   xAxis: Axis
   yAxis: Axis

package/src/types/ChartContext.ts

@@ -2,6 +2,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'
+import { DimensionsType } from '@cdc/core/types/Dimensions'
 
 export type ColorScale = PickD3Scale<'ordinal', any, any>
 
@@ -16,12 +17,12 @@ type SharedChartContext = {
   handleChartAriaLabels: (config: any) => string
   colorScale?: ColorScale
   config: ChartConfig
-  currentViewport?: string
+  currentViewport?: 'lg' | 'md' | 'sm' | 'xs' | 'xxs'
   highlight?: Function
   highlightReset?: Function
   legendIsolateValues?: string[]
   setLegendIsolateValues?: Function
-  getTextWidth?: () => string | number
+  getTextWidth?: (a: string, b: string) => string
   brushConfig: { data: []; isBrushing: boolean; isActive: boolean }
   setBrushConfig: Function
   clean: Function
@@ -37,7 +38,7 @@ type SharedChartContext = {
 // Line Chart Specific Context
 type LineChartContext = SharedChartContext & {
   convertLineToBarGraph: boolean
-  dimensions: [screenWidth: number, screenHeight: number]
+  dimensions: DimensionsType
   formatDate: Function
   formatTooltipsDate: Function
   formatNumber: Function
@@ -59,7 +60,7 @@ export type ChartContext =
   | LineChartContext
   | (SharedChartContext & {
       annotations: Annotation[]
-      dimensions: [screenWidth: number, screenHeight: number]
+      dimensions: DimensionsType
       formatDate?: Function
       formatTooltipsDate: Function
       formatNumber?: Function