tech.tablesaw.plotly.traces.TraceBuilder 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.traces;

import com.google.common.base.Preconditions;
import tech.tablesaw.columns.Column;
import tech.tablesaw.plotly.components.HoverLabel;

public abstract class TraceBuilder {

    protected AbstractTrace.Visibility visible = AbstractTrace.DEFAULT_VISIBILITY;

    /**
     * Determines whether or not an item corresponding to this trace is shown in the legend.
     */
    protected boolean showLegend = AbstractTrace.DEFAULT_SHOW_LEGEND;

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

    /**
     * Sets the opacity of the trace.
     */
    protected double opacity = AbstractTrace.DEFAULT_OPACITY; // number between or equal to 0 and 1

    /**
     * Sets the trace name. The trace name appear as the legend item and on hover.
     */
    protected 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.
     */
    protected String[] ids;

    protected HoverLabel hoverLabel;

    TraceBuilder() {}

    protected abstract String getType();

    public TraceBuilder name(String name) {
        this.name = name;
        return this;
    }

    public TraceBuilder opacity(double n) {
        Preconditions.checkArgument(n >= 0 && n <= 1);
        this.opacity = n;
        return this;
    }

    public TraceBuilder legendGroup(String group) {
        this.legendGroup = group;
        return this;
    }

    protected TraceBuilder showLegend(boolean showLegend) {
        this.showLegend = showLegend;
        return this;
    }

    protected TraceBuilder visible(AbstractTrace.Visibility visibility) {
        this.visible = visibility;
        return this;
    }

    protected TraceBuilder hoverLabel(HoverLabel hoverLabel) {
        this.hoverLabel = hoverLabel;
        return this;
    }

    protected static String[] columnToStringArray(Column column) {
        String[] x = new String[column.size()];
        for (int i = 0; i < column.size(); i++) {
            x[i] = column.getString(i);
        }
        return x;
    }
}