stackEnter.ts

import { deepMix } from '@antv/util';
import { group, max } from 'd3-array';
import { TransformComponent as TC } from '../runtime';
import { StackEnterTransform } from '../spec';
import {
  columnOf,
  constant,
  maybeColumnOf,
  visualColumn,
} from './utils/helper';

export type StackEnterOptions = Omit<StackEnterTransform, 'type'>;

/**
 * Group marks by channels into groups and stacking their enterDelay
 * to make marks show up groups by groups.
 * It will update enterDelay channel for each mark by its enterDuration and group.
 * @todo Support orderBy.
 * @todo Sort among groups(e.g. reverse).
 * @todo Stack enter in groups rather than between groups?
 * @todo Auto inter this statistic for scaleInY animation in stacked interval?
 * @todo All the groups shared the enterDuration?
 */
export const StackEnter: TC<StackEnterOptions> = (options) => {
  const {
    groupBy = ['x'],
    reducer = (I, V) => V[I[0]],
    orderBy = null,
    reverse = false,
    duration,
  } = options;
  return (I, mark) => {
    const { encode } = mark;

    // Extract group information by each specified channel,
    // and skip if all values of channels are empty.
    const by = Array.isArray(groupBy) ? groupBy : [groupBy];
    const groupEntries = by.map((k) => [k, columnOf(encode, k)[0]]);
    if (groupEntries.length === 0) return [I, mark];

    // Nest group index and flatten them in right order among timeline.
    // [[1, 2, 3, 4, 5, 6]] ->
    // [[1, 2, 3], [4, 5, 6]] ->
    // [[1], [2], [3], [4], [5], [6]]
    let groups = [I];
    for (const [, V] of groupEntries) {
      const newGroups = [];
      for (const I of groups) {
        const G = Array.from(group(I, (i) => V[i]).values());
        // @todo sort by x.
        newGroups.push(...G);
      }
      groups = newGroups;
    }

    // const {color} = encode;
    if (orderBy) {
      const [V] = columnOf(encode, orderBy);
      if (V) groups.sort((I, J) => reducer(I, V) - reducer(J, V));
      if (reverse) groups.reverse();
    }

    // Stack delay for each group.
    const t = (duration || 3000) / groups.length;
    const [ED] = duration
      ? [constant(I, t)] // If specified duration, generate enter duration for each.
      : maybeColumnOf(encode, 'enterDuration', constant(I, t));
    const [EDL] = maybeColumnOf(encode, 'enterDelay', constant(I, 0));
    const newEnterDelay = new Array(I.length);
    for (let i = 0, pd = 0; i < groups.length; i++) {
      const I = groups[i];
      const maxDuration = max(I, (i) => +ED[i]);
      for (const j of I) newEnterDelay[j] = +EDL[j] + pd;
      pd += maxDuration;
    }

    return [
      I,
      deepMix({}, mark, {
        encode: {
          enterDuration: visualColumn(ED),
          enterDelay: visualColumn(newEnterDelay),
        },
      }),
    ];
  };
};

StackEnter.props = {};