@pie-lib/graphing 4.1.0-beta.9 → 5.0.0-next.37

package/src/bg.jsx

@@ -1,96 +0,0 @@
-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/actions.js

@@ -1,8 +0,0 @@
-export const addMark = () => ({
-  type: 'ADD_MARK',
-});
-
-export const changeMarks = (marks) => ({
-  type: 'CHANGE_MARKS',
-  marks,
-});

package/src/container/index.jsx

@@ -1,91 +0,0 @@
-import { connect, Provider } from 'react-redux';
-import React from 'react';
-import { applyMiddleware, createStore } from 'redux';
-import reducer from './reducer';
-import { changeMarks } from './actions';
-import PropTypes from 'prop-types';
-import { isEqual } from 'lodash-es';
-import { ActionCreators } from 'redux-undo';
-import GraphWithControls from '../graph-with-controls';
-import { lastActionMiddleware } from './middleware';
-
-const mapStateToProps = (s) => ({
-  marks: s.marks.present,
-});
-
-const mapDispatchToProps = (dispatch) => ({
-  onChangeMarks: (m) => dispatch(changeMarks(m)),
-  onUndo: () => dispatch(ActionCreators.undo()),
-  onRedo: () => dispatch(ActionCreators.redo()),
-  onReset: () => dispatch(changeMarks([])),
-});
-
-export const GraphContainer = connect(mapStateToProps, mapDispatchToProps)(GraphWithControls);
-
-/**
- * The graph component entry point with undo/redo
- * Redux is an implementation detail, hide it in the react component.
- */
-class Root extends React.Component {
-  static propTypes = {
-    onChangeMarks: PropTypes.func,
-    marks: PropTypes.array,
-  };
-
-  constructor(props) {
-    super(props);
-
-    const r = reducer();
-    this.store = createStore(r, { marks: props.marks }, applyMiddleware(lastActionMiddleware));
-
-    this.store.subscribe(this.onStoreChange);
-  }
-
-  componentDidUpdate(prevProps) {
-    const { marks } = this.props;
-    const storeState = this.store.getState();
-
-    if (isEqual(storeState.marks.present, marks)) {
-      return;
-    }
-
-    if (!isEqual(prevProps.marks, marks)) {
-      // Don't dispatch marks that have correctness (evaluate mode marks) into the undo history.
-      // These marks are already handled in render() via the correctnessSet path and bypass the
-      // Redux store entirely. Dispatching them would pollute the undo history and cause the graph
-      // to show the correct answer when the user presses undo after returning to gather mode.
-      const hasCorrectness = marks && marks.find((m) => m.correctness);
-
-      if (!hasCorrectness) {
-        this.store.dispatch(changeMarks(marks));
-      }
-    }
-  }
-
-  onStoreChange = () => {
-    const { marks, onChangeMarks } = this.props;
-    const storeState = this.store.getState();
-
-    if (!isEqual(storeState.marks.present, marks)) {
-      onChangeMarks(storeState.marks.present);
-    }
-  };
-
-  render() {
-    // eslint-disable-next-line no-unused-vars
-    const { onChangeMarks, marks, ...rest } = this.props;
-    const correctnessSet = marks && marks.find((m) => m.correctness);
-
-    if (correctnessSet) {
-      return <GraphWithControls {...rest} marks={marks} disabled={correctnessSet} />;
-    }
-
-    return (
-      <Provider store={this.store}>
-        <GraphContainer {...rest} />
-      </Provider>
-    );
-  }
-}
-
-export default Root;

package/src/container/marks.js

@@ -1,14 +0,0 @@
-const marks = (state = [], action) => {
-  switch (action.type) {
-    case 'CHANGE_MARKS':
-      if (Array.isArray(action.marks)) {
-        return action.marks;
-      } else {
-        throw new Error('marks must be an array');
-      }
-    default:
-      return state;
-  }
-};
-
-export default marks;

package/src/container/middleware.js

@@ -1,7 +0,0 @@
-let lastAction = null;
-export const getLastAction = () => lastAction;
-
-export const lastActionMiddleware = () => (next) => (action) => {
-  lastAction = action;
-  return next(action);
-};

package/src/container/reducer.js

@@ -1,5 +0,0 @@
-import { combineReducers } from 'redux';
-import marks from './marks';
-import undoable from 'redux-undo';
-
-export default () => combineReducers({ marks: undoable(marks, { debug: false }) });

package/src/coordinates-label.jsx

@@ -1,63 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import { types } from '@pie-lib/plot';
-import { color } from '@pie-lib/render-ui';
-import { styled } from '@mui/material/styles';
-import InputBase from '@mui/material/InputBase';
-import { roundNumber } from './utils';
-
-const StyledInputBase = styled(InputBase)(({ theme }) => ({
-  fontFamily: theme.typography.fontFamily,
-  fontSize: theme.typography.fontSize,
-  borderRadius: '8px',
-  background: theme.palette.common.white,
-  color: color.defaults.PRIMARY_DARK,
-  '& .MuiInputBase-input': {
-    padding: 0,
-  },
-}));
-
-// eslint-disable-next-line react/prop-types
-export const getLabelPosition = (graphProps, x, y, labelLength) => {
-  const { scale, domain, range } = graphProps;
-  // treat corner cases for maximum and minimum
-  const topShift = y === range.min ? 16 : y === range.max ? 0 : 8;
-  const leftShift = 10;
-  const rightEdge = scale.x(x) + labelLength + leftShift;
-
-  if (rightEdge >= scale.x(domain.max)) {
-    return {
-      left: scale.x(x) - leftShift - labelLength,
-      top: scale.y(y) - topShift,
-    };
-  }
-
-  return {
-    left: scale.x(x) + leftShift,
-    top: scale.y(y) - topShift,
-  };
-};
-
-export const CoordinatesLabel = ({ x, y, graphProps }) => {
-  const label = `(${roundNumber(x)}, ${roundNumber(y)})`;
-  const labelLength = (label.length || 0) * 6;
-  const labelPosition = getLabelPosition(graphProps, x, y, labelLength);
-
-  const style = {
-    position: 'absolute',
-    pointerEvents: 'auto',
-    width: labelLength,
-    padding: 0,
-    ...labelPosition,
-  };
-
-  return <StyledInputBase style={style} value={label} inputProps={{ ariaLabel: 'naked' }} />;
-};
-
-CoordinatesLabel.propTypes = {
-  graphProps: types.GraphPropsType,
-  x: PropTypes.number,
-  y: PropTypes.number,
-};
-
-export default CoordinatesLabel;

package/src/graph-with-controls.jsx

@@ -1,239 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import { styled } from '@mui/material/styles';
-import { isString, uniq } from 'lodash-es';
-import { color } from '@pie-lib/render-ui';
-
-import ToolMenu from './tool-menu';
-import Graph, { graphPropTypes } from './graph';
-import UndoRedo from './undo-redo';
-import { allTools, toolsArr } from './tools';
-import { Accordion, AccordionDetails, AccordionSummary, Typography } from '@mui/material';
-import ExpandMoreIcon from '@mui/icons-material/ExpandMore';
-
-const StyledGraphContainer = styled('div')({
-  display: 'flex',
-  flexDirection: 'column',
-  width: 'min-content',
-});
-
-const StyledControls = styled('div')(({ theme }) => ({
-  display: 'flex',
-  justifyContent: 'space-between',
-  padding: theme.spacing(1),
-  color: color.text(),
-  backgroundColor: color.primaryLight(),
-  '& button': {
-    fontSize: theme.typography.fontSize,
-  },
-}));
-
-const StyledAccordion = styled(Accordion)({
-  backgroundColor: color.primaryLight(),
-  width: '100%',
-});
-
-const StyledAccordionSummary = styled(AccordionSummary)(({ theme }) => ({
-  padding: `0 ${theme.spacing(1)}`,
-  minHeight: '32px !important',
-  '& .MuiAccordionSummary-content': {
-    margin: '4px 0 !important',
-  },
-}));
-
-const StyledAccordionDetails = styled(AccordionDetails)(({ theme }) => ({
-  padding: 0,
-  marginTop: theme.spacing(1),
-  display: 'flex',
-  justifyContent: 'space-between',
-}));
-
-export const setToolbarAvailability = (toolbarTools) =>
-  toolsArr.map((tA) => ({ ...tA, toolbar: !!toolbarTools.find((t) => t === tA.type) })) || [];
-
-export const toolIsAvailable = (tools, currentTool) =>
-  currentTool && tools && (tools.find((tool) => tool.type === currentTool.type) || {}).toolbar;
-
-export const getAvailableTool = (tools) => tools.find((tool) => tool.toolbar);
-
-export const filterByValidToolTypes = (backgroundMarks) =>
-  backgroundMarks.filter((bM) => !!allTools.find((tool) => tool === bM.type));
-
-export const filterByVisibleToolTypes = (toolbarTools, marks) =>
-  marks.filter((bM) => !!toolbarTools.find((tool) => tool === bM.type));
-
-const getDefaultCurrentTool = (toolType) => toolsArr.find((tool) => tool.type === toolType) || null;
-
-const Collapsible = ({ children, title }) => (
-  <StyledAccordion
-    elevation={0}
-    disableGutters={true}
-    square={true}
-    TransitionProps={{ timeout: { enter: 225, exit: 195 } }}
-  >
-    <StyledAccordionSummary expandIcon={<ExpandMoreIcon />}>
-      <Typography variant="subheading">{title}</Typography>
-    </StyledAccordionSummary>
-    <StyledAccordionDetails>{children}</StyledAccordionDetails>
-  </StyledAccordion>
-);
-
-Collapsible.propTypes = {
-  children: PropTypes.array,
-  title: PropTypes.string,
-};
-
-export class GraphWithControls extends React.Component {
-  static propTypes = {
-    ...graphPropTypes,
-    onUndo: PropTypes.func,
-    onRedo: PropTypes.func,
-    onReset: PropTypes.func,
-    toolbarTools: PropTypes.arrayOf(PropTypes.string), // array of tool types that have to be displayed in the toolbar, same shape as 'allTools'
-    language: PropTypes.string,
-  };
-
-  static defaultProps = {
-    collapsibleToolbar: false,
-    collapsibleToolbarTitle: '',
-    disabledLabels: false,
-    disabledTitle: false,
-    showLabels: true,
-    showTitle: true,
-    toolbarTools: [],
-  };
-
-  constructor(props) {
-    super(props);
-
-    this.state = {
-      currentTool: getDefaultCurrentTool(props.defaultTool),
-      labelModeEnabled: false,
-    };
-  }
-
-  componentDidUpdate(prevProps) {
-    const { defaultTool } = this.props;
-
-    if (prevProps.defaultTool !== defaultTool) {
-      const currentTool = getDefaultCurrentTool(defaultTool);
-
-      this.setState({ currentTool });
-    }
-  }
-
-  changeCurrentTool = (tool, tools) =>
-    this.setState({ currentTool: tools.find((t) => t.type === tool), labelModeEnabled: tool === 'label' });
-
-  render() {
-    let { currentTool, labelModeEnabled } = this.state;
-    const {
-      axesSettings,
-      className,
-      coordinatesOnHover,
-      collapsibleToolbar,
-      collapsibleToolbarTitle,
-      disabled,
-      disabledLabels,
-      disabledTitle,
-      domain,
-      draggableTools,
-      labels,
-      labelsPlaceholders,
-      onChangeLabels,
-      onChangeMarks,
-      onChangeTitle,
-      onChangeTools,
-      onUndo,
-      onRedo,
-      onReset,
-      range,
-      size,
-      showLabels,
-      showPixelGuides,
-      showTitle,
-      title,
-      titlePlaceholder,
-      language,
-      removeIncompleteTool,
-      limitLabeling,
-    } = this.props;
-    let { backgroundMarks, marks, toolbarTools } = this.props;
-
-    // make sure only valid tool types are kept (string) and without duplicates
-    toolbarTools = uniq(toolbarTools || []).filter((tT) => !!isString(tT)) || [];
-
-    // keep only the backgroundMarks that have valid types
-    backgroundMarks = filterByValidToolTypes(backgroundMarks || []);
-
-    // keep only the marks that have types which appear in toolbar
-    marks = filterByVisibleToolTypes(toolbarTools, marks || []);
-
-    const tools = setToolbarAvailability(toolbarTools);
-
-    // set current tool if there's no current tool or if the existing one is no longer available
-    if (!currentTool || !toolIsAvailable(tools, currentTool)) {
-      currentTool = getAvailableTool(tools);
-    }
-
-    const graphActions = (
-      <React.Fragment>
-        <ToolMenu
-          currentToolType={currentTool && currentTool.type}
-          disabled={!!disabled}
-          draggableTools={draggableTools}
-          labelModeEnabled={labelModeEnabled}
-          onChange={(tool) => this.changeCurrentTool(tool, tools)}
-          toolbarTools={toolbarTools}
-          onChangeTools={onChangeTools}
-          language={language}
-        />
-
-        {!disabled && <UndoRedo onUndo={onUndo} onRedo={onRedo} onReset={onReset} language={language} />}
-      </React.Fragment>
-    );
-
-    return (
-      <StyledGraphContainer className={className}>
-        <StyledControls>
-          {collapsibleToolbar ? (
-            <Collapsible title={collapsibleToolbarTitle}>{graphActions}</Collapsible>
-          ) : (
-            graphActions
-          )}
-        </StyledControls>
-
-        <div ref={(r) => (this.labelNode = r)} />
-
-        <Graph
-          axesSettings={axesSettings}
-          backgroundMarks={backgroundMarks}
-          coordinatesOnHover={coordinatesOnHover}
-          currentTool={currentTool}
-          disabledLabels={disabledLabels}
-          disabledTitle={disabledTitle}
-          domain={domain}
-          labels={labels}
-          labelModeEnabled={labelModeEnabled}
-          labelsPlaceholders={labelsPlaceholders}
-          marks={marks}
-          onChangeMarks={!disabled ? onChangeMarks : undefined}
-          onChangeLabels={onChangeLabels}
-          onChangeTitle={onChangeTitle}
-          range={range}
-          size={size}
-          showLabels={showLabels}
-          showPixelGuides={showPixelGuides}
-          showTitle={showTitle}
-          title={title}
-          titlePlaceholder={titlePlaceholder}
-          tools={tools}
-          removeIncompleteTool={removeIncompleteTool}
-          limitLabeling={limitLabeling}
-        />
-      </StyledGraphContainer>
-    );
-  }
-}
-
-export default GraphWithControls;