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

Class Downsample

java.lang.Object

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

@JsType(namespace="dh.plot")
public class Downsample
extends Object

Helper class for plot downsampling methods.

Method Summary

Modifier and Type	Method	Description
static elemental2.promise.Promise<JsTable>	runChartDownsample(JsTable table, String xCol, String[] yCols, int width, @JsNullable LongWrapper[] xRange)	Downsamples a table so that the data can be used for a time-series line plot.

Methods inherited from class java.lang.Object

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

Method Details

runChartDownsample

public static elemental2.promise.Promise<JsTable> runChartDownsample(JsTable table,
 String xCol,
 String[] yCols,
 int width,
 @JsOptional
 @JsNullable LongWrapper[] xRange)

Downsamples a table so that the data can be used for a time-series line plot. The downsampled table should have the same visual fidelity as the original table, but with fewer rows.

Parameters:

table - The table to downsample.

xCol - The name of the X column to downsample. Must be an Instant or long.

yCols - The names of the Y columns to downsample.

width - The width of the visible area in pixels.

xRange - The visible range as `[start, end]` or null to always use all data.

Returns:

A promise that resolves to the downsampled table.