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

Class DataUpdateEvent

java.lang.Object

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

@TsInterface
@TsName(name="FigureDataUpdatedEvent",
        namespace="dh.plot")
public class DataUpdateEvent
extends Object

Event detail for a figure data update.

Provides access to the updated data for one or more related series.

Constructor Summary

Constructors

Constructor	Description
DataUpdateEvent(JsSeries[] relatedSeries, ChartData data, TableData currentUpdate)

Method Summary

Modifier and Type	Method	Description
static final DataUpdateEvent	empty(JsSeries... series)
elemental2.core.JsArray<jsinterop.base.Any>	getArray(JsSeries series, int sourceType)	Gets a contiguous JS array of values for the given series and data source type.
elemental2.core.JsArray<jsinterop.base.Any>	getArray(JsSeries series, int sourceType, @JsNullable JsFunction<jsinterop.base.Any,jsinterop.base.Any> mappingFunc)	Gets a contiguous JS array of values for the given series and data source type.
JsSeries[]	getSeries()	The series related to this update.

Methods inherited from class java.lang.Object

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

Constructor Details

DataUpdateEvent

public DataUpdateEvent(JsSeries[] relatedSeries,
 ChartData data,
 TableData currentUpdate)

Method Details

empty

public static final DataUpdateEvent empty(JsSeries... series)

getSeries

@JsProperty
public JsSeries[] getSeries()

The series related to this update.

getArray

public elemental2.core.JsArray<jsinterop.base.Any> getArray(JsSeries series,
 int sourceType)

Gets a contiguous JS array of values for the given series and data source type.

getArray

@JsMethod
public elemental2.core.JsArray<jsinterop.base.Any> getArray(JsSeries series,
 int sourceType,
 @JsOptional
 @JsNullable JsFunction<jsinterop.base.Any,jsinterop.base.Any> mappingFunc)

Gets a contiguous JS array of values for the given series and data source type.

If provided, mappingFunc is applied to each value. To re-use cached data across calls, use the same mappingFunc instance each time.

Parameters:

series - the series to read data for

sourceType - the data source type, as defined by the series descriptor

mappingFunc - an optional mapping function applied to each value; null returns the raw values

Returns:

a contiguous JS array of values