Package tech.tablesaw.plotly.components

Class Figure

java.lang.Object

tech.tablesaw.plotly.components.Figure

public class Figure
extends Object

Plotly's graph description places attributes into two categories: traces (objects that describe a single series of data in a graph like Scatter or Heatmap) and layout attributes that apply to the rest of the chart, like the title, xaxis, or annotations).

Figure combines the two parts, associating one or more traces with a layout. If the layout is null a default layout is provided.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Figure.FigureBuilder

Constructor Summary

Constructors

Constructor	Description
Figure(Figure.FigureBuilder builder)
Figure(Layout layout, Config config, Trace... traces)
Figure(Layout layout, EventHandler[] eventHandlers, Trace... traces)	Deprecated. Use the FigureBuilder instead
Figure(Layout layout, EventHandler eventHandler, Trace... traces)	Deprecated. Use the FigureBuilder instead
Figure(Layout layout, Trace... traces)
Figure(Trace... traces)

Method Summary

Modifier and Type	Method	Description
String	asJavascript(String divName)
protected void	buildContext(String divName)
static Figure.FigureBuilder	builder()
String	divString(String divName)
protected String	eventHandlerFunction(String targetName, String divName)
Config	getConfig()
Map<String,Object>	getContext()
EventHandler[]	getEventHandlers()
Layout	getLayout()
Trace[]	getTraces()
protected String	plotFunction(String divName)
void	setConfig(Config config)
void	setEventHandlers(EventHandler... handlers)
void	setLayout(Layout layout)
void	setTraces(Trace... data)

Methods inherited from class java.lang.Object

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

Constructor Detail

Figure

public Figure(Figure.FigureBuilder builder)

Figure

public Figure(Trace... traces)

Figure

public Figure(Layout layout,
              Trace... traces)

Figure

public Figure(Layout layout,
              Config config,
              Trace... traces)

Figure

@Deprecated
public Figure(Layout layout,
              EventHandler eventHandler,
              Trace... traces)

Deprecated. Use the FigureBuilder instead

Figure

@Deprecated
public Figure(Layout layout,
              EventHandler[] eventHandlers,
              Trace... traces)

Deprecated. Use the FigureBuilder instead

Method Detail

divString

public String divString(String divName)

getLayout

public Layout getLayout()

setLayout

public void setLayout(Layout layout)

getConfig

public Config getConfig()

setConfig

public void setConfig(Config config)

getEventHandlers

public EventHandler[] getEventHandlers()

setEventHandlers

public void setEventHandlers(EventHandler... handlers)

getTraces

public Trace[] getTraces()

setTraces

public void setTraces(Trace... data)

asJavascript

public String asJavascript(String divName)

buildContext

protected void buildContext(String divName)

plotFunction

protected String plotFunction(String divName)

eventHandlerFunction

protected String eventHandlerFunction(String targetName,
                                      String divName)

getContext

public Map<String,Object> getContext()

builder

public static Figure.FigureBuilder builder()