Package io.deephaven.web.client.api.subscription

Class DataOptions

java.lang.Object

io.deephaven.web.client.api.subscription.DataOptions

Direct Known Subclasses:

DataOptions.SnapshotOptions, DataOptions.SubscriptionOptions

@TsInterface
@TsName(namespace="dh")
public class DataOptions
extends Object

Options for requesting table data, either as a snapshot or a subscription. See subtypes for more specific options:

• DataOptions.SnapshotOptions for snapshot-specific options
• DataOptions.SubscriptionOptions for full-table subscription-specific options
• DataOptions.ViewportSubscriptionOptions for viewport subscription-specific options

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataOptions.PreviewOptions	Options for requesting a preview of columns when requesting table data.
static interface	DataOptions.RangeSetUnion	Simple TS union that includes the rangeset and a simplified set that must contain exactly one range, with a start and end property that are both JS numbers.
static class	DataOptions.SimpleRange	Simple range consisting only of start and end numbers.
static class	DataOptions.SnapshotOptions	Options for requesting a snapshot of a table.
static class	DataOptions.SubscriptionOptions	Options for requesting a full-table subscription to a table.
static class	DataOptions.ViewportSubscriptionOptions	Options for requesting a viewport subscription to a table.

Field Summary

Fields

Modifier and Type	Field	Description
elemental2.core.JsArray<Column>	columns	Required property to indicate which columns should be included in the table data.
@JsNullable DataOptions.PreviewOptions	previewOptions	Optional preview instructions for columns in the table data.

Constructor Summary

Constructors

Constructor	Description
DataOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

previewOptions

@JsProperty
public @JsNullable DataOptions.PreviewOptions previewOptions

Optional preview instructions for columns in the table data.

columns

@JsProperty
public elemental2.core.JsArray<Column> columns

Required property to indicate which columns should be included in the table data.

Constructor Details

DataOptions

public DataOptions()