@cdc/chart 4.23.2 → 4.23.4

package/src/components/BoxPlot.jsx

@@ -1,17 +1,24 @@
-import React, { useContext } from 'react'
+import React, { useContext, useEffect } from 'react'
 import { BoxPlot } from '@visx/stats'
 import { Group } from '@visx/group'
-import { scaleBand, scaleLinear } from '@visx/scale'
 import ConfigContext from '../ConfigContext'
 import ErrorBoundary from '@cdc/core/components/ErrorBoundary'
 import { colorPalettesChart } from '@cdc/core/data/colorPalettes'
 
 const CoveBoxPlot = ({ xScale, yScale }) => {
-  const { transformedData: data, config } = useContext(ConfigContext)
+  const { config, setConfig } = useContext(ConfigContext)
 
-  const boxWidth = xScale.bandwidth()
-  const constrainedWidth = Math.min(40, boxWidth)
-  const color_0 = colorPalettesChart[config?.palette][0] ? colorPalettesChart[config?.palette][0] : '#000'
+  useEffect(() => {
+    if (config.legend.hide === false) {
+      setConfig({
+        ...config,
+        legend: {
+          ...config.legend,
+          hide: true
+        }
+      })
+    }
+  }, []) // eslint-disable-line
 
   // tooltips
   const tooltip_id = `cdc-open-viz-tooltip-${config.runtime.uniqueId}`
@@ -24,6 +31,18 @@ const CoveBoxPlot = ({ xScale, yScale }) => {
       ${config.boxplot.labels.median}: ${d.columnMedian}
     `
   }
+
+  //  accessors & constants
+  const max = d => Number(d.columnMax)
+  const min = d => Number(d.columnMin)
+  const median = d => Number(d.columnMedian)
+  const thirdQuartile = d => Number(d.columnThirdQuartile)
+  const firstQuartile = d => Number(d.columnFirstQuartile)
+  const fillOpacity = 0.5
+  const boxWidth = xScale.bandwidth()
+  const constrainedWidth = Math.min(40, boxWidth)
+  const color_0 = colorPalettesChart[config?.palette][0] ? colorPalettesChart[config?.palette][0] : '#000'
+
   return (
     <ErrorBoundary component='BoxPlot'>
       <Group className='boxplot' key={`boxplot-group`}>
@@ -31,20 +50,23 @@ const CoveBoxPlot = ({ xScale, yScale }) => {
           const offset = boxWidth - constrainedWidth
           const radius = 4
           return (
-            <>
-              {config.boxplot.plotNonOutlierValues && d.nonOutlierValues.map(value => <circle cx={xScale(d.columnCategory) + config.yAxis.size + boxWidth / 2} cy={yScale(value)} r={radius} fill={'#ccc'} style={{ opacity: 1, fillOpacity: 1, stroke: 'black' }} />)}
+            <Group key={`boxplotplot-${i}`}>
+              {config.boxplot.plotNonOutlierValues &&
+                d.nonOutlierValues.map((value, index) => {
+                  return <circle cx={xScale(d.columnCategory) + Number(config.yAxis.size) + boxWidth / 2} cy={yScale(value)} r={radius} fill={'#ccc'} style={{ opacity: 1, fillOpacity: 1, stroke: 'black' }} key={`boxplot-${i}--circle-${index}`} />
+                })}
               <BoxPlot
                 data-left={xScale(d.columnCategory) + config.yAxis.size + offset / 2 + 0.5}
                 key={`box-plot-${i}`}
-                min={d.columnMin}
-                max={d.columnMax}
-                left={xScale(d.columnCategory) + config.yAxis.size + offset / 2 + 0.5}
-                firstQuartile={d.columnFirstQuartile}
-                thirdQuartile={d.columnThirdQuartile}
-                median={d.columnMedian}
+                min={min(d)}
+                max={max(d)}
+                left={Number(xScale(d.columnCategory)) + Number(config.yAxis.size) + offset / 2 + 0.5}
+                firstQuartile={firstQuartile(d)}
+                thirdQuartile={thirdQuartile(d)}
+                median={median(d)}
                 boxWidth={constrainedWidth}
                 fill={color_0}
-                fillOpacity={0.5}
+                fillOpacity={fillOpacity}
                 stroke='black'
                 valueScale={yScale}
                 outliers={config.boxplot.plotOutlierValues ? d.columnOutliers : []}
@@ -63,8 +85,7 @@ const CoveBoxPlot = ({ xScale, yScale }) => {
                   style: {
                     stroke: 'black',
                     strokeWidth: config.boxplot.borders === 'true' ? 1 : 0
-                  },
-                  'data-tooltip-html': 'cool'
+                  }
                 }}
                 maxProps={{
                   style: {
@@ -77,7 +98,7 @@ const CoveBoxPlot = ({ xScale, yScale }) => {
                   'data-tooltip-id': tooltip_id
                 }}
               />
-            </>
+            </Group>
           )
         })}
       </Group>

package/src/components/DataTable.jsx

@@ -12,10 +12,7 @@ import ConfigContext from '../ConfigContext'
 import CoveMediaControls from '@cdc/core/components/CoveMediaControls'
 
 export default function DataTable() {
-  const { rawData, transformedData: data, config, colorScale, parseDate, formatDate, formatNumber: numberFormatter, colorPalettes, imageId } = useContext(ConfigContext)
-
-  // Debugging.
-  // if (config.visualizationType === 'Box Plot') return null
+  const { rawData, tableData: data, config, colorScale, parseDate, formatDate, formatNumber: numberFormatter, colorPalettes } = useContext(ConfigContext)
 
   const section = config.orientation === 'horizontal' ? 'yAxis' : 'xAxis'
   const [tableExpanded, setTableExpanded] = useState(config.table.expanded)
@@ -38,7 +35,7 @@ export default function DataTable() {
     switch (type) {
       case 'download':
         return (
-          <a download={fileName} onClick={saveBlob} href={`data:text/csv;base64,${Base64.encode(csvData)}`} aria-label='Download this data in a CSV file format.' className={`btn btn-download no-border`}>
+          <a download={fileName} onClick={saveBlob} href={`data:text/csv;base64,${Base64.encode(csvData)}`} aria-label='Download this data in a CSV file format.' className={`btn btn-download no-border margin-sm`}>
             Download Data (CSV)
           </a>
         )
@@ -57,7 +54,7 @@ export default function DataTable() {
       config.visualizationType === 'Pie'
         ? []
         : config.visualizationType === 'Box Plot'
-          ? [
+        ? [
             {
               Header: 'Measures',
               Cell: props => {
@@ -76,9 +73,11 @@ export default function DataTable() {
                     columnThirdQuartile: labels.q3,
                     columnOutliers: labels.outliers,
                     values: labels.values,
-                    columnCount: labels.count,
+                    columnTotal: labels.total,
                     columnSd: 'Standard Deviation',
-                    nonOutlierValues: 'Non Outliers'
+                    nonOutlierValues: 'Non Outliers',
+                    columnLowerBounds: labels.lowerBounds,
+                    columnUpperBounds: labels.upperBounds
                   }
 
                   let resolvedName = columnLookup[props.row.original[0]]
@@ -90,7 +89,7 @@ export default function DataTable() {
               }
             }
           ]
-          : [
+        : [
             {
               Header: '',
               Cell: ({ row }) => {
@@ -105,8 +104,8 @@ export default function DataTable() {
                             ? colorScale(seriesLabel)
                             : // dynamic legend
                             config.legend.dynamicLegend
-                              ? colorPalettes[config.palette][row.index]
-                              : // fallback
+                            ? colorPalettes[config.palette][row.index]
+                            : // fallback
                               '#000'
                         }
                       />
@@ -122,12 +121,13 @@ export default function DataTable() {
       data.forEach((d, index) => {
         const resolveTableHeader = () => {
           if (config.runtime[section].type === 'date') return formatDate(parseDate(d[config.runtime.originalXAxis.dataKey]))
+          if (config.runtime[section].type === 'continuous') return numberFormatter(d[config.runtime.originalXAxis.dataKey], 'bottom')
           return d[config.runtime.originalXAxis.dataKey]
         }
         const newCol = {
           Header: resolveTableHeader(),
           Cell: ({ row }) => {
-            return <>{numberFormatter(d[row.original])}</>
+            return <>{numberFormatter(d[row.original], 'left')}</>
           },
           id: `${d[config.runtime.originalXAxis.dataKey]}--${index}`,
           canSort: true
@@ -149,7 +149,7 @@ export default function DataTable() {
               if (Number(props.row.id) === 3) return plot.columnMedian
               if (Number(props.row.id) === 4) return plot.columnFirstQuartile
               if (Number(props.row.id) === 5) return plot.columnMin
-              if (Number(props.row.id) === 6) return plot.columnCount
+              if (Number(props.row.id) === 6) return plot.columnTotal
               if (Number(props.row.id) === 7) return plot.columnSd
               if (Number(props.row.id) === 8) return plot.columnMean
               if (Number(props.row.id) === 9) return plot.columnOutliers.length > 0 ? plot.columnOutliers.toString() : '-'
@@ -162,12 +162,12 @@ export default function DataTable() {
           canSort: false
         }
 
-        newTableColumns.push(newCol)
+        return newTableColumns.push(newCol)
       })
     }
 
     return newTableColumns
-  }, [config, colorScale])
+  }, [config, colorScale]) // eslint-disable-line
 
   // prettier-ignore
   const tableData = useMemo(() => (
@@ -176,7 +176,7 @@ export default function DataTable() {
       : config.visualizationType === 'Box Plot'
         ? Object.entries(config.boxplot.tableData[0])
         : config.runtime.seriesKeys),
-    [config.runtime.seriesKeys])
+    [config.runtime.seriesKeys]) // eslint-disable-line
 
   // Change accessibility label depending on expanded status
   useEffect(() => {
@@ -201,8 +201,13 @@ export default function DataTable() {
     }),
     []
   )
-
   const { getTableProps, getTableBodyProps, headerGroups, rows, prepareRow } = useTable({ columns: tableColumns, data: tableData, defaultColumn }, useSortBy, useBlockLayout, useResizeColumns)
+
+  // sort continuous x axis scaling for data tables, ie. xAxis should read 1,2,3,4,5
+  if (config.xAxis.type === 'continuous' && headerGroups) {
+    data.sort((a, b) => a[config.xAxis.dataKey] - b[config.xAxis.dataKey])
+  }
+
   return (
     <ErrorBoundary component='DataTable'>
       <CoveMediaControls.Section classes={['download-links']}>
@@ -224,13 +229,12 @@ export default function DataTable() {
             }
           }}
         >
-          <Icon display={tableExpanded ? 'minus' : 'plus'} base/>
+          <Icon display={tableExpanded ? 'minus' : 'plus'} base />
           {config.table.label}
         </div>
         <div className='table-container' hidden={!tableExpanded} style={{ maxHeight: config.table.limitHeight && `${config.table.height}px`, overflowY: 'scroll' }}>
           <table className={tableExpanded ? 'data-table' : 'data-table cdcdataviz-sr-only'} {...getTableProps()} aria-rowcount={config?.series?.length ? config?.series?.length : '-1'}>
-            <caption className='cdcdataviz-sr-only'>{config.table.caption ? config.table.caption : ''}</caption>
-            <caption className='visually-hidden'>{config.table.label}</caption>
+            <caption className='cdcdataviz-sr-only visually-hidden'>{config.table.caption ? config.table.caption : config.table.label ? config.table.label : 'Data Table'}</caption>
             <thead>
               {headerGroups.map((headerGroup, index) => (
                 <tr {...headerGroup.getHeaderGroupProps()} key={`headerGroups--${index}`}>
@@ -272,7 +276,7 @@ export default function DataTable() {
               })}
             </tbody>
           </table>
-          {config.regions && config.regions.length > 0 ? (
+          {config.regions && config.regions.length > 0 && config.visualizationType !== 'Box Plot' ? (
             <table className='region-table data-table'>
               <caption className='visually-hidden'>Table of the highlighted regions in the visualization</caption>
               <thead>
@@ -284,6 +288,7 @@ export default function DataTable() {
               </thead>
               <tbody>
                 {config.regions.map((region, index) => {
+                  if (config.visualizationType === 'Box Plot') return false
                   if (!Object.keys(region).includes('from') || !Object.keys(region).includes('to')) return null
 
                   return (

package/src/components/DeviationBar.jsx

@@ -0,0 +1,191 @@
+import { Line } from '@visx/shape'
+import { Group } from '@visx/group'
+import { useContext, useEffect } from 'react'
+import ConfigContext from '../ConfigContext'
+import { Text } from '@visx/text'
+import ErrorBoundary from '@cdc/core/components/ErrorBoundary'
+import chroma from 'chroma-js'
+
+// create function to position text based where bar is located left/or right
+function getTextProps(isLollipopChart, textFits, lollipopShapeSize, fill) {
+  if (isLollipopChart) {
+    return {
+      right: {
+        textAnchor: 'start',
+        dx: lollipopShapeSize + 6,
+        fill: '#000000'
+      },
+      left: {
+        textAnchor: 'end',
+        dx: -lollipopShapeSize,
+        fill: '#000000'
+      }
+    }
+  } else {
+    return {
+      right: {
+        textAnchor: textFits ? 'end' : 'start',
+        dx: textFits ? -6 : 6,
+        fill: textFits ? fill : '#000000'
+      },
+      left: {
+        textAnchor: textFits ? 'start' : 'end',
+        dx: textFits ? 6 : -6,
+        fill: textFits ? fill : '#000000'
+      }
+    }
+  }
+}
+
+export function DeviationBar({ height, xScale }) {
+  const { transformedData: data, config, formatNumber, twoColorPalette, getTextWidth, updateConfig, parseDate, formatDate } = useContext(ConfigContext)
+
+  if (!config || config?.series?.length !== 1 || config.orientation !== 'horizontal') return
+
+  const { barStyle, tipRounding, roundingStyle, twoColor } = config
+
+  const radius = roundingStyle === 'standard' ? '8px' : roundingStyle === 'shallow' ? '5px' : roundingStyle === 'finger' ? '15px' : '0px'
+  const fontSize = { small: 16, medium: 18, large: 20 }
+  const isRounded = config.barStyle === 'rounded'
+  const target = Number(config.xAxis.target)
+  const seriesKey = config.series[0].dataKey
+  const maxVal = Number(xScale.domain()[1])
+  const hasNegativeValues = data.some(d => d[seriesKey] < 0)
+  const shouldShowTargetLine = hasNegativeValues || target > 0 || xScale.domain()[0] < 0
+  const borderWidth = config.barHasBorder === 'true' ? 1 : 0
+  const lollipopBarHeight = config.lollipopSize === 'large' ? 7 : config.lollipopSize === 'medium' ? 6 : 5
+  const lollipopShapeSize = config.lollipopSize === 'large' ? 14 : config.lollipopSize === 'medium' ? 12 : 10
+
+  const targetX = Math.max(xScale(0), Math.min(xScale(target), xScale(maxVal)))
+
+  const applyRadius = barPosition => {
+    if (barPosition === undefined || barPosition === null || barStyle !== 'rounded') return
+    let style = {}
+    if (barPosition === 'left') {
+      style = { borderRadius: `${radius} 0 0 ${radius}` }
+    }
+
+    if (barPosition === 'right') {
+      style = { borderRadius: `0 ${radius} ${radius} 0` }
+    }
+    if (tipRounding === 'full') {
+      style = { borderRadius: radius }
+    }
+
+    return style
+  }
+
+  const targetLabel = {
+    calculate: function () {
+      const firstBarValue = data[0][seriesKey]
+      const barPosition = firstBarValue < target ? 'left' : 'right'
+      const label = `${config.xAxis.targetLabel} ${formatNumber(config.xAxis.target || 0, 'left')}`
+      const labelWidth = getTextWidth(label, `bold ${fontSize[config.fontSize]}px sans-serif`)
+      let labelY = config.isLollipopChart ? lollipopBarHeight / 2 : Number(config.barHeight) / 2
+      let paddingX = 0
+      let labelX = 0
+      let showLabel = false
+
+      if (barPosition === 'right') {
+        paddingX = -10
+        showLabel = labelWidth - paddingX < targetX
+        labelX = targetX - labelWidth
+      }
+
+      if (barPosition === 'left') {
+        paddingX = 10
+        showLabel = xScale(maxVal) - targetX > labelWidth + paddingX
+        labelX = targetX
+      }
+
+      this.text = label
+      this.y = labelY
+      this.x = labelX
+      this.padding = paddingX
+      this.showLabel = config.xAxis.showTargetLabel ? showLabel : false
+    }
+  }
+  targetLabel.calculate()
+
+  useEffect(() => {
+    if (config.barStyle === 'lollipop' && !config.isLollipopChart) {
+      updateConfig({ ...config, isLollipopChart: true })
+    }
+    if (isRounded || config.barStyle === 'flat') {
+      updateConfig({ ...config, isLollipopChart: false })
+    }
+  }, [config.barStyle])
+
+  return (
+    <ErrorBoundary component='Deviation Bar'>
+      <Group left={Number(config.xAxis.size)}>
+        {data.map((d, index) => {
+          const barValue = Number(d[seriesKey])
+          const barHeight = config.isLollipopChart ? lollipopBarHeight : Number(config.barHeight)
+          const barSpace = Number(config.barSpace)
+          const barWidth = Math.abs(xScale(barValue) - targetX)
+          const barBaseX = xScale(barValue)
+          const barX = barValue > target ? targetX : barBaseX
+          const barPosition = barValue < target ? 'left' : 'right'
+
+          // update bar Y to give dynamic Y when user applyes BarSpace
+          let barY = 0
+          barY = index !== 0 ? (barSpace + barHeight + borderWidth) * index : barY
+          const totalheight = (barSpace + barHeight + borderWidth) * data.length
+          config.heights.horizontal = totalheight
+
+          // text,labels postiions
+          const textWidth = getTextWidth(formatNumber(barValue, 'left'), `normal ${fontSize[config.fontSize]}px sans-serif`)
+          const textFits = textWidth < barWidth - 6
+          const textX = barBaseX
+          const textY = barY + barHeight / 2
+
+          // lollipop shapes
+          const circleX = barBaseX
+          const circleY = barY + barHeight / 2
+          const squareX = barBaseX
+          const squareY = barY - barHeight / 2
+          const borderRadius = applyRadius(barPosition)
+          // colors
+          const [leftColor, rightColor] = twoColorPalette[twoColor.palette]
+          const barColor = { left: leftColor, right: rightColor }
+          const isBarColorDark = chroma.contrast('#000000', barColor[barPosition]) < 4.9
+          const fill = isBarColorDark ? '#FFFFFF' : '#000000'
+
+          let textProps = getTextProps(config.isLollipopChart, textFits, lollipopShapeSize, fill)
+
+          // tooltips
+          const xAxisValue = formatNumber(barValue, 'left')
+          const yAxisValue = config.runtime.yAxis.type === 'date' ? formatDate(parseDate(data[index][config.runtime.originalXAxis.dataKey])) : data[index][config.runtime.originalXAxis.dataKey]
+          let yAxisTooltip = config.runtime.yAxis.label ? `${config.runtime.yAxis.label}: ${yAxisValue}` : yAxisValue
+          let xAxisTooltip = config.runtime.xAxis.label ? `${config.runtime.xAxis.label}: ${xAxisValue}` : xAxisValue
+          const tooltip = `<div>
+          ${yAxisTooltip}<br />
+          ${xAxisTooltip}
+            </div>`
+
+          return (
+            <Group key={`deviation-bar-${config.orientation}-${seriesKey}-${index}`}>
+              <foreignObject x={barX} y={barY} width={barWidth} height={barHeight} style={{ border: `${borderWidth}px solid #333`, backgroundColor: barColor[barPosition], ...borderRadius }} data-tooltip-html={tooltip} data-tooltip-id={`cdc-open-viz-tooltip-${config.runtime.uniqueId}`} />
+              {config.yAxis.displayNumbersOnBar && (
+                <Text verticalAnchor='middle' x={textX} y={textY} {...textProps[barPosition]}>
+                  {formatNumber(d[seriesKey], 'left')}
+                </Text>
+              )}
+
+              {config.isLollipopChart && config.lollipopShape === 'circle' && <circle cx={circleX} cy={circleY} r={lollipopShapeSize / 2} fill={barColor[barPosition]} style={{ filter: 'unset', opacity: 1 }} />}
+              {config.isLollipopChart && config.lollipopShape === 'square' && <rect x={squareX} y={squareY} width={lollipopShapeSize} height={lollipopShapeSize} fill={barColor[barPosition]} style={{ opacity: 1, filter: 'unset' }}></rect>}
+            </Group>
+          )
+        })}
+        {targetLabel.showLabel && (
+          <Text fontWeight='bold' dx={targetLabel.padding} verticalAnchor='middle' x={targetLabel.x} y={targetLabel.y}>
+            {targetLabel.text}
+          </Text>
+        )}
+
+        {shouldShowTargetLine && <Line from={{ x: targetX, y: 0 }} to={{ x: targetX, y: height }} stroke='#333' strokeWidth={2} />}
+      </Group>
+    </ErrorBoundary>
+  )
+}