tech.tablesaw.plotly.components.Grid Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tablesaw-jsplot Show documentation
There is a newer version: 0.43.1
package tech.tablesaw.plotly.components;

import com.google.common.base.Preconditions;
import java.util.HashMap;
import java.util.Map;

public class Grid extends Component {

  public enum RowOrder {
    ENUMERATED,
    TOP_TO_BOTTOM,
    BOTTOM_TO_TOP;

    @Override
    public String toString() {
      return this.name().toLowerCase().replaceAll("_", " ");
    }
  }

  public enum XSide {
    BOTTOM,
    BOTTOM_PLOT,
    TOP,
    TOP_PLOT;

    @Override
    public String toString() {
      return this.name().toLowerCase().replaceAll("_", " ");
    }
  }

  public enum YSide {
    LEFT,
    LEFT_PLOT,
    RIGHT,
    RIGHT_PLOT;

    @Override
    public String toString() {
      return this.name().toLowerCase().replaceAll("_", " ");
    }
  }

  public enum Pattern {
    INDEPENDENT,
    COUPLED;

    @Override
    public String toString() {
      return this.name().toLowerCase();
    }
  }

  /**
   * The number of rows in the grid. If you provide a 2D `subplots` array or a `yaxes` array, its
   * length is used as the default. But it's also possible to have a different length, if you want
   * to leave a row at the end for non-cartesian subplots.
   */
  private final int rows;

  /**
   * Is the first row the top or the bottom? Note that columns are always enumerated from left to
   * right.
   */
  private final RowOrder rowOrder;

  /**
   * If no `subplots`, `xaxes`, or `yaxes` are given but we do have `rows` and `columns`,', we can
   * generate defaults using consecutive axis IDs, in two ways:', '*coupled* gives one x axis per
   * column and one y axis per row.', '*independent* uses a new xy pair for each cell, left-to-right
   * across each row', 'then iterating rows according to `roworder`.
   */
  private final Pattern pattern;

  /**
   * The number of columns in the grid. If you provide a 2D `subplots` array, the length of its
   * longest row is used as the default. If you give an `xaxes` array, its length is used as the
   * default. But it's also possible to have a different length, if you want to leave a row at the
   * end for non-cartesian subplots.
   */
  private final int columns;

  /**
   * Horizontal space between grid cells, expressed as a fraction of the total width available to
   * one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids.
   */
  private final double xGap; // number between or equal to 0 and 1

  /**
   * Vertical space between grid cells, expressed as a fraction of the total height available to one
   * cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids.
   */
  private final double yGap; // number between or equal to 0 and 1

  private final XSide xSide;

  private final YSide ySide;

  public Grid(GridBuilder gridBuilder) {
    this.rows = gridBuilder.rows;
    this.columns = gridBuilder.columns;
    this.rowOrder = gridBuilder.rowOrder;
    this.xGap = gridBuilder.xGap;
    this.yGap = gridBuilder.yGap;
    this.pattern = gridBuilder.pattern;
    this.xSide = gridBuilder.xSide;
    this.ySide = gridBuilder.ySide;
  }

  @Override
  public String asJavascript() {
    return asJavascript("grid_template.html");
  }

  @Override
  protected Map getContext() {
    Map context = new HashMap<>();
    context.put("xGap", xGap);
    context.put("yGap", yGap);
    context.put("rows", rows);
    context.put("columns", columns);
    context.put("rowOrder", rowOrder);
    context.put("pattern", pattern);
    context.put("xSide", xSide);
    context.put("ySide", ySide);
    return context;
  }

  public static GridBuilder builder() {
    return new GridBuilder();
  }

  public static class GridBuilder {

    private int rows = 80;

    private int columns = 80;

    private double xGap = 100;

    private double yGap = 80;

    private XSide xSide = XSide.BOTTOM;

    private YSide ySide = YSide.LEFT;

    private RowOrder rowOrder = RowOrder.TOP_TO_BOTTOM;
    private Pattern pattern = Pattern.COUPLED;

    private GridBuilder() {}

    /**
     * The number of rows in the grid. If you provide a 2D `subplots` array or a `yaxes` array, its
     * length is used as the default. But it's also possible to have a different length, if you want
     * to leave a row at the end for non-cartesian subplots.
     *
     * @param rows an integer greater than or equal to 1
     * @return this GridBuilder
     */
    public GridBuilder rows(int rows) {
      Preconditions.checkArgument(rows >= 1);
      this.rows = rows;
      return this;
    }

    /**
     * The number of columns in the grid. If you provide a 2D `subplots` array, the length of its
     * longest row is used as the default. If you give an `xaxes` array, its length is used as the
     * default. But it's also possible to have a different length, if you want to leave a row at the
     * end for non-cartesian subplots.
     *
     * @param columns an integer greater than or equal to 1
     * @return this GridBuilder
     */
    public GridBuilder columns(int columns) {
      Preconditions.checkArgument(rows >= 1);
      this.columns = columns;
      return this;
    }

    /**
     * Horizontal space between grid cells, expressed as a fraction of the total width available to
     * one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids.
     *
     * @param xGap a double >= 0 && <= 1
     * @return this GridBuilder
     */
    public GridBuilder xGap(double xGap) {
      Preconditions.checkArgument(xGap >= 0 && xGap <= 1);
      this.xGap = xGap;
      return this;
    }

    /**
     * Vertical space between grid cells, expressed as a fraction of the total height available to
     * one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids.
     *
     * @param yGap a double >= 0 && <= 1
     * @return this GridBuilder
     */
    public GridBuilder yGap(double yGap) {
      Preconditions.checkArgument(yGap >= 0 && yGap <= 1);
      this.yGap = yGap;
      return this;
    }

    /**
     * Sets where the y axis labels and titles go. "left" means the very left edge of the grid.
     * "left plot" is the leftmost plot that each y axis is used in. "right" and "right plot" are
     * similar.
     */
    public GridBuilder ySide(YSide ySide) {
      this.ySide = ySide;
      return this;
    }

    /**
     * Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid.
     * "bottom plot" is the lowest plot that each x axis is used in. "top" and "top plot" are
     * similar.
     */
    public GridBuilder xSide(XSide xSide) {
      this.xSide = xSide;
      return this;
    }

    public GridBuilder rowOrder(RowOrder rowOrder) {
      this.rowOrder = rowOrder;
      return this;
    }

    /**
     * If no `subplots`, `xaxes`, or `yaxes` are given but we do have `rows` and `columns`,', we can
     * generate defaults using consecutive axis IDs, in two ways:', '*coupled* gives one x axis per
     * column and one y axis per row.', '*independent* uses a new xy pair for each cell,
     * left-to-right across each row', 'then iterating rows according to `roworder`.
     *
     * @param pattern defaults to COUPLED
     * @return this GridBuilder
     */
    public GridBuilder pattern(Pattern pattern) {
      this.pattern = pattern;
      return this;
    }

    public Grid build() {
      return new Grid(this);
    }
  }
}