superset2/superset-frontend/src/explore/components/controls/TimeSeriesColumnControl/index.tsx

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
import { Component } from 'react';
import {
  Button,
  Col,
  Divider,
  InfoTooltip,
  Input,
  Row,
  Select,
} from '@superset-ui/core/components';
import { t } from '@apache-superset/core/translation';
import { styled } from '@apache-superset/core/theme';
import { Icons } from '@superset-ui/core/components/Icons';
import BoundsControl from '../BoundsControl';
import CheckboxControl from '../CheckboxControl';
import ControlPopover from '../ControlPopover/ControlPopover';

interface TimeSeriesColumnControlProps {
  label?: string;
  tooltip?: string;
  colType?: string;
  width?: string;
  height?: string;
  timeLag?: string | number;
  timeRatio?: string;
  comparisonType?: string;
  showYAxis?: boolean;
  yAxisBounds?: (number | null)[];
  bounds?: (number | null)[];
  d3format?: string;
  dateFormat?: string;
  sparkType?: string;
  onChange?: (state: TimeSeriesColumnControlState) => void;
}

interface TimeSeriesColumnControlState {
  label: string;
  tooltip: string;
  colType: string;
  width: string;
  height: string;
  timeLag: string | number;
  timeRatio: string;
  comparisonType: string;
  showYAxis: boolean;
  yAxisBounds: (number | null)[];
  bounds: (number | null)[];
  d3format: string;
  dateFormat: string;
  sparkType: string;
  popoverVisible: boolean;
}

const defaultProps = {
  label: t('Time series columns'),
  tooltip: '',
  colType: '',
  width: '',
  height: '',
  timeLag: '',
  timeRatio: '',
  comparisonType: '',
  showYAxis: false,
  yAxisBounds: [null, null],
  bounds: [null, null],
  d3format: '',
  dateFormat: '',
  sparkType: 'line',
};

const comparisonTypeOptions = [
  { value: 'value', label: t('Actual value'), key: 'value' },
  { value: 'diff', label: t('Difference'), key: 'diff' },
  { value: 'perc', label: t('Percentage'), key: 'perc' },
  { value: 'perc_change', label: t('Percentage change'), key: 'perc_change' },
];

const colTypeOptions = [
  { value: 'time', label: t('Time comparison'), key: 'time' },
  { value: 'contrib', label: t('Contribution'), key: 'contrib' },
  { value: 'spark', label: t('Sparkline'), key: 'spark' },
  { value: 'avg', label: t('Period average'), key: 'avg' },
];

const sparkTypeOptions = [
  { value: 'line', label: t('Line Chart'), key: 'line' },
  { value: 'bar', label: t('Bar Chart'), key: 'bar' },
  { value: 'area', label: t('Area Chart'), key: 'area' },
];

const StyledRow = styled(Row)`
  margin-top: ${({ theme }) => theme.sizeUnit * 2}px;
  display: flex;
  align-items: center;
`;

const StyledCol = styled(Col)`
  display: flex;
  align-items: center;
`;

const StyledTooltip = styled(InfoTooltip)`
  margin-left: ${({ theme }) => theme.sizeUnit}px;
  color: ${({ theme }) => theme.colorIcon};
`;

const ButtonBar = styled.div`
  margin-top: ${({ theme }) => theme.sizeUnit * 5}px;
  display: flex;
  justify-content: center;
`;

export default class TimeSeriesColumnControl extends Component<
  TimeSeriesColumnControlProps,
  TimeSeriesColumnControlState
> {
  static defaultProps = defaultProps;

  constructor(props: TimeSeriesColumnControlProps) {
    super(props);

    this.onSave = this.onSave.bind(this);
    this.onClose = this.onClose.bind(this);
    this.resetState = this.resetState.bind(this);
    this.initialState = this.initialState.bind(this);
    this.onPopoverVisibleChange = this.onPopoverVisibleChange.bind(this);

    this.state = this.initialState();
  }

  initialState(): TimeSeriesColumnControlState {
    return {
      label: this.props.label ?? t('Time series columns'),
      tooltip: this.props.tooltip ?? '',
      colType: this.props.colType ?? '',
      width: this.props.width ?? '',
      height: this.props.height ?? '',
      timeLag: this.props.timeLag ?? 0,
      timeRatio: this.props.timeRatio ?? '',
      comparisonType: this.props.comparisonType ?? '',
      showYAxis: this.props.showYAxis ?? false,
      yAxisBounds: this.props.yAxisBounds ?? [null, null],
      bounds: this.props.bounds ?? [null, null],
      d3format: this.props.d3format ?? '',
      dateFormat: this.props.dateFormat ?? '',
      sparkType: this.props.sparkType ?? 'line',
      popoverVisible: false,
    };
  }

  resetState() {
    const initialState = this.initialState();
    this.setState({ ...initialState });
  }

  onSave() {
    this.props.onChange?.(this.state);
    this.setState({ popoverVisible: false });
  }

  onClose() {
    this.resetState();
  }

  onSelectChange(attr: string, opt: string) {
    this.setState(prevState => ({ ...prevState, [attr]: opt }));
  }

  onTextInputChange(attr: string, event: React.ChangeEvent<HTMLInputElement>) {
    this.setState(prevState => ({ ...prevState, [attr]: event.target.value }));
  }

  onCheckboxChange(attr: string, value: boolean) {
    this.setState(prevState => ({ ...prevState, [attr]: value }));
  }

  onBoundsChange(bounds: (number | null)[]) {
    this.setState({ bounds });
  }

  onPopoverVisibleChange(popoverVisible: boolean) {
    if (popoverVisible) {
      this.setState({ popoverVisible });
    } else {
      this.resetState();
    }
  }

  onYAxisBoundsChange(yAxisBounds: (number | null)[]) {
    this.setState({ yAxisBounds });
  }

  textSummary() {
    return `${this.props.label ?? ''}`;
  }

  formRow(
    label: string,
    tooltip: string,
    ttLabel: string,
    control: React.ReactNode,
  ) {
    return (
      <StyledRow>
        <StyledCol xs={24} md={11}>
          {label}
          <StyledTooltip placement="top" tooltip={tooltip} label={ttLabel} />
        </StyledCol>
        <Col xs={24} md={13}>
          {control}
        </Col>
      </StyledRow>
    );
  }

  renderPopover() {
    return (
      <div id="ts-col-popo" style={{ width: 320 }}>
        {this.formRow(
          t('Label'),
          t('The column header label'),
          'time-lag',
          <Input
            value={this.state.label}
            onChange={this.onTextInputChange.bind(this, 'label')}
            placeholder={t('Label')}
          />,
        )}
        {this.formRow(
          t('Tooltip'),
          t('Column header tooltip'),
          'col-tooltip',
          <Input
            value={this.state.tooltip}
            onChange={this.onTextInputChange.bind(this, 'tooltip')}
            placeholder={t('Tooltip')}
          />,
        )}
        {this.formRow(
          t('Type'),
          t('Type of comparison, value difference or percentage'),
          'col-type',
          <Select
            ariaLabel={t('Type')}
            value={this.state.colType || undefined}
            onChange={this.onSelectChange.bind(this, 'colType')}
            options={colTypeOptions}
          />,
        )}
        <Divider />
        {this.state.colType === 'spark' &&
          this.formRow(
            t('Chart type'),
            t('Type of chart to display in sparkline'),
            'spark-type',
            <Select
              ariaLabel={t('Chart Type')}
              value={this.state.sparkType || undefined}
              onChange={this.onSelectChange.bind(this, 'sparkType')}
              options={sparkTypeOptions}
            />,
          )}
        {this.state.colType === 'spark' &&
          this.formRow(
            t('Width'),
            t('Width of the sparkline'),
            'spark-width',
            <Input
              value={this.state.width}
              onChange={this.onTextInputChange.bind(this, 'width')}
              placeholder={t('Width')}
            />,
          )}
        {this.state.colType === 'spark' &&
          this.formRow(
            t('Height'),
            t('Height of the sparkline'),
            'spark-width',
            <Input
              value={this.state.height}
              onChange={this.onTextInputChange.bind(this, 'height')}
              placeholder={t('Height')}
            />,
          )}
        {['time', 'avg'].indexOf(this.state.colType) >= 0 &&
          this.formRow(
            t('Time lag'),
            t(
              'Number of periods to compare against. You can use negative numbers to compare from the beginning of the time range.',
            ),
            'time-lag',
            <Input
              value={this.state.timeLag}
              onChange={this.onTextInputChange.bind(this, 'timeLag')}
              placeholder={t('Time Lag')}
            />,
          )}
        {['spark'].indexOf(this.state.colType) >= 0 &&
          this.formRow(
            t('Time ratio'),
            t('Number of periods to ratio against'),
            'time-ratio',
            <Input
              value={this.state.timeRatio}
              onChange={this.onTextInputChange.bind(this, 'timeRatio')}
              placeholder={t('Time Ratio')}
            />,
          )}
        {this.state.colType === 'time' &&
          this.formRow(
            t('Type'),
            t('Type of comparison, value difference or percentage'),
            'comp-type',
            <Select
              ariaLabel={t('Type')}
              value={this.state.comparisonType || undefined}
              onChange={this.onSelectChange.bind(this, 'comparisonType')}
              options={comparisonTypeOptions}
            />,
          )}
        {this.state.colType === 'spark' &&
          this.formRow(
            t('Show Y-axis'),
            t(
              'Show Y-axis on the sparkline. Will display the manually set min/max if set or min/max values in the data otherwise.',
            ),
            'show-y-axis-bounds',
            <CheckboxControl
              value={this.state.showYAxis}
              onChange={this.onCheckboxChange.bind(this, 'showYAxis')}
            />,
          )}
        {this.state.colType === 'spark' &&
          this.formRow(
            t('Y-axis bounds'),
            t('Manually set min/max values for the y-axis.'),
            'y-axis-bounds',
            <BoundsControl
              value={this.state.yAxisBounds}
              onChange={this.onYAxisBoundsChange.bind(this)}
            />,
          )}
        {this.state.colType !== 'spark' &&
          this.formRow(
            t('Color bounds'),
            t(`Number bounds used for color encoding from red to blue.
               Reverse the numbers for blue to red. To get pure red or blue,
               you can enter either only min or max.`),
            'bounds',
            <BoundsControl
              value={this.state.bounds}
              onChange={this.onBoundsChange.bind(this)}
            />,
          )}
        {this.formRow(
          t('Number format'),
          t('Optional d3 number format string'),
          'd3-format',
          <Input
            value={this.state.d3format}
            onChange={this.onTextInputChange.bind(this, 'd3format')}
            placeholder={t('Number format string')}
          />,
        )}
        {this.state.colType === 'spark' &&
          this.formRow(
            t('Date format'),
            t('Optional d3 date format string'),
            'date-format',
            <Input
              value={this.state.dateFormat}
              onChange={this.onTextInputChange.bind(this, 'dateFormat')}
              placeholder={t('Date format string')}
            />,
          )}
        <ButtonBar>
          <Button buttonSize="small" onClick={this.onClose} cta>
            {t('Close')}
          </Button>
          <Button
            buttonStyle="primary"
            buttonSize="small"
            onClick={this.onSave}
            cta
          >
            {t('Save')}
          </Button>
        </ButtonBar>
      </div>
    );
  }

  render() {
    return (
      <span>
        {this.textSummary()}{' '}
        <ControlPopover
          trigger="click"
          content={this.renderPopover()}
          title={t('Column Configuration')}
          open={this.state.popoverVisible}
          onOpenChange={this.onPopoverVisibleChange}
        >
          <span
            css={theme => ({
              display: 'inline-block',
              cursor: 'pointer',
              '& svg path': {
                fill: theme.colorIcon,
                transition: `fill ${theme.motionDurationMid} ease-out`,
              },
              '&:hover svg path': {
                fill: theme.colorPrimary,
              },
            })}
          >
            <Icons.EditOutlined iconSize="s" />
          </span>
        </ControlPopover>
      </span>
    );
  }
}