@cdc/chart 4.24.5 → 4.24.9-1

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,15 @@
   .subtext,
   .subtext--responsive-ticks,
   .section-subtext {
-    padding: 0 1rem;
+    &--brush-active {
+      margin-top: 2.5em;
+    }
+  }
+
+  .type-pie {
+    svg.animated-pie {
+      width: auto !important;
+    }
   }
 
   .legend-container {
@@ -100,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;
 
@@ -141,9 +176,10 @@
         word-wrap: break-word;
         white-space: pre-wrap;
         word-break: break-word;
-        @include breakpoint(xs) {
-          font-size: $font-small;
-        }
+      }
+
+      & > :first-child {
+        margin-top: 3px;
       }
     }
 
@@ -159,20 +195,13 @@
 
     h3 {
       font-size: 1.3rem;
-      @include breakpoint(xs) {
-        font-size: $font-small + 0.4em;
-      }
     }
 
     h3,
     p {
       margin-bottom: 0.8em;
     }
-    p {
-      @include breakpoint(xs) {
-        font-size: $font-small;
-      }
-    }
+
     & div.legend-item {
       margin-bottom: 0.5em !important;
 
@@ -190,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 {
@@ -226,9 +272,6 @@
     vertical-align: middle;
     margin-bottom: 0.5em;
 
-    @include breakpoint(xs) {
-      font-size: $font-small;
-    }
     & > span {
       display: flex;
       justify-items: center;
@@ -276,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;
@@ -284,6 +381,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;
@@ -415,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;
       }
@@ -431,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;
         }
@@ -702,7 +803,6 @@
   .subtext,
   .subtext--responsive-ticks {
     margin-top: 0px;
-    padding: 0 1rem;
   }
 
   .isEditor {

package/src/types/ChartConfig.ts

@@ -8,14 +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 = '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
@@ -52,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 = {
@@ -70,13 +98,14 @@ type Visual = {
   horizontalHoverLine?: boolean
 }
 
-type AllChartsConfig = {
+export type AllChartsConfig = {
+  annotations: Annotation[]
   animate: boolean
   general: General
   barHasBorder: 'true' | 'false'
   barHeight: number
   barSpace: number
-  barStyle: string
+  barStyle: 'lollipop'|'rounded'|'flat'
   barThickness: number
   boxplot: BoxPlot
   brush: {
@@ -106,6 +135,7 @@ type AllChartsConfig = {
   formattedData: Object[] & { urlFiltered: boolean }
   heights: {
     vertical: number
+    mobileVertical: number
   }
   highlightedBarValues: { value: any; color: string; borderWidth: number; legendLabel: string }[]
   introText: string
@@ -149,10 +179,9 @@ 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
@@ -188,8 +217,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,8 @@
 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>
 
@@ -15,21 +17,28 @@ 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
   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 & {
-  dimensions: [screenWidth: number, screenHeight: number]
+  convertLineToBarGraph: boolean
+  dimensions: DimensionsType
   formatDate: Function
   formatTooltipsDate: Function
   formatNumber: Function
@@ -50,7 +59,8 @@ type LineChartContext = SharedChartContext & {
 export type ChartContext =
   | LineChartContext
   | (SharedChartContext & {
-      dimensions: [screenWidth: number, screenHeight: number]
+      annotations: Annotation[]
+      dimensions: DimensionsType
       formatDate?: Function
       formatTooltipsDate: Function
       formatNumber?: 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)
+  })
+})

package/src/components/BrushHandle.jsx

@@ -1,17 +0,0 @@
-import { Group } from '@visx/group'
-
-const BrushHandle = props => {
-  const { x, height, isBrushActive } = props
-  const pathWidth = 8
-  const pathHeight = 15
-  if (!isBrushActive) {
-    return null
-  }
-  return (
-    <Group left={x + pathWidth / 2} top={(height - pathHeight) / 2}>
-      <path fill='#f2f2f2' d='M -4.5 0.5 L 3.5 0.5 L 3.5 15.5 L -4.5 15.5 L -4.5 0.5 M -1.5 4 L -1.5 12 M 0.5 4 L 0.5 12' stroke='#999999' strokeWidth='1' style={{ cursor: 'ew-resize' }} />
-    </Group>
-  )
-}
-
-export default BrushHandle

package/src/components/LineChart/index.scss

@@ -1 +0,0 @@
-// Line Chart Styles...