Package tech.tablesaw.plotly.components

Class Marker.MarkerBuilder

java.lang.Object

tech.tablesaw.plotly.components.Marker.MarkerBuilder

Enclosing class:

Marker

public static class Marker.MarkerBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
MarkerBuilder()

Method Summary

Modifier and Type	Method	Description
Marker.MarkerBuilder	autoColorScale(boolean b)	Has an effect only if `marker.color` is set to a numerical array.
Marker	build()
Marker.MarkerBuilder	cAuto(boolean b)	Has an effect only if `marker.color` is set to a numerical array and `cmin`, `cmax` are also set.
Marker.MarkerBuilder	cMinAndMax(double min, double max)	Has an effect only if `marker.color` is set to a numerical array.
Marker.MarkerBuilder	color(double[] color)	Sets the marker color to an array of numeric values for use when a color scale is provided
Marker.MarkerBuilder	color(String color)	Sets the marker color to a single value
Marker.MarkerBuilder	color(String[] color)	Sets the marker color to an array of color values
Marker.MarkerBuilder	colorBar(ColorBar colorBar)	Sets the ColorBar to display the scale for the marker
Marker.MarkerBuilder	colorScale(Marker.Palette palette)	Sets the colorscale and only has an effect if `marker.color` is set to a numerical array.
Marker.MarkerBuilder	gradient(Gradient gradient)	Sets a gradient for the marker
Marker.MarkerBuilder	line(Line line)	Sets an outline around the marker
Marker.MarkerBuilder	opacity(double opacity)	Sets the opacity.
Marker.MarkerBuilder	reverseScale(boolean b)	Has an effect only if `marker.color` is set to a numerical array.
Marker.MarkerBuilder	showScale(boolean b)	Has an effect only if `marker.color` is set to a numerical array.
Marker.MarkerBuilder	size(double... size)
Marker.MarkerBuilder	size(tech.tablesaw.api.NumericColumn<?> size)
Marker.MarkerBuilder	sizeMode(Marker.SizeMode sizeMode)	Sets the size mode for the marker
Marker.MarkerBuilder	symbol(Symbol symbol)	Sets the symbol for the marker

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkerBuilder

public MarkerBuilder()

Method Detail

size

public Marker.MarkerBuilder size(double... size)

size

public Marker.MarkerBuilder size(tech.tablesaw.api.NumericColumn<?> size)

cAuto

public Marker.MarkerBuilder cAuto(boolean b)

Has an effect only if `marker.color` is set to a numerical array and `cmin`, `cmax` are also set. In this case, it controls whether the range of colors in `colorscale` is mapped to the range of values in the `color` array (`cauto: True`), or the `cmin`/`cmax` values (`cauto: False`).

Defaults to `False` when `cmin`, `cmax` are set by the user.

reverseScale

public Marker.MarkerBuilder reverseScale(boolean b)

Has an effect only if `marker.color` is set to a numerical array. Reverses the color mapping if True (`cmin` will correspond to the last color in the array and `cmax` will correspond to the first color).

line

public Marker.MarkerBuilder line(Line line)

Sets an outline around the marker

gradient

public Marker.MarkerBuilder gradient(Gradient gradient)

Sets a gradient for the marker

colorBar

public Marker.MarkerBuilder colorBar(ColorBar colorBar)

Sets the ColorBar to display the scale for the marker

autoColorScale

public Marker.MarkerBuilder autoColorScale(boolean b)

Has an effect only if `marker.color` is set to a numerical array. Determines whether the colorscale is a default palette (`autocolorscale: True`) or the palette determined by `marker.colorscale`. In case `colorscale` is unspecified or `autocolorscale` is True, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

Defaults to true

cMinAndMax

public Marker.MarkerBuilder cMinAndMax(double min,
                                       double max)

Has an effect only if `marker.color` is set to a numerical array. Sets the lower and upper bound of the color domain. Values should be associated to the `marker.color` array index

showScale

public Marker.MarkerBuilder showScale(boolean b)

Has an effect only if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.

colorScale

public Marker.MarkerBuilder colorScale(Marker.Palette palette)

Sets the colorscale and only has an effect if `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string.

At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`.

To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`.

opacity

public Marker.MarkerBuilder opacity(double opacity)

Sets the opacity. Value must be between 0 and 1 inclusive

color

public Marker.MarkerBuilder color(String color)

Sets the marker color to a single value

color

public Marker.MarkerBuilder color(String[] color)

Sets the marker color to an array of color values

color

public Marker.MarkerBuilder color(double[] color)

Sets the marker color to an array of numeric values for use when a color scale is provided

symbol

public Marker.MarkerBuilder symbol(Symbol symbol)

Sets the symbol for the marker

sizeMode

public Marker.MarkerBuilder sizeMode(Marker.SizeMode sizeMode)

Sets the size mode for the marker

Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels, either as area or the diameter

build

public Marker build()