@cdc/chart 4.24.5 → 4.24.9

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/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.