Package io.deephaven.web.client.api.widget.plot

Class OneClick

java.lang.Object

io.deephaven.web.client.api.widget.plot.OneClick

@TsInterface
@TsName(namespace="dh.plot")
public class OneClick
extends Object

A one-click configuration for a chart series.

A OneClick can be used to select values for one or more columns, and uses those values to select one or more constituent tables from a JsPartitionedTable.

Constructor Summary

Constructors

Constructor	Description
OneClick(JsFigure jsFigure, FigureDescriptor.OneClickDescriptor oneClick, JsSeries jsSeries)

Method Summary

Modifier and Type	Method	Description
boolean	allRequiredValuesSet()
boolean	allValuesSet()
Column[]	getColumns()	The columns that can be used to select a constituent table.
FigureDescriptor.OneClickDescriptor	getDescriptor()
JsTable	getTable()
jsinterop.base.Any	getValueForColumn(String columnName)	Gets the currently selected value for columnName.
boolean	isRequireAllFiltersToDisplay()	Whether all column values must be set before a table is selected.
void	setPartitionedTable(JsPartitionedTable partitionedTable)
void	setValueForColumn(String columnName, jsinterop.base.Any value)	Sets the selected value for columnName.

Methods inherited from class java.lang.Object

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

Constructor Details

OneClick

public OneClick(JsFigure jsFigure,
 FigureDescriptor.OneClickDescriptor oneClick,
 JsSeries jsSeries)

Method Details

setPartitionedTable

public void setPartitionedTable(JsPartitionedTable partitionedTable)

getColumns

@JsProperty
public Column[] getColumns()

The columns that can be used to select a constituent table.

setValueForColumn

@JsMethod
public void setValueForColumn(String columnName,
 jsinterop.base.Any value)

Sets the selected value for columnName.

Passing null clears the selected value for the column.

Parameters:

columnName - the column name to set a value for

value - the selected value, or null to clear

getTable

public JsTable getTable()

getValueForColumn

@JsMethod
public jsinterop.base.Any getValueForColumn(String columnName)

Gets the currently selected value for columnName.

Parameters:

columnName - the column name

Returns:

the selected value, or null if no value has been set

allValuesSet

public boolean allValuesSet()

allRequiredValuesSet

public boolean allRequiredValuesSet()

isRequireAllFiltersToDisplay

@JsProperty
public boolean isRequireAllFiltersToDisplay()

Whether all column values must be set before a table is selected.

getDescriptor

public FigureDescriptor.OneClickDescriptor getDescriptor()