Package tech.tablesaw.plotly.traces

Class ScatterTrace.ScatterBuilder

java.lang.Object

tech.tablesaw.plotly.traces.TraceBuilder

tech.tablesaw.plotly.traces.ScatterTrace.ScatterBuilder

Enclosing class:

ScatterTrace

public static class ScatterTrace.ScatterBuilder
extends TraceBuilder

Field Summary

Fields inherited from class tech.tablesaw.plotly.traces.TraceBuilder

hoverLabel, ids, legendGroup, name, opacity, showLegend, visible, xAxis

Method Summary

Modifier and Type	Method	Description
ScatterTrace	build()
ScatterTrace.ScatterBuilder	decreasing(Decreasing decreasing)	For candlestick plots
ScatterTrace.ScatterBuilder	fill(ScatterTrace.Fill fill)
ScatterTrace.ScatterBuilder	fillColor(String fillColor)
protected String	getType()
ScatterTrace.ScatterBuilder	hoverLabel(HoverLabel hoverLabel)
ScatterTrace.ScatterBuilder	increasing(Increasing increasing)	For candlestick plots
ScatterTrace.ScatterBuilder	legendGroup(String group)
ScatterTrace.ScatterBuilder	line(Line line)
ScatterTrace.ScatterBuilder	marker(Marker marker)
ScatterTrace.ScatterBuilder	mode(ScatterTrace.Mode mode)
ScatterTrace.ScatterBuilder	name(String name)
ScatterTrace.ScatterBuilder	opacity(double n)
ScatterTrace.ScatterBuilder	showLegend(boolean showLegend)
ScatterTrace.ScatterBuilder	text(String[] text)
ScatterTrace.ScatterBuilder	type(String kind)
ScatterTrace.ScatterBuilder	visible(AbstractTrace.Visibility visibility)
ScatterTrace.ScatterBuilder	whiskerWidth(double width)	For candlestick plots
ScatterTrace.ScatterBuilder	xAxis(String xAxis)
ScatterTrace.ScatterBuilder	yAxis(String yAxis)
ScatterTrace.ScatterBuilder	yAxis(ScatterTrace.YAxis axis)	Sets a specific yAxis to this trace when you want to display more than one yAxis in a plot.

Methods inherited from class tech.tablesaw.plotly.traces.TraceBuilder

columnToStringArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

mode

public ScatterTrace.ScatterBuilder mode(ScatterTrace.Mode mode)

yAxis

public ScatterTrace.ScatterBuilder yAxis(ScatterTrace.YAxis axis)

Sets a specific yAxis to this trace when you want to display more than one yAxis in a plot. This can be ignored if only one y axis is desired for the whole plot, and need not be set if this trace should get the default y-axis.

There must be a corresponding Y Axis defined in the layout, e.g., if you specify YAxis.Y2 here, you must provide a value for yAxis2 in the layout

Parameters:

axis - The Axis to use for this trace

Returns:

this ScatterBuilder

line

public ScatterTrace.ScatterBuilder line(Line line)

whiskerWidth

public ScatterTrace.ScatterBuilder whiskerWidth(double width)

For candlestick plots

marker

public ScatterTrace.ScatterBuilder marker(Marker marker)

type

public ScatterTrace.ScatterBuilder type(String kind)

text

public ScatterTrace.ScatterBuilder text(String[] text)

increasing

public ScatterTrace.ScatterBuilder increasing(Increasing increasing)

For candlestick plots

decreasing

public ScatterTrace.ScatterBuilder decreasing(Decreasing decreasing)

For candlestick plots

fill

public ScatterTrace.ScatterBuilder fill(ScatterTrace.Fill fill)

fillColor

public ScatterTrace.ScatterBuilder fillColor(String fillColor)

build

public ScatterTrace build()

getType

protected String getType()

Specified by:

getType in class TraceBuilder

name

public ScatterTrace.ScatterBuilder name(String name)

Overrides:

name in class TraceBuilder

opacity

public ScatterTrace.ScatterBuilder opacity(double n)

Overrides:

opacity in class TraceBuilder

legendGroup

public ScatterTrace.ScatterBuilder legendGroup(String group)

Overrides:

legendGroup in class TraceBuilder

showLegend

public ScatterTrace.ScatterBuilder showLegend(boolean showLegend)

Overrides:

showLegend in class TraceBuilder

visible

public ScatterTrace.ScatterBuilder visible(AbstractTrace.Visibility visibility)

Overrides:

visible in class TraceBuilder

hoverLabel

public ScatterTrace.ScatterBuilder hoverLabel(HoverLabel hoverLabel)

Overrides:

hoverLabel in class TraceBuilder

xAxis

public ScatterTrace.ScatterBuilder xAxis(String xAxis)

Overrides:

xAxis in class TraceBuilder

yAxis

public ScatterTrace.ScatterBuilder yAxis(String yAxis)

Overrides:

yAxis in class TraceBuilder