npm - @cdc/chart - Versions diffs - 4.23.10-alpha → 4.23.11 - Mend

@cdc/chart 4.23.10-alpha → 4.23.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (54) hide show

package/dist/cdcchart.js +30598 -28669
package/examples/feature/bar/example-bar-chart.json +1 -46
package/examples/feature/dev-4261.json +399 -0
package/examples/feature/forest-plot/{broken.json → linear.json} +55 -50
package/examples/{private/forest-plot.json → feature/forest-plot/logarithmic.json} +305 -355
package/examples/feature/line/line-points.json +340 -0
package/examples/feature/regions/index.json +462 -0
package/examples/gallery/bar-chart-vertical/combo-line-chart.json +181 -48
package/examples/sparkline-multilple.json +846 -0
package/index.html +11 -8
package/package.json +3 -3
package/src/CdcChart.tsx +71 -60
package/src/_stories/Chart.tooltip.stories.tsx +305 -0
package/src/_stories/ChartBrush.stories.tsx +19 -0
package/src/_stories/ChartSuppress.stories.tsx +19 -0
package/{examples/private/missing-color.json → src/_stories/_mock/brush_mock.json} +392 -332
package/src/_stories/_mock/suppress_mock.json +911 -0
package/src/components/AreaChart.Stacked.jsx +4 -5
package/src/components/AreaChart.jsx +6 -35
package/src/components/{BarChart.Horizontal.jsx → BarChart.Horizontal.tsx} +106 -29
package/src/components/{BarChart.StackedHorizontal.jsx → BarChart.StackedHorizontal.tsx} +22 -17
package/src/components/{BarChart.StackedVertical.jsx → BarChart.StackedVertical.tsx} +22 -26
package/src/components/{BarChart.Vertical.jsx → BarChart.Vertical.tsx} +175 -31
package/src/components/BarChart.jsx +1 -1
package/src/components/DeviationBar.jsx +4 -3
package/src/components/EditorPanel.jsx +176 -50
package/src/components/ForestPlot/ForestPlotProps.ts +11 -0
package/src/components/ForestPlot/index.scss +1 -0
package/src/components/{ForestPlot.jsx → ForestPlot/index.tsx} +51 -31
package/src/components/ForestPlotSettings.jsx +162 -112
package/src/components/Legend.jsx +35 -2
package/src/components/{LineChart.Circle.tsx → LineChart/LineChart.Circle.tsx} +26 -23
package/src/components/LineChart/LineChartProps.ts +17 -0
package/src/components/LineChart/index.scss +1 -0
package/src/components/{LineChart.tsx → LineChart/index.tsx} +60 -24
package/src/components/LinearChart.jsx +120 -60
package/src/components/PairedBarChart.jsx +2 -2
package/src/components/Series.jsx +22 -3
package/src/components/ZoomBrush.tsx +168 -0
package/src/data/initial-state.js +27 -12
package/src/hooks/useBarChart.js +70 -6
package/src/hooks/useColorScale.ts +50 -0
package/src/hooks/useEditorPermissions.js +22 -4
package/src/hooks/{useMinMax.js → useMinMax.ts} +75 -23
package/src/hooks/{useRightAxis.js → useRightAxis.ts} +10 -2
package/src/hooks/{useScales.js → useScales.ts} +64 -17
package/src/hooks/useTooltip.jsx +68 -41
package/src/scss/main.scss +3 -35
package/src/types/ChartConfig.ts +43 -0
package/src/types/ChartContext.ts +38 -0
package/src/types/ChartProps.ts +7 -0
package/src/types/ForestPlot.ts +60 -0
package/examples/private/full.json +0 -45324
/package/{examples/private/TESTING.json → src/components/ForestPlot/Readme.md} +0 -0

package/examples/{private/forest-plot.json → feature/forest-plot/logarithmic.json} RENAMED Viewed

@@ -1,356 +1,306 @@
-{
-  "type": "chart",
-  "debugSvg": false,
-  "chartMessage": {
-    "noData": "No Data Available"
-  },
-  "title": "Forest Plot Title",
-  "showTitle": true,
-  "showDownloadMediaButton": false,
-  "showChartBrush": false,
-  "theme": "theme-blue",
-  "animate": false,
-  "fontSize": "medium",
-  "lineDatapointStyle": "hover",
-  "barHasBorder": "false",
-  "isLollipopChart": false,
-  "lollipopShape": "circle",
-  "lollipopColorStyle": "two-tone",
-  "visualizationSubType": "regular",
-  "barStyle": "",
-  "roundingStyle": "standard",
-  "tipRounding": "top",
-  "isResponsiveTicks": false,
-  "general": {
-    "showDownloadButton": false
-  },
-  "padding": {
-    "left": 5,
-    "right": 5
-  },
-  "yAxis": {
-    "hideAxis": false,
-    "displayNumbersOnBar": false,
-    "hideLabel": false,
-    "hideTicks": false,
-    "size": 50,
-    "gridLines": false,
-    "enablePadding": false,
-    "min": "",
-    "max": "",
-    "labelColor": "#333",
-    "tickLabelColor": "#333",
-    "tickColor": "#333",
-    "rightHideAxis": true,
-    "rightAxisSize": 0,
-    "rightLabel": "",
-    "rightLabelOffsetSize": 0,
-    "rightAxisLabelColor": "#333",
-    "rightAxisTickLabelColor": "#333",
-    "rightAxisTickColor": "#333",
-    "numTicks": "",
-    "axisPadding": 0,
-    "tickRotation": 0,
-    "anchors": []
-  },
-  "boxplot": {
-    "plots": [],
-    "borders": "true",
-    "firstQuartilePercentage": 25,
-    "thirdQuartilePercentage": 75,
-    "boxWidthPercentage": 40,
-    "plotOutlierValues": false,
-    "plotNonOutlierValues": true,
-    "legend": {
-      "showHowToReadText": false,
-      "howToReadText": ""
-    },
-    "labels": {
-      "q1": "Lower Quartile",
-      "q2": "q2",
-      "q3": "Upper Quartile",
-      "q4": "q4",
-      "minimum": "Minimum",
-      "maximum": "Maximum",
-      "mean": "Mean",
-      "median": "Median",
-      "sd": "Standard Deviation",
-      "iqr": "Interquartile Range",
-      "total": "Total",
-      "outliers": "Outliers",
-      "values": "Values",
-      "lowerBounds": "Lower Bounds",
-      "upperBounds": "Upper Bounds"
-    }
-  },
-  "topAxis": {
-    "hasLine": false
-  },
-  "isLegendValue": false,
-  "barThickness": 0.35,
-  "barHeight": 25,
-  "barSpace": 15,
-  "heights": {
-    "vertical": 300,
-    "horizontal": 750
-  },
-  "xAxis": {
-    "sortDates": false,
-    "anchors": [],
-    "type": "categorical",
-    "showTargetLabel": true,
-    "targetLabel": "Target",
-    "hideAxis": false,
-    "hideLabel": false,
-    "hideTicks": false,
-    "size": 0,
-    "tickRotation": 0,
-    "min": "",
-    "max": "",
-    "labelColor": "#333",
-    "tickLabelColor": "#333",
-    "tickColor": "#333",
-    "numTicks": "",
-    "labelOffset": 65,
-    "axisPadding": 0,
-    "target": 0,
-    "maxTickRotation": 0,
-    "dataKey": "Study"
-  },
-  "table": {
-    "label": "Data Table",
-    "expanded": true,
-    "limitHeight": false,
-    "height": "",
-    "caption": "",
-    "showDownloadUrl": false,
-    "showDataTableLink": true,
-    "indexLabel": "Study",
-    "download": false,
-    "showVertical": true,
-    "show": true
-  },
-  "orientation": "horizontal",
-  "color": "pinkpurple",
-  "columns": {
-    "additionalColumn1": {
-      "label": "Intervention Group (n/N)",
-      "dataTable": true,
-      "tooltips": true,
-      "prefix": "",
-      "suffix": "",
-      "forestPlot": false,
-      "startingPoint": "0",
-      "forestPlotAlignRight": false,
-      "name": "Intervention Group (n/N) "
-    },
-    "additionalColumn2": {
-      "label": "Control Group (n/N)",
-      "dataTable": true,
-      "tooltips": true,
-      "prefix": "",
-      "suffix": "",
-      "forestPlot": false,
-      "startingPoint": "0",
-      "forestPlotAlignRight": false,
-      "name": "Control Group (n/N)",
-      "forestPlotStartingPoint": "0"
-    },
-    "additionalColumn3": {
-      "label": "Weight",
-      "dataTable": true,
-      "tooltips": true,
-      "prefix": "",
-      "suffix": "",
-      "forestPlot": false,
-      "startingPoint": "0",
-      "forestPlotAlignRight": false,
-      "name": "Weight"
-    }
-  },
-  "legend": {
-    "behavior": "isolate",
-    "singleRow": false,
-    "colorCode": "",
-    "reverseLabelOrder": false,
-    "description": "",
-    "dynamicLegend": false,
-    "dynamicLegendDefaultText": "Show All",
-    "dynamicLegendItemLimit": 5,
-    "dynamicLegendItemLimitMessage": "Dynamic Legend Item Limit Hit.",
-    "dynamicLegendChartMessage": "Select Options from the Legend",
-    "lineMode": false,
-    "verticalSorted": false,
-    "hide": true
-  },
-  "exclusions": {
-    "active": false,
-    "keys": []
-  },
-  "palette": "qualitative-bold",
-  "isPaletteReversed": false,
-  "twoColor": {
-    "palette": "monochrome-1",
-    "isPaletteReversed": false
-  },
-  "labels": false,
-  "dataFormat": {
-    "commas": false,
-    "prefix": "",
-    "suffix": "",
-    "abbreviated": false,
-    "bottomSuffix": "",
-    "bottomPrefix": "",
-    "bottomAbbreviated": false
-  },
-  "confidenceKeys": {},
-  "visual": {
-    "border": true,
-    "accent": true,
-    "background": true,
-    "verticalHoverLine": false,
-    "horizontalHoverLine": false
-  },
-  "useLogScale": false,
-  "filterBehavior": "Filter Change",
-  "highlightedBarValues": [],
-  "series": [],
-  "tooltips": {
-    "opacity": 90
-  },
-  "forestPlot": {
-    "startAt": 0,
-    "width": "auto",
-    "colors": {
-      "line": "",
-      "shape": ""
-    },
-    "estimateField": "Weight",
-    "estimateRadius": "",
-    "lowerCiField": "",
-    "upperCiField": "",
-    "shape": "circle",
-    "rowHeight": 20,
-    "showZeroLine": false,
-    "description": {
-      "show": true,
-      "text": "description",
-      "location": 0
-    },
-    "result": {
-      "show": true,
-      "text": "result",
-      "location": 100
-    },
-    "radius": {
-      "min": 1,
-      "max": 8,
-      "scalingColumn": ""
-    },
-    "regression": {
-      "lower": 0,
-      "upper": 0,
-      "estimateField": 0,
-      "showBaseLine": false
-    },
-    "leftWidthOffset": "21",
-    "rightWidthOffset": "29",
-    "title": "Forest Plot Example",
-    "lower": "Lower 95 CI",
-    "upper": "Upper 95 CI"
-  },
-  "brush": {
-    "pattern_id": "brush_pattern",
-    "accent_color": "#ddd"
-  },
-  "area": {
-    "isStacked": false
-  },
-  "datasets": {},
-  "visualizationType": "Forest Plot",
-  "data": [
-    {
-      "Study": "Study 1",
-      "Intervention Group (n/N) ": "1/131",
-      "Control Group (n/N)": "2/133",
-      "Weight": "17.8",
-      "Relative Risk (fixed)": "0.5",
-      "Lower 95 CI": "0.05",
-      "Upper 95 CI": "5.49"
-    },
-    {
-      "Study": "Study 2",
-      "Intervention Group (n/N) ": "7/279",
-      "Control Group (n/N)": "9/290",
-      "Weight": "77.7",
-      "Relative Risk (fixed)": "0.84",
-      "Lower 95 CI": "0.36",
-      "Upper 95 CI": "1.93"
-    },
-    {
-      "Study": "Study 3",
-      "Intervention Group (n/N) ": "3/102",
-      "Control Group (n/N)": "1/101",
-      "Weight": "4.5",
-      "Relative Risk (fixed)": "3",
-      "Lower 95 CI": "0.12",
-      "Upper 95 CI": "72.77"
-    },
-    {
-      "Study": "Total",
-      "Intervention Group (n/N) ": "512",
-      "Control Group (n/N)": "542",
-      "Weight": "100",
-      "Relative Risk (fixed)": "0.87",
-      "Lower 95 CI": "0.41",
-      "Upper 95 CI": "1.87"
-    }
-  ],
-  "dataFileName": "forest-plot-a.csv",
-  "dataFileSourceType": "file",
-  "dataDescription": {
-    "horizontal": false,
-    "series": false
-  },
-  "validated": 4.23,
-  "description": "Info such as <em>p</em> value, heterogeneity in plot subtext",
-  "dynamicMarginTop": 0,
-  "formattedData": [
-    {
-      "Study": "Study 1",
-      "Intervention Group (n/N) ": "1/131",
-      "Control Group (n/N)": "2/133",
-      "Weight": "17.8",
-      "Relative Risk (fixed)": "0.5",
-      "Lower 95 CI": "0.05",
-      "Upper 95 CI": "5.49"
-    },
-    {
-      "Study": "Study 2",
-      "Intervention Group (n/N) ": "7/279",
-      "Control Group (n/N)": "9/290",
-      "Weight": "77.7",
-      "Relative Risk (fixed)": "0.84",
-      "Lower 95 CI": "0.36",
-      "Upper 95 CI": "1.93"
-    },
-    {
-      "Study": "Study 3",
-      "Intervention Group (n/N) ": "3/102",
-      "Control Group (n/N)": "1/101",
-      "Weight": "4.5",
-      "Relative Risk (fixed)": "3",
-      "Lower 95 CI": "0.12",
-      "Upper 95 CI": "72.77"
-    },
-    {
-      "Study": "Total",
-      "Intervention Group (n/N) ": "512",
-      "Control Group (n/N)": "542",
-      "Weight": "100",
-      "Relative Risk (fixed)": "0.87",
-      "Lower 95 CI": "0.41",
-      "Upper 95 CI": "1.87"
-    }
-  ]
+{
+  "type": "chart",
+  "debugSvg": false,
+  "title": "",
+  "showTitle": true,
+  "showDownloadMediaButton": false,
+  "showChartBrush": false,
+  "theme": "theme-blue",
+  "animate": false,
+  "fontSize": "medium",
+  "lineDatapointStyle": "hover",
+  "barHasBorder": "false",
+  "isLollipopChart": false,
+  "lollipopShape": "circle",
+  "lollipopColorStyle": "two-tone",
+  "visualizationSubType": "regular",
+  "barStyle": "",
+  "roundingStyle": "standard",
+  "tipRounding": "top",
+  "isResponsiveTicks": false,
+  "general": {
+    "showDownloadButton": false
+  },
+  "padding": {
+    "left": 5,
+    "right": 5
+  },
+  "yAxis": {
+    "hideAxis": false,
+    "displayNumbersOnBar": false,
+    "hideLabel": false,
+    "hideTicks": false,
+    "size": 50,
+    "gridLines": false,
+    "enablePadding": false,
+    "min": "",
+    "max": "",
+    "labelColor": "#333",
+    "tickLabelColor": "#333",
+    "tickColor": "#333",
+    "rightHideAxis": true,
+    "rightAxisSize": 0,
+    "rightLabel": "",
+    "rightLabelOffsetSize": 0,
+    "rightAxisLabelColor": "#333",
+    "rightAxisTickLabelColor": "#333",
+    "rightAxisTickColor": "#333",
+    "numTicks": "",
+    "axisPadding": 0,
+    "tickRotation": 0,
+    "anchors": []
+  },
+  "boxplot": {
+    "plots": [],
+    "borders": "true",
+    "firstQuartilePercentage": 25,
+    "thirdQuartilePercentage": 75,
+    "boxWidthPercentage": 40,
+    "plotOutlierValues": false,
+    "plotNonOutlierValues": true,
+    "legend": {
+      "showHowToReadText": false,
+      "howToReadText": ""
+    },
+    "labels": {
+      "q1": "Lower Quartile",
+      "q2": "q2",
+      "q3": "Upper Quartile",
+      "q4": "q4",
+      "minimum": "Minimum",
+      "maximum": "Maximum",
+      "mean": "Mean",
+      "median": "Median",
+      "sd": "Standard Deviation",
+      "iqr": "Interquartile Range",
+      "total": "Total",
+      "outliers": "Outliers",
+      "values": "Values",
+      "lowerBounds": "Lower Bounds",
+      "upperBounds": "Upper Bounds"
+    }
+  },
+  "topAxis": {
+    "hasLine": false
+  },
+  "isLegendValue": false,
+  "barThickness": 0.35,
+  "barHeight": 25,
+  "barSpace": 15,
+  "heights": {
+    "vertical": 300,
+    "horizontal": 750
+  },
+  "xAxis": {
+    "anchors": [],
+    "type": "categorical",
+    "showTargetLabel": true,
+    "targetLabel": "Target",
+    "hideAxis": false,
+    "hideLabel": false,
+    "hideTicks": false,
+    "size": 0,
+    "tickRotation": 0,
+    "min": "",
+    "max": "",
+    "labelColor": "#333",
+    "tickLabelColor": "#333",
+    "tickColor": "#333",
+    "numTicks": "",
+    "labelOffset": 65,
+    "axisPadding": 0,
+    "target": 0,
+    "maxTickRotation": 0,
+    "dataKey": "description"
+  },
+  "table": {
+    "label": "Data Table",
+    "expanded": true,
+    "limitHeight": false,
+    "height": "",
+    "caption": "",
+    "showDownloadUrl": false,
+    "showDataTableLink": true,
+    "indexLabel": "",
+    "download": false,
+    "showVertical": true,
+    "show": true
+  },
+  "orientation": "horizontal",
+  "color": "pinkpurple",
+  "columns": {
+    "additionalColumn1": {
+      "label": "Estimate Field",
+      "dataTable": true,
+      "tooltips": true,
+      "prefix": "",
+      "suffix": "",
+      "forestPlot": false,
+      "startingPoint": "0",
+      "forestPlotAlignRight": false,
+      "name": "effect"
+    },
+    "additionalColumn2": {
+      "label": "Low",
+      "dataTable": true,
+      "tooltips": true,
+      "prefix": "",
+      "suffix": "",
+      "forestPlot": false,
+      "startingPoint": "0",
+      "forestPlotAlignRight": false,
+      "name": "low"
+    },
+    "additionalColumn3": {
+      "label": "High",
+      "dataTable": true,
+      "tooltips": true,
+      "prefix": "",
+      "suffix": "",
+      "forestPlot": false,
+      "startingPoint": "0",
+      "forestPlotAlignRight": false,
+      "name": "high"
+    }
+  },
+  "legend": {
+    "behavior": "isolate",
+    "singleRow": false,
+    "colorCode": "",
+    "reverseLabelOrder": false,
+    "description": "",
+    "dynamicLegend": false,
+    "dynamicLegendDefaultText": "Show All",
+    "dynamicLegendItemLimit": 5,
+    "dynamicLegendItemLimitMessage": "Dynamic Legend Item Limit Hit.",
+    "dynamicLegendChartMessage": "Select Options from the Legend",
+    "hide": true
+  },
+  "exclusions": {
+    "active": false,
+    "keys": []
+  },
+  "palette": "qualitative-bold",
+  "isPaletteReversed": false,
+  "twoColor": {
+    "palette": "monochrome-1",
+    "isPaletteReversed": false
+  },
+  "labels": false,
+  "dataFormat": {
+    "commas": false,
+    "prefix": "",
+    "suffix": "",
+    "abbreviated": false,
+    "bottomSuffix": "",
+    "bottomPrefix": "",
+    "bottomAbbreviated": false
+  },
+  "confidenceKeys": {},
+  "visual": {
+    "border": true,
+    "accent": true,
+    "background": true,
+    "verticalHoverLine": false,
+    "horizontalHoverLine": false
+  },
+  "useLogScale": false,
+  "filterBehavior": "Filter Change",
+  "highlightedBarValues": [],
+  "series": [],
+  "tooltips": {
+    "opacity": 90
+  },
+  "forestPlot": {
+    "startAt": 0,
+    "colors": {
+      "line": "",
+      "shape": ""
+    },
+    "lineOfNoEffect": {
+      "show": true
+    },
+    "type": "Logarithmic",
+    "pooledResult": {
+      "diamondHeight": 5
+    },
+    "estimateField": "effect",
+    "estimateRadius": "",
+    "shape": "circle",
+    "rowHeight": 20,
+    "description": {
+      "show": true,
+      "text": "description",
+      "location": 0
+    },
+    "result": {
+      "show": true,
+      "text": "result",
+      "location": 100
+    },
+    "radius": {
+      "min": 1,
+      "max": 8,
+      "scalingColumn": ""
+    },
+    "regression": {
+      "lower": 0,
+      "upper": 0,
+      "estimateField": 0,
+      "showDiamond": false
+    },
+    "leftWidthOffset": "0",
+    "rightWidthOffset": "0",
+    "showZeroLine": false,
+    "hideDateCategoryCol": false,
+    "leftLabel": "left label",
+    "rightLabel": "right label",
+    "width": "auto",
+    "outcome": "",
+    "lowerCiField": "",
+    "upperCiField": "",
+    "lower": "low",
+    "upper": "high",
+    "rightWidthOffsetMobile": "0",
+    "title": "test",
+    "leftWidthOffsetMobile": "51"
+  },
+  "brush": {
+    "pattern_id": "brush_pattern",
+    "accent_color": "#ddd"
+  },
+  "datasets": {},
+  "visualizationType": "Forest Plot",
+  "data": [
+    {
+      "description": "Study 1",
+      "low": 0.88,
+      "high": 0.95,
+      "effect": 0.92
+    },
+    {
+      "description": "Study 2",
+      "low": 0.84,
+      "high": 0.94,
+      "effect": 0.89
+    },
+    {
+      "description": "Study 3",
+      "low": 0.88,
+      "high": 0.98,
+      "effect": 0.93
+    },
+    {
+      "description": "Study 4",
+      "low": 0.91,
+      "high": 0.99,
+      "effect": 0.97
+    }
+  ],
+  "dataDescription": {
+    "horizontal": false,
+    "series": false
+  },
+  "validated": 4.23,
+  "dynamicMarginTop": 0
 }