tech.tablesaw.plotly.traces.AbstractTrace Maven / Gradle / Ivy

Go to download
package tech.tablesaw.plotly.traces;

import java.io.IOException;
import java.io.StringWriter;
import java.io.UncheckedIOException;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;
import io.pebbletemplates.pebble.PebbleEngine;
import io.pebbletemplates.pebble.error.PebbleException;
import io.pebbletemplates.pebble.template.PebbleTemplate;
import tech.tablesaw.plotly.components.HoverLabel;
import tech.tablesaw.plotly.components.TemplateUtils;

public abstract class AbstractTrace implements Trace {

  protected static final double DEFAULT_OPACITY = 1.0;
  protected static final Visibility DEFAULT_VISIBILITY = Visibility.TRUE;

  protected final PebbleEngine engine = TemplateUtils.getNewEngine();

  public enum Visibility {
    TRUE("True"),
    FALSE("False"),
    LEGEND_ONLY("legendonly");

    private final String value;

    Visibility(String value) {
      this.value = value;
    }

    @Override
    public String toString() {
      return value;
    }
  }

  protected final String type;

  private final Visibility visible;

  /** Determines whether or not an item corresponding to this trace is shown in the legend. */
  private final Boolean showLegend;

  /**
   * Sets the legend group for this trace. Traces part of the same legend group hide/show at the
   * same time when toggling legend items.
   */
  private final String legendGroup;

  /** Sets the opacity of the trace. */
  private final double opacity; // number between or equal to 0 and 1

  /** Sets the trace name. The trace name appear as the legend item and on hover. */
  private final String name;

  /**
   * Assigns id labels to each datum. These ids for object constancy of data points during
   * animation. Should be an array of strings, not numbers or any other type.
   */
  private final String[] ids;

  /**
   * Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* , the x
   * coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and
   * so on.
   */
  private final String xAxis;
  /**
   * Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* , the y
   * coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and
   * so on.
   */
  private final String yAxis;

  private final HoverLabel hoverLabel;

  public AbstractTrace(TraceBuilder builder) {
    this.type = builder.getType();
    this.name = builder.name;
    this.showLegend = builder.showLegend;
    this.legendGroup = builder.legendGroup;
    this.visible = builder.visible;
    this.ids = builder.ids;
    this.hoverLabel = builder.hoverLabel;
    this.opacity = builder.opacity;
    this.xAxis = builder.xAxis;
    this.yAxis = builder.yAxis;
  }

  @Override
  public String name() {
    return name;
  }

  @Override
  public String toString() {
    Writer writer = new StringWriter();
    PebbleTemplate compiledTemplate;

    try {
      compiledTemplate = engine.getTemplate("trace_template.html");
      compiledTemplate.evaluate(writer, getContext());
    } catch (PebbleException e) {
      throw new IllegalStateException(e);
    } catch (IOException e) {
      throw new UncheckedIOException(e);
    }
    return writer.toString();
  }

  protected Map getContext() {
    Map context = new HashMap<>();
    context.put("type", type);
    context.put("name", name);
    if (showLegend != null) {
      context.put("showLegend", showLegend);
    }

    context.put("legendGroup", legendGroup);

    if (!visible.equals(DEFAULT_VISIBILITY)) {
      context.put("visible", visible);
    }
    context.put("ids", ids);
    context.put("hoverLable", hoverLabel);
    if (opacity != DEFAULT_OPACITY) {
      context.put("opacity", opacity);
    }
    context.put("xAxis", xAxis);
    context.put("yAxis", yAxis);
    return context;
  }

  @Override
  public HoverLabel hoverLabel() {
    return hoverLabel;
  }

  @Override
  public boolean showLegend() {
    return showLegend;
  }
}