Package tech.tablesaw.plotly.components

Class ColorBar.ColorBarBuilder

java.lang.Object

tech.tablesaw.plotly.components.ColorBar.ColorBarBuilder

Enclosing class:

ColorBar

public static class ColorBar.ColorBarBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
ColorBarBuilder()

Method Summary

Modifier and Type	Method	Description
ColorBar.ColorBarBuilder	bgColor(java.lang.String color)	Sets the color of padded area.
ColorBar.ColorBarBuilder	borderColor(java.lang.String color)	Sets the color of the border enclosing this color bar.
ColorBar.ColorBarBuilder	borderWidth(int width)	Sets the width (in px) or the border enclosing this color bar.
ColorBar.ColorBarBuilder	len(double len)	Sets the length of the color bar, This measure excludes the size of the padding, ticks and labels.
ColorBar.ColorBarBuilder	lenMode(ColorBar.LenMode lenMode)	Determines whether this color bar's length (i.e.
ColorBar.ColorBarBuilder	outlineColor(java.lang.String outlineColor)	Sets the axis line color.
ColorBar.ColorBarBuilder	outlineWidth(int width)	Sets the width (in px) of the axis line.
ColorBar.ColorBarBuilder	thickness(double thickness)	Sets the thickness of the color bar, This measure excludes the size of the padding, ticks and labels.
ColorBar.ColorBarBuilder	thicknessMode(ColorBar.ThicknessMode mode)
ColorBar.ColorBarBuilder	tickSettings(TickSettings tickSettings)
ColorBar.ColorBarBuilder	x(double x)	A number between or equal to -2and 3) default:1.02 Sets the x position of the color bar(in plot fraction).
ColorBar.ColorBarBuilder	xAnchor(ColorBar.Xanchor xAnchor)	Sets this color bar's horizontal position anchor.
ColorBar.ColorBarBuilder	xPad(int xPad)	Sets the amount of padding(in px) along the x direction.
ColorBar.ColorBarBuilder	y(double y)	A number between or equal to -2and 3) default:0.5 Sets the y position of the color bar (in plot fraction).
ColorBar.ColorBarBuilder	yAnchor(ColorBar.Yanchor yAnchor)	Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
ColorBar.ColorBarBuilder	yPad(int yPad)	Sets the amount of paddng (in px) along the y direction.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColorBarBuilder

public ColorBarBuilder()

Method Detail

thickness

public ColorBar.ColorBarBuilder thickness(double thickness)

Sets the thickness of the color bar, This measure excludes the size of the padding, ticks and labels.

Parameters:

thickness - a double greater than 0

Returns:

this ColorBar

len

public ColorBar.ColorBarBuilder len(double len)

Sets the length of the color bar, This measure excludes the size of the padding, ticks and labels.

Parameters:

len - a double greater than 0

Returns:

this ColorBar

lenMode

public ColorBar.ColorBarBuilder lenMode(ColorBar.LenMode lenMode)

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

thicknessMode

public ColorBar.ColorBarBuilder thicknessMode(ColorBar.ThicknessMode mode)

x

public ColorBar.ColorBarBuilder x(double x)

A number between or equal to -2and 3) default:1.02 Sets the x position of the color bar(in plot fraction).

y

public ColorBar.ColorBarBuilder y(double y)

A number between or equal to -2and 3) default:0.5 Sets the y position of the color bar (in plot fraction).

xAnchor

public ColorBar.ColorBarBuilder xAnchor(ColorBar.Xanchor xAnchor)

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

yAnchor

public ColorBar.ColorBarBuilder yAnchor(ColorBar.Yanchor yAnchor)

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

yPad

public ColorBar.ColorBarBuilder yPad(int yPad)

Sets the amount of paddng (in px) along the y direction.

xPad

public ColorBar.ColorBarBuilder xPad(int xPad)

Sets the amount of padding(in px) along the x direction.

outlineColor

public ColorBar.ColorBarBuilder outlineColor(java.lang.String outlineColor)

Sets the axis line color.

borderColor

public ColorBar.ColorBarBuilder borderColor(java.lang.String color)

Sets the color of the border enclosing this color bar.

bgColor

public ColorBar.ColorBarBuilder bgColor(java.lang.String color)

Sets the color of padded area.

borderWidth

public ColorBar.ColorBarBuilder borderWidth(int width)

Sets the width (in px) or the border enclosing this color bar.

outlineWidth

public ColorBar.ColorBarBuilder outlineWidth(int width)

Sets the width (in px) of the axis line.

tickSettings

public ColorBar.ColorBarBuilder tickSettings(TickSettings tickSettings)