@pie-lib/graphing 4.0.5-next.31 → 4.0.5-next.36

package/src/axis/arrow.jsx

@@ -0,0 +1,57 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+
+import { styled } from '@mui/material/styles';
+import { types } from '@pie-lib/plot';
+
+const StyledPath = styled('path')(({ theme }) => ({
+  fill: `var(--arrow-color, ${theme.palette.common.black})`,
+}));
+
+export class Arrow extends React.Component {
+  render() {
+    const { x, y, className, scale } = this.props;
+    let direction = this.props.direction || 'left';
+
+    const xv = scale.x(x);
+    const yv = scale.y(y);
+
+    let transform = '';
+
+    const getTransform = (x, y, rotate) => `translate(${x}, ${y}) rotate(${rotate})`;
+
+    if (direction === 'left') {
+      transform = getTransform(xv - 15, yv, 0);
+    }
+
+    if (direction === 'right') {
+      transform = getTransform(xv + 15, yv, 180);
+    }
+
+    if (direction === 'up') {
+      transform = getTransform(xv, yv - 15, 90);
+    }
+
+    if (direction === 'down') {
+      transform = getTransform(xv, yv + 15, 270);
+    }
+
+    return <StyledPath d="m 0,0 8,-5 0,10 -8,-5" transform={transform} className={className} />;
+  }
+}
+
+Arrow.propTypes = {
+  y: PropTypes.number,
+  x: PropTypes.number,
+  direction: PropTypes.oneOf(['left', 'right', 'up', 'down']),
+  className: PropTypes.string,
+  scale: types.ScaleType.isRequired,
+};
+
+Arrow.defaultProps = {
+  y: 0,
+  x: 0,
+  direction: 'left',
+};
+
+export default Arrow;

package/src/axis/axes.jsx

@@ -0,0 +1,285 @@
+import React from 'react';
+import { Axis } from '@visx/axis';
+import { types } from '@pie-lib/plot';
+import PropTypes from 'prop-types';
+import Arrow from './arrow';
+import { styled } from '@mui/material/styles';
+import { amountToIncreaseWidth, countWords, findLongestWord, getTickValues } from '../utils';
+import { color, Readable } from '@pie-lib/render-ui';
+
+export const AxisPropTypes = {
+  includeArrows: PropTypes.object,
+  graphProps: PropTypes.object,
+};
+
+const AxisDefaultProps = {
+  includeArrows: {
+    left: true,
+    right: true,
+    up: true,
+    down: true,
+  },
+};
+
+const StyledArrow = styled(Arrow)(() => ({
+  fill: color.defaults.PRIMARY,
+}));
+
+
+const StyledAxisLabelHolder = styled('div')(({ theme, centered }) => ({
+  padding: 0,
+  margin: 0,
+  '* > *': {
+    margin: 0,
+    padding: 0,
+  },
+  '& p': {
+    margin: 0,
+  },
+  fontSize: theme.typography.fontSize,
+  ...(centered && { textAlign: 'center' }),
+}));
+
+const StyledAxesGroup = styled('g')(() => ({
+  '& .visx-axis-line': {
+    stroke: color.defaults.PRIMARY,
+    strokeWidth: 3,
+  },
+  '& .visx-axis-tick': {
+    fill: color.defaults.PRIMARY,
+    '& line': {
+      stroke: color.defaults.PRIMARY,
+    },
+  },
+}));
+
+const tickLabelStyles = {
+  fontFamily: 'Roboto',
+  fontSize: '14px',
+  cursor: 'inherit',
+};
+
+export const sharedValues = (
+  firstNegativeX,
+  firstNegativeY,
+  distanceFromOriginToFirstNegativeX,
+  distanceFromOriginToFirstNegativeY,
+  deltaAllowance,
+  dy,
+) => {
+  let result = [];
+
+  if (
+    firstNegativeX === firstNegativeY &&
+    distanceFromOriginToFirstNegativeX - deltaAllowance < distanceFromOriginToFirstNegativeY &&
+    distanceFromOriginToFirstNegativeY < distanceFromOriginToFirstNegativeX + deltaAllowance &&
+    distanceFromOriginToFirstNegativeX - deltaAllowance < dy &&
+    dy < distanceFromOriginToFirstNegativeX + deltaAllowance
+  ) {
+    result.push(firstNegativeX);
+  }
+
+  return result;
+};
+
+export const firstNegativeValue = (interval) => (interval || []).find((element) => element < 0);
+
+export class RawXAxis extends React.Component {
+  static propTypes = {
+    ...AxisPropTypes,
+    graphProps: types.GraphPropsType.isRequired,
+  };
+  static defaultProps = AxisDefaultProps;
+
+  render() {
+    const { includeArrows, graphProps, columnTicksValues, skipValues, distanceFromOriginToFirstNegativeY, dy } =
+      this.props;
+    const { scale, domain, size, range } = graphProps || {};
+
+    const labelProps = (label) => {
+      const y = skipValues && skipValues[0] === label ? distanceFromOriginToFirstNegativeY + 4 : dy;
+
+      return {
+        ...tickLabelStyles,
+        textAnchor: 'middle',
+        y: y,
+        dx: label === 0 ? -10 : 0,
+        dy: label === 0 ? -7 : 0,
+      };
+    };
+
+    const necessaryRows = countWords(domain.axisLabel);
+    const longestWord = findLongestWord(domain.axisLabel);
+    const necessaryWidth = amountToIncreaseWidth(longestWord) + 2;
+
+    return (
+      <StyledAxesGroup>
+        <Axis
+          scale={scale.x}
+          top={scale.y(0)}
+          left={0}
+          label={domain.label}
+          rangePadding={8}
+          tickFormat={(value) => value}
+          tickLabelProps={labelProps}
+          tickValues={columnTicksValues}
+          hideZero={!(domain.labelStep || range.labelStep) && domain.min <= 0}
+        />
+        {includeArrows && includeArrows.left && <StyledArrow direction="left" x={domain.min} y={0} scale={scale} />}
+        {includeArrows && includeArrows.right && <StyledArrow direction="right" x={domain.max} y={0} scale={scale} />}
+        {domain.axisLabel && (
+          <foreignObject x={size.width + 17} y={scale.y(0) - 9} width={necessaryWidth} height={20 * necessaryRows}>
+            <Readable false>
+              <StyledAxisLabelHolder dangerouslySetInnerHTML={{ __html: domain.axisLabel }} />
+            </Readable>
+          </foreignObject>
+        )}
+      </StyledAxesGroup>
+    );
+  }
+}
+
+const XAxis = RawXAxis;
+
+export class RawYAxis extends React.Component {
+  static propTypes = {
+    ...AxisPropTypes,
+    graphProps: types.GraphPropsType.isRequired,
+  };
+  static defaultProps = AxisDefaultProps;
+
+  render() {
+    const { includeArrows, graphProps, skipValues, rowTickValues } = this.props;
+    const { scale, range, size } = graphProps || {};
+
+    const necessaryWidth = range.axisLabel ? amountToIncreaseWidth(range.axisLabel.length) : 0;
+
+    const customTickFormat = (value) => (skipValues && skipValues.indexOf(value) >= 0 ? '' : value);
+
+    return (
+      <StyledAxesGroup>
+        <Axis
+          orientation={'left'}
+          scale={scale.y}
+          top={0}
+          height={size.height}
+          left={scale.x(0)}
+          label={range.label}
+          labelProps={{ 'data-pie-readable': false }}
+          rangePadding={8}
+          tickLength={10}
+          tickFormat={customTickFormat}
+          tickLabelProps={(value) => {
+            let digits = value.toLocaleString().replace(/[.-]/g, '').length || 1;
+
+            return {
+              ...tickLabelStyles,
+              dy: 4,
+              dx: -10 - digits * 9,
+              'data-pie-readable': false,
+            };
+          }}
+          hideZero={true}
+          tickTextAnchor={'bottom'}
+          tickValues={rowTickValues}
+        />
+        {includeArrows && includeArrows.down && <StyledArrow direction="down" x={0} y={range.min} scale={scale} />}
+        {includeArrows && includeArrows.up && <StyledArrow direction="up" x={0} y={range.max} scale={scale} />}
+        {range.axisLabel && (
+          <foreignObject x={scale.x(0) - necessaryWidth / 2} y={-33} width={necessaryWidth} height="20">
+            <Readable false>
+              <StyledAxisLabelHolder centered dangerouslySetInnerHTML={{ __html: range.axisLabel }} />
+            </Readable>
+          </foreignObject>
+        )}
+      </StyledAxesGroup>
+    );
+  }
+}
+
+const YAxis = RawYAxis;
+
+export default class Axes extends React.Component {
+  static propTypes = {
+    ...AxisPropTypes,
+    graphProps: types.GraphPropsType.isRequired,
+  };
+  static defaultProps = AxisDefaultProps;
+
+  xValues = () => {
+    const { graphProps } = this.props;
+    const { scale, domain } = graphProps || {};
+
+    if (!domain || !scale) {
+      return;
+    }
+
+    const ticks = getTickValues({ ...domain, step: domain.labelStep });
+    const negative = firstNegativeValue(ticks);
+
+    return {
+      columnTicksValues: ticks,
+      firstNegativeX: negative,
+      distanceFromOriginToFirstNegativeX: Math.abs(scale.y(0) - scale.y(negative)),
+    };
+  };
+
+  yValues = () => {
+    const { graphProps } = this.props;
+    const { scale, range } = graphProps || {};
+
+    if (!range || !scale) {
+      return;
+    }
+
+    const ticks = getTickValues({ ...range, step: range.labelStep });
+    const negative = firstNegativeValue(ticks);
+
+    return {
+      rowTickValues: ticks,
+      firstNegativeY: negative,
+      distanceFromOriginToFirstNegativeY: Math.abs(scale.x(0) - scale.x(negative)),
+    };
+  };
+
+  render() {
+    const { graphProps } = this.props;
+    const { domain, range } = graphProps || {};
+    const { columnTicksValues, firstNegativeX, distanceFromOriginToFirstNegativeX } = this.xValues();
+    const { rowTickValues, firstNegativeY, distanceFromOriginToFirstNegativeY } = this.yValues();
+    const deltaAllowance = 6;
+    const dy = 25;
+
+    const skipValues = sharedValues(
+      firstNegativeX,
+      firstNegativeY,
+      distanceFromOriginToFirstNegativeX,
+      distanceFromOriginToFirstNegativeY,
+      deltaAllowance,
+      dy,
+    );
+
+    // each axis has to be displayed only if the domain & range include it
+    return (
+      <StyledAxesGroup>
+        {range.min <= 0 ? (
+          <XAxis
+            {...this.props}
+            skipValues={skipValues}
+            columnTicksValues={columnTicksValues}
+            distanceFromOriginToFirstNegativeY={distanceFromOriginToFirstNegativeY}
+            dy={dy}
+          />
+        ) : null}
+        {domain.min <= 0 ? (
+          <YAxis
+            {...this.props}
+            skipValues={skipValues}
+            rowTickValues={rowTickValues}
+            distanceFromOriginToFirstNegativeX={distanceFromOriginToFirstNegativeX}
+          />
+        ) : null}
+      </StyledAxesGroup>
+    );
+  }
+}

package/src/axis/index.js

@@ -0,0 +1,3 @@
+import Axes, { AxisPropTypes } from './axes';
+
+export { Axes, AxisPropTypes };

package/src/bg.jsx

@@ -0,0 +1,96 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { pointer, select } from 'd3-selection';
+import { types, utils } from '@pie-lib/plot';
+import { getTickValues, thinnerShapesNeeded } from './utils';
+
+export default class Bg extends React.Component {
+  static propTypes = {
+    width: PropTypes.number.isRequired,
+    height: PropTypes.number.isRequired,
+    onClick: PropTypes.func.isRequired,
+    graphProps: types.GraphPropsType.isRequired,
+  };
+
+  static defaultProps = {};
+
+  componentDidMount() {
+    const rect = select(this.rect);
+
+    rect.on('click', (event) => this.onRectClick(rect, event));
+  }
+
+  shouldComponentUpdate(nextProps) {
+    return (
+      !utils.isDomainRangeEqual(this.props.graphProps, nextProps.graphProps) ||
+      this.props.width !== nextProps.width ||
+      this.props.height !== nextProps.height
+    );
+  }
+
+  getRectPadding = () => {
+    const { graphProps } = this.props;
+
+    return thinnerShapesNeeded(graphProps) ? 6 : 10;
+  };
+
+  /**
+   * Note: we use d3 click + pointer to give us domain values directly.
+   * Saves us having to calculate them ourselves from a MouseEvent.
+   */
+  onRectClick = (rect, event) => {
+    const { onClick, graphProps } = this.props;
+    const { scale } = graphProps;
+
+    const padding = this.getRectPadding();
+    const coords = pointer(event, rect.node());
+
+    // decrease the padding from coordinates to indicate the correct point clicked
+    const x = scale.x.invert(coords[0] - padding);
+    const y = scale.y.invert(coords[1] - padding);
+
+    const rowTicks = getTickValues(graphProps.range);
+    const columnTicks = getTickValues(graphProps.domain);
+
+    const closest = (ticks, value) => {
+      return (
+        ticks.length &&
+        ticks.reduce((prev, curr) => {
+          const currentDistance = Math.abs(curr - value);
+          const previousDistance = Math.abs(prev - value);
+
+          return currentDistance <= previousDistance ? curr : prev;
+        })
+      );
+    };
+
+    let snapped = {};
+
+    if (columnTicks.indexOf(x) >= 0 && rowTicks.indexOf(y) >= 0) {
+      snapped.x = x;
+      snapped.y = y;
+    } else {
+      snapped.x = closest(columnTicks, x);
+      snapped.y = closest(rowTicks, y);
+    }
+
+    onClick(snapped);
+  };
+
+  render() {
+    const { width, height } = this.props;
+    const padding = this.getRectPadding();
+
+    // expand the size of clickable area so a small area outside the edges of the grid lines to be clickable
+    return (
+      <rect
+        ref={(rect) => (this.rect = rect)}
+        transform={`translate(-${padding}, -${padding})`}
+        fill="red"
+        fillOpacity="0.0"
+        width={width + padding * 2}
+        height={height + padding * 2}
+      />
+    );
+  }
+}

package/src/container/__tests__/actions.test.js

@@ -0,0 +1,105 @@
+import { addMark, changeMarks } from '../actions';
+
+describe('container actions', () => {
+  describe('addMark', () => {
+    it('creates ADD_MARK action', () => {
+      const action = addMark();
+      expect(action).toEqual({
+        type: 'ADD_MARK',
+      });
+    });
+
+    it('creates action without parameters', () => {
+      const action = addMark();
+      expect(action.type).toBe('ADD_MARK');
+      expect(Object.keys(action)).toEqual(['type']);
+    });
+  });
+
+  describe('changeMarks', () => {
+    it('creates CHANGE_MARKS action with marks', () => {
+      const marks = [{ id: 1, type: 'point' }];
+      const action = changeMarks(marks);
+
+      expect(action).toEqual({
+        type: 'CHANGE_MARKS',
+        marks,
+      });
+    });
+
+    it('creates action with empty marks array', () => {
+      const marks = [];
+      const action = changeMarks(marks);
+
+      expect(action).toEqual({
+        type: 'CHANGE_MARKS',
+        marks: [],
+      });
+    });
+
+    it('creates action with multiple marks', () => {
+      const marks = [
+        { id: 1, type: 'point', x: 1, y: 2 },
+        { id: 2, type: 'line', from: { x: 0, y: 0 }, to: { x: 5, y: 5 } },
+      ];
+      const action = changeMarks(marks);
+
+      expect(action.marks).toEqual(marks);
+      expect(action.marks.length).toBe(2);
+    });
+
+    it('creates action with null marks', () => {
+      const marks = null;
+      const action = changeMarks(marks);
+
+      expect(action).toEqual({
+        type: 'CHANGE_MARKS',
+        marks: null,
+      });
+    });
+
+    it('creates action with undefined marks', () => {
+      const marks = undefined;
+      const action = changeMarks(marks);
+
+      expect(action).toEqual({
+        type: 'CHANGE_MARKS',
+        marks: undefined,
+      });
+    });
+
+    it('preserves mark properties', () => {
+      const marks = [
+        {
+          id: 1,
+          type: 'point',
+          x: 10,
+          y: 20,
+          label: 'A',
+          correctness: { value: 'correct' },
+        },
+      ];
+      const action = changeMarks(marks);
+
+      expect(action.marks[0]).toEqual(marks[0]);
+      expect(action.marks[0].correctness).toBeDefined();
+    });
+  });
+
+  describe('action types', () => {
+    it('has consistent action type strings', () => {
+      const addMarkAction = addMark();
+      const changeMarksAction = changeMarks([]);
+
+      expect(typeof addMarkAction.type).toBe('string');
+      expect(typeof changeMarksAction.type).toBe('string');
+    });
+
+    it('has unique action types', () => {
+      const addMarkAction = addMark();
+      const changeMarksAction = changeMarks([]);
+
+      expect(addMarkAction.type).not.toBe(changeMarksAction.type);
+    });
+  });
+});