@cdc/chart 4.24.1 → 4.24.3

package/src/components/EditorPanel/components/Panels/Panel.Visual.tsx

@@ -0,0 +1,338 @@
+import { useContext, FC } from 'react'
+
+// external libraries
+import { AccordionItem, AccordionItemHeading, AccordionItemPanel, AccordionItemButton } from 'react-accessible-accordion'
+
+// core
+import { TextField, Select, CheckBox } from '@cdc/core/components/EditorPanel/Inputs'
+import Tooltip from '@cdc/core/components/ui/Tooltip'
+import Icon from '@cdc/core/components/ui/Icon'
+import InputToggle from '@cdc/core/components/inputs/InputToggle'
+
+// contexts
+import { useColorPalette } from '../../../../hooks/useColorPalette'
+import { ChartContext } from './../../../../types/ChartContext.js'
+
+import { useEditorPermissions } from '../../useEditorPermissions.js'
+import { useEditorPanelContext } from '../../EditorPanelContext.js'
+import ConfigContext from '../../../../ConfigContext.js'
+import { PanelProps } from '../PanelProps'
+
+const PanelVisual: FC<PanelProps> = props => {
+  const { config, updateConfig, colorPalettes, twoColorPalette } = useContext<ChartContext>(ConfigContext)
+  const { visual } = config
+  const { setLollipopShape, updateField } = useEditorPanelContext()
+  const { visHasBarBorders, visCanAnimate, visSupportsNonSequentialPallete, headerColors, visSupportsTooltipOpacity, visSupportsTooltipLines, visSupportsBarSpace, visSupportsBarThickness, visHasDataCutoff, visSupportsSequentialPallete, visSupportsReverseColorPalette } = useEditorPermissions()
+  const { twoColorPalettes, sequential, nonSequential } = useColorPalette(config, updateConfig)
+
+  const updateColor = (property, _value) => {
+    console.log('value', _value)
+    if (property === 'storyNodeFontColor') {
+      updateConfig({
+        ...config,
+        sankey: {
+          ...config.sankey,
+          storyNodeFontColor: _value
+        }
+      })
+      return
+    } else {
+      updateConfig({
+        ...config,
+        sankey: {
+          ...config.sankey,
+          [property]: {
+            ...config.sankey[property],
+            default: _value
+          }
+        }
+      })
+    }
+  }
+
+  return (
+    <AccordionItem>
+      <AccordionItemHeading>
+        <AccordionItemButton>Visual</AccordionItemButton>
+      </AccordionItemHeading>
+      <AccordionItemPanel>
+        {config.isLollipopChart && (
+          <>
+            <fieldset className='header'>
+              <legend className='edit-label'>Lollipop Shape</legend>
+              <div
+                onChange={e => {
+                  setLollipopShape(e.target.value)
+                }}
+              >
+                <label className='radio-label'>
+                  <input type='radio' name='lollipopShape' value='circle' checked={config.lollipopShape === 'circle'} />
+                  Circle
+                </label>
+                <label className='radio-label'>
+                  <input type='radio' name='lollipopShape' value='square' checked={config.lollipopShape === 'square'} />
+                  Square
+                </label>
+              </div>
+            </fieldset>
+            <Select value={config.lollipopColorStyle ? config.lollipopColorStyle : 'two-tone'} fieldName='lollipopColorStyle' label='Lollipop Color Style' updateField={updateField} options={['regular', 'two-tone']} />
+            <Select value={config.lollipopSize ? config.lollipopSize : 'small'} fieldName='lollipopSize' label='Lollipop Size' updateField={updateField} options={['small', 'medium', 'large']} />
+          </>
+        )}
+
+        {config.visualizationType === 'Box Plot' && (
+          <fieldset className='fieldset fieldset--boxplot'>
+            <legend className=''>Box Plot Settings</legend>
+            <Select value={config.boxplot.borders} fieldName='borders' section='boxplot' label='Box Plot Borders' updateField={updateField} options={['true', 'false']} />
+            <CheckBox value={config.boxplot.plotOutlierValues} fieldName='plotOutlierValues' section='boxplot' label='Plot Outliers' updateField={updateField} />
+            <CheckBox value={config.boxplot.plotNonOutlierValues} fieldName='plotNonOutlierValues' section='boxplot' label='Plot non-outlier values' updateField={updateField} />
+          </fieldset>
+        )}
+
+        <Select value={config.fontSize} fieldName='fontSize' label='Font Size' updateField={updateField} options={['small', 'medium', 'large']} />
+        {visHasBarBorders() && <Select value={config.barHasBorder} fieldName='barHasBorder' label='Bar Borders' updateField={updateField} options={['true', 'false']} />}
+        {visCanAnimate() && <CheckBox value={config.animate} fieldName='animate' label='Animate Visualization' updateField={updateField} />}
+
+        {/*<CheckBox value={config.animateReplay} fieldName="animateReplay" label="Replay Animation When Filters Are Changed" updateField={updateField} />*/}
+
+        {((config.series?.some(series => series.type === 'Line' || series.type === 'dashed-lg' || series.type === 'dashed-sm' || series.type === 'dashed-md') && config.visualizationType === 'Combo') || config.visualizationType === 'Line') && (
+          <>
+            <Select value={config.lineDatapointStyle} fieldName='lineDatapointStyle' label='Line Datapoint Style' updateField={updateField} options={['hidden', 'hover', 'always show']} />
+            <Select value={config.lineDatapointColor} fieldName='lineDatapointColor' label='Line Datapoint Color' updateField={updateField} options={['Same as Line', 'Lighter than Line']} />
+          </>
+        )}
+
+        {/* eslint-disable */}
+        <label className='header'>
+          <span className='edit-label'>Header Theme</span>
+          <ul className='color-palette'>
+            {headerColors.map(palette => (
+              <button
+                title={palette}
+                key={palette}
+                onClick={e => {
+                  e.preventDefault()
+                  updateConfig({ ...config, theme: palette })
+                }}
+                className={config.theme === palette ? 'selected ' + palette : palette}
+              ></button>
+            ))}
+          </ul>
+        </label>
+        {/* eslint-enable */}
+        {(visSupportsNonSequentialPallete() || visSupportsNonSequentialPallete()) && (
+          <>
+            <label>
+              <span className='edit-label'>Chart Color Palette</span>
+            </label>
+            {visSupportsReverseColorPalette() && <InputToggle fieldName='isPaletteReversed' size='small' label='Use selected palette in reverse order' updateField={updateField} value={config.isPaletteReversed} />}
+            {visSupportsSequentialPallete() && (
+              <>
+                <span>Sequential</span>
+                <ul className='color-palette'>
+                  {sequential.map(palette => {
+                    const colorOne = {
+                      backgroundColor: colorPalettes[palette][2]
+                    }
+
+                    const colorTwo = {
+                      backgroundColor: colorPalettes[palette][3]
+                    }
+
+                    const colorThree = {
+                      backgroundColor: colorPalettes[palette][5]
+                    }
+
+                    return (
+                      <button
+                        title={palette}
+                        key={palette}
+                        onClick={e => {
+                          e.preventDefault()
+                          updateConfig({ ...config, palette })
+                        }}
+                        className={config.palette === palette ? 'selected' : ''}
+                      >
+                        <span style={colorOne}></span>
+                        <span style={colorTwo}></span>
+                        <span style={colorThree}></span>
+                      </button>
+                    )
+                  })}
+                </ul>
+              </>
+            )}
+            {visSupportsNonSequentialPallete() && (
+              <>
+                <span>Non-Sequential</span>
+                <ul className='color-palette'>
+                  {nonSequential.map(palette => {
+                    const colorOne = {
+                      backgroundColor: colorPalettes[palette][2]
+                    }
+
+                    const colorTwo = {
+                      backgroundColor: colorPalettes[palette][4]
+                    }
+
+                    const colorThree = {
+                      backgroundColor: colorPalettes[palette][6]
+                    }
+
+                    return (
+                      <button
+                        title={palette}
+                        key={palette}
+                        onClick={e => {
+                          e.preventDefault()
+                          updateConfig({ ...config, palette })
+                        }}
+                        className={config.palette === palette ? 'selected' : ''}
+                      >
+                        <span style={colorOne}></span>
+                        <span style={colorTwo}></span>
+                        <span style={colorThree}></span>
+                      </button>
+                    )
+                  })}
+                </ul>
+              </>
+            )}
+          </>
+        )}
+        {config.visualizationType === 'Sankey' && (
+          <>
+            <span className='sankey__color-input'>
+              <input type='color' value={config.sankey.nodeColor.default} id='storyNodeColor' name='storyNodeColor' onChange={e => updateColor('nodeColor', e.target.value)} />
+              <label htmlFor='storyNodeColor'>Story Node Color</label>
+            </span>
+            <span className='sankey__color-input'>
+              <input type='color' value={config.sankey.storyNodeFontColor || 'red'} id='storyNodeFontColor' name='storyNodeFontColor' onChange={e => updateColor('storyNodeFontColor', e.target.value)} />
+              <label htmlFor='storyNodeFontColor'>Story Node Font Color</label>
+            </span>
+            <span className='sankey__color-input'>
+              <input type='color' value={config.sankey.linkColor.default} id='linkColor' name='linkColor' onChange={e => updateColor('linkColor', e.target.value)} />
+              <label htmlFor='linkColor'>Link Color</label>
+            </span>
+          </>
+        )}
+        {(config.visualizationType === 'Paired Bar' || config.visualizationType === 'Deviation Bar') && (
+          <>
+            <InputToggle section='twoColor' fieldName='isPaletteReversed' size='small' label='Use selected palette in reverse order' updateField={updateField} value={config.twoColor.isPaletteReversed} />
+            <ul className='color-palette'>
+              {twoColorPalettes.map(palette => {
+                const colorOne = {
+                  backgroundColor: twoColorPalette[palette][0]
+                }
+
+                const colorTwo = {
+                  backgroundColor: twoColorPalette[palette][1]
+                }
+
+                return (
+                  <button
+                    title={palette}
+                    key={palette}
+                    onClick={e => {
+                      e.preventDefault()
+                      updateConfig({ ...config, twoColor: { ...config.twoColor, palette } })
+                    }}
+                    className={config.twoColor.palette === palette ? 'selected' : ''}
+                  >
+                    <span className='two-color' style={colorOne}></span>
+                    <span className='two-color' style={colorTwo}></span>
+                  </button>
+                )
+              })}
+            </ul>
+          </>
+        )}
+
+        {visHasDataCutoff() && (
+          <>
+            <TextField
+              value={config.dataCutoff}
+              type='number'
+              fieldName='dataCutoff'
+              className='number-narrow'
+              label='Data Cutoff'
+              updateField={updateField}
+              tooltip={
+                <Tooltip style={{ textTransform: 'none' }}>
+                  <Tooltip.Target>
+                    <Icon display='question' style={{ marginLeft: '0.5rem' }} />
+                  </Tooltip.Target>
+                  <Tooltip.Content>
+                    <p>Any value below the cut-off value is included in a special "less than" category. This option supports special conditions like suppressed data.</p>
+                  </Tooltip.Content>
+                </Tooltip>
+              }
+            />
+          </>
+        )}
+        {visSupportsBarThickness() && config.orientation === 'horizontal' && !config.isLollipopChart && config.yAxis.labelPlacement !== 'On Bar' && <TextField type='number' value={config.barHeight || '25'} fieldName='barHeight' label=' Bar Thickness' updateField={updateField} min={15} />}
+        {((config.visualizationType === 'Bar' && config.orientation !== 'horizontal') || config.visualizationType === 'Combo') && <TextField value={config.barThickness} type='number' fieldName='barThickness' label='Bar Thickness' updateField={updateField} />}
+        {visSupportsBarSpace() && <TextField type='number' value={config.barSpace || '15'} fieldName='barSpace' label='Bar Space' updateField={updateField} min={0} />}
+        {(config.visualizationType === 'Bar' || config.visualizationType === 'Line' || config.visualizationType === 'Combo') && <CheckBox value={config.topAxis.hasLine} section='topAxis' fieldName='hasLine' label='Add Top Axis Line' updateField={updateField} />}
+
+        {config.visualizationType === 'Spark Line' && (
+          <div className='cove-accordion__panel-section checkbox-group'>
+            <CheckBox value={visual?.border} section='visual' fieldName='border' label='Show Border' updateField={updateField} />
+            <CheckBox value={visual?.borderColorTheme} section='visual' fieldName='borderColorTheme' label='Use Border Color Theme' updateField={updateField} />
+            <CheckBox value={visual?.accent} section='visual' fieldName='accent' label='Use Accent Style' updateField={updateField} />
+            <CheckBox value={visual?.background} section='visual' fieldName='background' label='Use Theme Background Color' updateField={updateField} />
+            <CheckBox value={visual?.hideBackgroundColor} section='visual' fieldName='hideBackgroundColor' label='Hide Background Color' updateField={updateField} />
+          </div>
+        )}
+
+        {(config.visualizationType === 'Line' || config.visualizationType === 'Combo') && <CheckBox value={config.showLineSeriesLabels} fieldName='showLineSeriesLabels' label='Append Series Name to End of Line Charts' updateField={updateField} />}
+        {(config.visualizationType === 'Line' || config.visualizationType === 'Combo') && config.showLineSeriesLabels && <CheckBox value={config.colorMatchLineSeriesLabels} fieldName='colorMatchLineSeriesLabels' label='Match Series Color to Name at End of Line Charts' updateField={updateField} />}
+
+        {visSupportsTooltipLines() && (
+          <>
+            <CheckBox value={visual.verticalHoverLine} fieldName='verticalHoverLine' section='visual' label='Vertical Hover Line' updateField={updateField} />
+            <CheckBox value={visual.horizontalHoverLine} fieldName='horizontalHoverLine' section='visual' label='Horizontal Hover Line' updateField={updateField} />
+          </>
+        )}
+        {visSupportsTooltipOpacity() && (
+          <label>
+            <span className='edit-label column-heading'>Tooltip Opacity</span>
+            <input
+              type='number'
+              value={config.tooltips.opacity ? config.tooltips.opacity : 100}
+              onChange={e =>
+                updateConfig({
+                  ...config,
+                  tooltips: {
+                    ...config.tooltips,
+                    opacity: e.target.value
+                  }
+                })
+              }
+            />
+          </label>
+        )}
+        {config.visualizationType === 'Bar' && <CheckBox value={config.tooltips.singleSeries} fieldName='singleSeries' section='tooltips' label='SHOW HOVER FOR SINGLE DATA SERIES' updateField={updateField} />}
+
+        <label>
+          <span className='edit-label column-heading'>No Data Message</span>
+          <input
+            type='text'
+            value={config.chartMessage.noData ? config.chartMessage.noData : ''}
+            onChange={e =>
+              updateConfig({
+                ...config,
+                chartMessage: {
+                  ...config.chartMessage,
+                  noData: e.target.value
+                }
+              })
+            }
+          />
+        </label>
+      </AccordionItemPanel>
+    </AccordionItem>
+  )
+}
+
+export default PanelVisual

package/src/components/EditorPanel/components/Panels/index.tsx

@@ -0,0 +1,19 @@
+import ForestPlotSettings from './Panel.ForestPlotSettings'
+import Series from './Panel.Series'
+import Regions from './Panel.Regions'
+import General from './Panel.General'
+import BoxPlot from './Panel.BoxPlot'
+import Visual from './Panel.Visual'
+import Sankey from './Panel.Sankey'
+
+const Panels = {
+  ForestPlot: ForestPlotSettings,
+  Series: Series,
+  Regions,
+  General,
+  BoxPlot,
+  Visual,
+  Sankey
+}
+
+export default Panels

package/src/components/EditorPanel/components/panels.scss

@@ -70,3 +70,14 @@
     }
   }
 }
+
+.sankey__color-input {
+  display: flex;
+  align-items: center;
+  margin: 10px auto;
+  label {
+    align-items: center;
+    padding-left: 5px;
+    margin-top: 0 !important;
+  }
+}

package/src/components/EditorPanel/editor-panel.scss

@@ -8,17 +8,6 @@
 
 .cdc-open-viz-module.type-chart {
   .editor-panel {
-    @import './components/panels.scss';
-    display: flex;
-    flex-direction: column;
-    position: fixed;
-    top: 0;
-    bottom: 0;
-    left: 0;
-    width: 350px;
-    background: #fff;
-    z-index: 8;
-
     &.hidden {
       display: none;
     }
@@ -711,14 +700,13 @@
     color: #000;
     font-size: 1em;
     border: 0;
-    position: fixed;
+    position: absolute;
     z-index: 100;
     transition: 0.1s background;
     cursor: pointer;
     width: 25px;
     height: 25px;
     left: 307px;
-    top: 10px;
     box-shadow: rgba(0, 0, 0, 0.5) 0 1px 2px;
 
     &:before {

package/src/components/EditorPanel/useEditorPermissions.js

@@ -14,18 +14,19 @@ export const useEditorPermissions = () => {
     'Combo',
     'Deviation Bar',
     'Forecasting',
-    'Forest Plot',
+    // 'Forest Plot',
     'Line',
     'Paired Bar',
     'Pie',
     'Scatter Plot',
-    'Spark Line'
+    'Spark Line',
+    'Sankey'
 ]
 
   const headerColors = ['theme-blue', 'theme-purple', 'theme-brown', 'theme-teal', 'theme-pink', 'theme-orange', 'theme-slate', 'theme-indigo', 'theme-cyan', 'theme-green', 'theme-amber']
 
   const visSupportsDateCategoryAxis = () => {
-    const disabledCharts = ['Forest Plot']
+    const disabledCharts = ['Forest Plot', 'Sankey']
     if (disabledCharts.includes(visualizationType)) return false
     return true
   }
@@ -43,13 +44,13 @@ export const useEditorPermissions = () => {
   }
 
   const visHasLabelOnData = () => {
-    const disabledCharts = ['Area Chart', 'Box Plot', 'Pie', 'Scatter Plot', 'Forest Plot', 'Spark Line']
+    const disabledCharts = ['Area Chart', 'Box Plot', 'Pie', 'Scatter Plot', 'Forest Plot', 'Spark Line', 'Sankey']
     if (disabledCharts.includes(visualizationType)) return false
     return true
   }
 
   const visCanAnimate = () => {
-    const disabledCharts = ['Area Chart', 'Scatter Plot', 'Box Plot', 'Forest Plot', 'Spark Line']
+    const disabledCharts = ['Area Chart', 'Scatter Plot', 'Box Plot', 'Forest Plot', 'Spark Line', 'Sankey']
     if (disabledCharts.includes(visualizationType)) return false
     return true
   }
@@ -62,6 +63,8 @@ export const useEditorPermissions = () => {
         return false
       case 'Spark Line':
         return false
+      case 'Sankey':
+        return false
       default:
         return true
     }
@@ -107,6 +110,8 @@ export const useEditorPermissions = () => {
 
   const visHasDataCutoff = () => {
     switch (visualizationType) {
+      case 'Sankey':
+        return false
       case 'Forest Plot':
         return false
       case 'Box Plot':
@@ -120,8 +125,13 @@ export const useEditorPermissions = () => {
     }
   }
 
+  const visHasSelectableLegendValues = !['Box Plot', 'Forest Plot', 'Spark Line'].includes(visualizationType)
+  const visHasLegendAxisAlign = () => {
+    return visualizationType === 'Bar' && visualizationSubType === 'stacked' && config.legend.behavior === 'isolate'
+  }
+
   const visSupportsTooltipOpacity = () => {
-    const disabledCharts = ['Spark Line']
+    const disabledCharts = ['Spark Line', 'Sankey']
     if (disabledCharts.includes(visualizationType)) return false
     return true
   }
@@ -133,19 +143,19 @@ export const useEditorPermissions = () => {
   }
 
   const visSupportsSequentialPallete = () => {
-    const disabledCharts = ['Paired Bar', 'Deviation Bar', 'Forest Plot', 'Forecasting']
+    const disabledCharts = ['Paired Bar', 'Deviation Bar', 'Forest Plot', 'Forecasting', 'Sankey']
     if (disabledCharts.includes(visualizationType)) return false
     return true
   }
 
   const visSupportsNonSequentialPallete = () => {
-    const disabledCharts = ['Paired Bar', 'Deviation Bar', 'Forest Plot', 'Forecasting']
+    const disabledCharts = ['Paired Bar', 'Deviation Bar', 'Forest Plot', 'Forecasting', 'Sankey']
     if (disabledCharts.includes(visualizationType)) return false
     return true
   }
 
   const visSupportsReverseColorPalette = () => {
-    const disabledCharts = ['Forest Plot', 'Paired Bar', 'Deviation Bar']
+    const disabledCharts = ['Forest Plot', 'Paired Bar', 'Deviation Bar', 'Sankey']
     if (disabledCharts.includes(visualizationType)) return false
     return true
   }
@@ -187,7 +197,7 @@ export const useEditorPermissions = () => {
   }
 
   const visSupportsRegions = () => {
-    const disabledCharts = ['Forest Plot', 'Pie', 'Paired Bar', 'Spark Line']
+    const disabledCharts = ['Forest Plot', 'Pie', 'Paired Bar', 'Spark Line', 'Sankey']
     if (disabledCharts.includes(visualizationType)) return false
     return true
   }
@@ -205,7 +215,7 @@ export const useEditorPermissions = () => {
   }
 
   const visSupportsFilters = () => {
-    const disabledCharts = ['Forest Plot']
+    const disabledCharts = ['Forest Plot', 'Sankey']
     if (disabledCharts.includes(visualizationType)) return false
     return true
   }
@@ -258,7 +268,7 @@ export const useEditorPermissions = () => {
   }
 
   const visSupportsLeftValueAxis = () => {
-    const disabledCharts = ['Spark Line']
+    const disabledCharts = ['Spark Line', 'Sankey']
     if (disabledCharts.includes(visualizationType)) return false
     return true
   }
@@ -270,17 +280,34 @@ export const useEditorPermissions = () => {
   }
 
   const visSupportsDateCategoryHeight = () => {
-    const disabledCharts = ['Spark Line']
+    const disabledCharts = ['Spark Line', 'Sankey']
     if (disabledCharts.includes(visualizationType)) return false
     return true
   }
 
+  const visSupportsDateCategoryAxisPadding = () => {
+    return config.xAxis.type === 'date-time'
+  }
+
   const visSupportsReactTooltip = () => {
     if (['Deviation Bar', 'Box Plot', 'Scatter Plot', 'Paired Bar'].includes(visualizationType) || (visualizationType === 'Bar' && config.tooltips.singleSeries)) {
       return true
     }
   }
 
+  const visSupportsPreliminaryData = () => {
+    // check if Line added in Combo
+    const lineExist = config?.series.some(item => ['Line', 'dashed-sm', 'dashed-md', 'dashed-lg'].includes(item?.type))
+    if (visualizationType === 'Line') {
+      return true
+    }
+
+    if (visualizationType === 'Combo' && lineExist) {
+      return true
+    }
+    return false
+  }
+
   return {
     enabledChartTypes,
     headerColors,
@@ -291,6 +318,7 @@ export const useEditorPermissions = () => {
     visHasLabelOnData,
     visHasDataSuppression,
     visHasLegend,
+    visHasLegendAxisAlign,
     visHasBrushChart,
     visHasNumbersOnBars,
     visSupportsBarSpace,
@@ -303,10 +331,12 @@ export const useEditorPermissions = () => {
     visSupportsDateCategoryHeight,
     visSupportsDateCategoryNumTicks,
     visSupportsDateCategoryTickRotation,
+    visSupportsDateCategoryAxisPadding,
     visSupportsFilters,
     visSupportsFootnotes,
     visSupportsLeftValueAxis,
     visSupportsNonSequentialPallete,
+    visSupportsPreliminaryData,
     visSupportsRankByValue,
     visSupportsRegions,
     visSupportsResponsiveTicks,
@@ -314,6 +344,7 @@ export const useEditorPermissions = () => {
     visSupportsSequentialPallete,
     visSupportsSuperTitle,
     visSupportsTooltipLines,
+    visHasSelectableLegendValues,
     visSupportsTooltipOpacity,
     visSupportsValueAxisGridLines,
     visSupportsValueAxisLabels,