@centreon/ui 24.7.6 → 24.7.7

package/src/Graph/LineChart/Legend/index.tsx

@@ -0,0 +1,208 @@
+import { Dispatch, ReactNode, SetStateAction, useMemo } from 'react';
+
+import { equals, lt, prop, slice, sortBy } from 'ramda';
+
+import { Box, alpha, useTheme } from '@mui/material';
+
+import { useMemoComponent } from '@centreon/ui';
+
+import { formatMetricValue } from '../../common/timeSeries';
+import { Line } from '../../common/timeSeries/models';
+import { labelAvg, labelMax, labelMin } from '../translatedLabels';
+import { LegendModel } from '../models';
+import { margin } from '../common';
+
+import { useStyles } from './Legend.styles';
+import LegendHeader from './LegendHeader';
+import { GetMetricValueProps, LegendDisplayMode } from './models';
+import useLegend from './useLegend';
+import LegendContent from './LegendContent';
+
+interface Props extends Pick<LegendModel, 'placement' | 'mode'> {
+  base: number;
+  height: number | null;
+  limitLegend?: false | number;
+  lines: Array<Line>;
+  renderExtraComponent?: ReactNode;
+  setLinesGraph: Dispatch<SetStateAction<Array<Line> | null>>;
+  shouldDisplayLegendInCompactMode: boolean;
+  toggable?: boolean;
+}
+
+const MainLegend = ({
+  lines,
+  base,
+  toggable = true,
+  limitLegend = false,
+  renderExtraComponent,
+  setLinesGraph,
+  shouldDisplayLegendInCompactMode,
+  placement,
+  height,
+  mode
+}: Props): JSX.Element => {
+  const { classes, cx } = useStyles({ limitLegendRows: Boolean(limitLegend) });
+  const theme = useTheme();
+
+  const { selectMetricLine, clearHighlight, highlightLine, toggleMetricLine } =
+    useLegend({ lines, setLinesGraph });
+
+  const sortedData = sortBy(prop('metric_id'), lines);
+
+  const isListMode = useMemo(() => equals(mode, 'list'), [mode]);
+
+  const displayedLines = limitLegend
+    ? slice(0, limitLegend, sortedData)
+    : sortedData;
+
+  const getMetricValue = ({ value, unit }: GetMetricValueProps): string =>
+    formatMetricValue({
+      base,
+      unit,
+      value
+    }) || 'N/A';
+
+  const selectMetric = ({ event, metric_id }): void => {
+    if (!toggable) {
+      return;
+    }
+
+    if (event.ctrlKey || event.metaKey) {
+      toggleMetricLine(metric_id);
+
+      return;
+    }
+
+    selectMetricLine(metric_id);
+  };
+
+  const itemMode =
+    !isListMode && shouldDisplayLegendInCompactMode
+      ? LegendDisplayMode.Compact
+      : LegendDisplayMode.Normal;
+
+  const legendMaxHeight = useMemo(() => {
+    if (!isListMode || !equals(placement, 'bottom')) {
+      return 'none';
+    }
+
+    if (lt(height || 0, 220)) {
+      return 40;
+    }
+
+    return 90;
+  }, [height, isListMode, placement]);
+
+  const overflow = equals(legendMaxHeight, 'none') ? 'hidden' : 'auto';
+
+  return (
+    <div
+      className={classes.legend}
+      data-display-side={!equals(placement, 'bottom')}
+      style={{
+        height: !equals(placement, 'bottom')
+          ? (height || 0) - margin.top / 2
+          : undefined,
+        maxHeight: legendMaxHeight,
+        overflow
+      }}
+    >
+      <div
+        className={classes.items}
+        data-as-list={isListMode || !equals(placement, 'bottom')}
+        data-mode={itemMode}
+      >
+        {displayedLines.map((line) => {
+          const { color, display, highlight, metric_id } = line;
+
+          const markerColor = display
+            ? color
+            : alpha(theme.palette.text.disabled, 0.2);
+
+          const minMaxAvg = [
+            {
+              label: labelMin,
+              value: line.minimum_value
+            },
+            {
+              label: labelMax,
+              value: line.maximum_value
+            },
+            {
+              label: labelAvg,
+              value: line.average_value
+            }
+          ];
+
+          return (
+            <Box
+              className={cx(
+                classes.item,
+                highlight ? classes.highlight : classes.normal,
+                toggable && classes.toggable
+              )}
+              key={metric_id}
+              onClick={(event): void => selectMetric({ event, metric_id })}
+              onMouseEnter={(): void => highlightLine(metric_id)}
+              onMouseLeave={(): void => clearHighlight()}
+            >
+              <LegendHeader
+                color={markerColor}
+                disabled={!display}
+                isDisplayedOnSide={!equals(placement, 'bottom')}
+                isListMode={isListMode}
+                line={line}
+                minMaxAvg={
+                  shouldDisplayLegendInCompactMode ? minMaxAvg : undefined
+                }
+              />
+              {!shouldDisplayLegendInCompactMode && !isListMode && (
+                <div>
+                  <div className={classes.minMaxAvgContainer}>
+                    {minMaxAvg.map(({ label, value }) => (
+                      <LegendContent
+                        data={getMetricValue({ unit: line.unit, value })}
+                        key={label}
+                        label={label}
+                      />
+                    ))}
+                  </div>
+                </div>
+              )}
+            </Box>
+          );
+        })}
+      </div>
+      {renderExtraComponent}
+    </div>
+  );
+};
+
+const Legend = (props: Props): JSX.Element => {
+  const {
+    toggable,
+    limitLegend,
+    lines,
+    base,
+    shouldDisplayLegendInCompactMode,
+    placement,
+    height,
+    mode
+  } = props;
+
+  return useMemoComponent({
+    Component: <MainLegend {...props} />,
+    memoProps: [
+      lines,
+      base,
+      toggable,
+      limitLegend,
+      shouldDisplayLegendInCompactMode,
+      placement,
+      height,
+      mode
+    ]
+  });
+};
+
+export default Legend;

package/src/Graph/LineChart/Legend/models.ts

@@ -0,0 +1,16 @@
+export interface FormattedMetricData {
+  color: string;
+  formattedValue: string | null;
+  name: string;
+  unit: string;
+}
+
+export interface GetMetricValueProps {
+  unit: string;
+  value: number | null;
+}
+
+export enum LegendDisplayMode {
+  Compact = 'compact',
+  Normal = 'normal'
+}

package/src/Graph/LineChart/Legend/useLegend.ts

@@ -0,0 +1,104 @@
+import { Dispatch, SetStateAction, useEffect } from 'react';
+
+import {
+  equals,
+  find,
+  head,
+  isEmpty,
+  isNil,
+  map,
+  pipe,
+  propEq,
+  reject
+} from 'ramda';
+
+import { Line } from '../../common/timeSeries/models';
+
+interface LegendActions {
+  clearHighlight: () => void;
+  highlightLine: (metric_id: number) => void;
+  selectMetricLine: (metric_id: number) => void;
+  toggleMetricLine: (metric_id: number) => void;
+}
+
+interface Props {
+  lines: Array<Line>;
+  setLinesGraph: Dispatch<SetStateAction<Array<Line> | null>>;
+}
+
+const useLegend = ({ lines, setLinesGraph }: Props): LegendActions => {
+  const displayedLines = reject(propEq(false, 'display'), lines);
+  const getLineByMetric = (metric_id: number): Line =>
+    find(propEq(metric_id, 'metric_id'), lines) as Line;
+
+  const toggleMetricLine = (metric_id): void => {
+    const data = lines.map((line) => ({
+      ...line,
+      display: equals(line.metric_id, metric_id) ? !line.display : line.display
+    }));
+
+    setLinesGraph(data);
+  };
+
+  const highlightLine = (metric_id): void => {
+    const data = lines.map((line) => ({
+      ...line,
+      highlight: equals(line.metric_id, metric_id)
+    }));
+
+    setLinesGraph(data);
+  };
+
+  const clearHighlight = (): void => {
+    setLinesGraph(map((line) => ({ ...line, highlight: undefined }), lines));
+  };
+
+  const selectMetricLine = (metric_id: number): void => {
+    const metricLine = getLineByMetric(metric_id);
+
+    const isLineDisplayed = pipe(head, equals(metricLine))(displayedLines);
+    const isOnlyLineDisplayed =
+      equals(displayedLines.length, 1) && isLineDisplayed;
+
+    if (isOnlyLineDisplayed || isEmpty(displayedLines)) {
+      setLinesGraph(
+        map(
+          (line) => ({
+            ...line,
+            display: true
+          }),
+          lines
+        )
+      );
+
+      return;
+    }
+
+    setLinesGraph(
+      map(
+        (line) => ({
+          ...line,
+          display: equals(line, metricLine)
+        }),
+        lines
+      )
+    );
+  };
+
+  useEffect(() => {
+    if (isNil(lines) || isEmpty(lines)) {
+      return;
+    }
+
+    const newLines = lines.map((line) => ({
+      ...line,
+      display: find(propEq(line.metric_id, 'metric_id'), lines)?.display ?? true
+    }));
+
+    setLinesGraph(newLines);
+  }, [lines]);
+
+  return { clearHighlight, highlightLine, selectMetricLine, toggleMetricLine };
+};
+
+export default useLegend;