Package io.deephaven.multiviewwidget.builder.heatmap

Interface PivotHeatMapBuilder

All Superinterfaces:

Serializable

All Known Implementing Classes:

ByColumnHeatMapBuilder, ByRowHeatMapBuilder, ByTableHeatMapBuilder, ByValueHeatMapBuilder, DistinctValueHeatMapBuilder, MinMaxHeatMapBuilder

public interface PivotHeatMapBuilder
extends Serializable

A Builder to construct PivotHeatMap styles for pivotView tables. The method `createHeatMap(...)` provides the definition of the pivot, as well as a table of all pivot-values which the defined PivotHeatMap may choose to use or ignore during their construction. A number of static helper-methods are provided to simplify the construction of built-in heatmap types

Field Summary

Fields

Modifier and Type	Field	Description
static final List<Color>	defaultColors

Method Summary

Modifier and Type	Method	Description
static ByColumnHeatMapBuilder	byColumn()	Constructs a ByColumnHeatMapBuilder using default colors
static ByColumnHeatMapBuilder	byColumn(Color... colors)	Constructs a ByColumnHeatMapBuilder with an array defining colors
static ByColumnHeatMapBuilder	byColumn(List<Color> colors)	Constructs a ByColumnHeatMapBuilder with a list defining colors
static ByRowHeatMapBuilder	byRow()	Constructs a ByRowHeatMapBuilder using default colors
static ByRowHeatMapBuilder	byRow(Color... colors)	Constructs a ByRowHeatMapBuilder with an array defining colors
static ByRowHeatMapBuilder	byRow(List<Color> colors)	Constructs a ByRowHeatMapBuilder with a list defining colors
static ByTableHeatMapBuilder	byTable()	Constructs a ByTableHeatMapBuilder using default colors
static ByTableHeatMapBuilder	byTable(Color... colors)	Constructs a ByTableHeatMapBuilder with an array defining colors
static ByTableHeatMapBuilder	byTable(List<Color> colors)	Constructs a ByTableHeatMapBuilder with a list defining colors
static ByValueHeatMapBuilder	byValues(List<Color> colors, List<Object> values)	Constructs a ByValueHeatMapBuilder with parallel lists defining object to color values
static ByValueHeatMapBuilder	byValues(Map<Object,Color> map)	Constructs a ByValueHeatMapBuilder using a map to define value to color
PivotHeatMap<?>	createHeatMap(Table valuesTable, PivotTableState state)	Converts a PivotHeatMapBuilder instance into a PivotHeatMap instance
static DistinctValueHeatMapBuilder	distinctValues()	Constructs a DistinctValueHeatMapBuilder, which will identify distinct values using a DBColorUtilImpl.DistinctFormatter
static DistinctValueHeatMapBuilder	distinctValues(Color... colors)	Constructs a DistinctValueHeatMapBuilder with an array of colors
static DistinctValueHeatMapBuilder	distinctValues(List<Color> colors)	Constructs a DistinctValueHeatMapBuilder with a list of colors

Field Details

defaultColors

static final List<Color> defaultColors

Method Details

byTable

@ScriptApi
static ByTableHeatMapBuilder byTable(List<Color> colors)

Constructs a ByTableHeatMapBuilder with a list defining colors

Parameters:

colors - a list of colors defining the desired progression from min-color to max-color, including any number of intermediary steps

Returns:

a new ByTableHeatMapBuilder instance

byTable

@ScriptApi
static ByTableHeatMapBuilder byTable(Color... colors)

Constructs a ByTableHeatMapBuilder with an array defining colors

Parameters:

colors - an array of colors defining the desired progression from min-color to max-color, including any number of intermediary steps

Returns:

a new ByTableHeatMapBuilder instance

byTable

@ScriptApi
static ByTableHeatMapBuilder byTable()

Constructs a ByTableHeatMapBuilder using default colors

Returns:

a new ByTableHeatMapBuilder instance

byRow

@ScriptApi
static ByRowHeatMapBuilder byRow(List<Color> colors)

Constructs a ByRowHeatMapBuilder with a list defining colors

Parameters:

colors - a list of colors defining the desired progression from min-color to max-color, including any number of intermediary steps

Returns:

a new ByRowHeatMapBuilder instance

byRow

@ScriptApi
static ByRowHeatMapBuilder byRow(Color... colors)

Constructs a ByRowHeatMapBuilder with an array defining colors

Parameters:

colors - an array of colors defining the desired progression from min-color to max-color, including any number of intermediary steps

Returns:

a new ByRowHeatMapBuilder instance

byRow

@ScriptApi
static ByRowHeatMapBuilder byRow()

Constructs a ByRowHeatMapBuilder using default colors

Returns:

a new ByRowHeatMapBuilder instance

byColumn

@ScriptApi
static ByColumnHeatMapBuilder byColumn(List<Color> colors)

Constructs a ByColumnHeatMapBuilder with a list defining colors

Parameters:

colors - a list of colors defining the desired progression from min-color to max-color, including any number of intermediary steps

Returns:

a new ByColumnHeatMapBuilder instance

byColumn

@ScriptApi
static ByColumnHeatMapBuilder byColumn(Color... colors)

Constructs a ByColumnHeatMapBuilder with an array defining colors

Parameters:

colors - an array of colors defining the desired progression from min-color to max-color, including any number of intermediary steps

Returns:

a new ByColumnHeatMapBuilder instance

byColumn

@ScriptApi
static ByColumnHeatMapBuilder byColumn()

Constructs a ByColumnHeatMapBuilder using default colors

Returns:

a new ByColumnHeatMapBuilder instance

byValues

@ScriptApi
static ByValueHeatMapBuilder byValues(List<Color> colors,
 List<Object> values)

Constructs a ByValueHeatMapBuilder with parallel lists defining object to color values

Parameters:

colors - a list of colors to use with corresponding values

values - a list of values to use with corresponding colors

Returns:

a new ByValueHeatMapBuilder instance

byValues

@ScriptApi
static ByValueHeatMapBuilder byValues(Map<Object,Color> map)

Constructs a ByValueHeatMapBuilder using a map to define value to color

Parameters:

map - a map of corresponding value to color definitions

Returns:

a new ByValueHeatMapBuilder instance

distinctValues

@ScriptApi
static DistinctValueHeatMapBuilder distinctValues(List<Color> colors)

Constructs a DistinctValueHeatMapBuilder with a list of colors

Parameters:

colors - a list of colors used to identify distinct values

Returns:

a new DistinctValueHeatMapBuilder instance

distinctValues

@ScriptApi
static DistinctValueHeatMapBuilder distinctValues(Color... colors)

Constructs a DistinctValueHeatMapBuilder with an array of colors

Parameters:

colors - an array of colors used to identify distinct values

Returns:

a new DistinctValueHeatMapBuilder instance

distinctValues

@ScriptApi
static DistinctValueHeatMapBuilder distinctValues()

Constructs a DistinctValueHeatMapBuilder, which will identify distinct values using a DBColorUtilImpl.DistinctFormatter

createHeatMap

PivotHeatMap<?> createHeatMap(Table valuesTable,
 PivotTableState state)

Converts a PivotHeatMapBuilder instance into a PivotHeatMap instance

Parameters:

valuesTable - a live table of all pivot-row/pivot-column values, and the corresponding pivot-cell at their intersection

state - the definition of the pivotWidget which this heatmap will be used against

Returns:

a new PivotHeatMap instance