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

Class DataOptions.SubscriptionOptions

java.lang.Object

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

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

Direct Known Subclasses:

DataOptions.ViewportSubscriptionOptions

Enclosing class:

DataOptions

@TsInterface
@TsName(namespace="dh")
public static class DataOptions.SubscriptionOptions
extends DataOptions

Options for requesting a full-table subscription to a table.

Nested Class Summary

Nested classes/interfaces inherited from class io.deephaven.web.client.api.subscription.DataOptions

DataOptions.PreviewOptions, DataOptions.RangeSetUnion, DataOptions.SimpleRange, DataOptions.SnapshotOptions, DataOptions.SubscriptionOptions, DataOptions.ViewportSubscriptionOptions

Field Summary

Fields

Modifier and Type	Field	Description
@JsNullable Double	updateIntervalMs	Minimum interval between updates, in milliseconds.

Fields inherited from class io.deephaven.web.client.api.subscription.DataOptions

columns, previewOptions

Constructor Summary

Constructors

Constructor	Description
SubscriptionOptions()

Method Summary

Modifier and Type	Method	Description
static DataOptions.SubscriptionOptions	of(Object obj)	Creates a deep copy of the object as the expected Java type.

Methods inherited from class java.lang.Object

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

Field Details

updateIntervalMs

@JsProperty
public @JsNullable Double updateIntervalMs

Minimum interval between updates, in milliseconds. If not specified, the server default will be used, typically 1000ms.

Note that setting this to smaller values will not necessarily result in more frequent updates - the server may not propagate updates that frequently, or there may be no updates to propagate.

Constructor Details

SubscriptionOptions

public SubscriptionOptions()

Method Details

of

@JsIgnore
public static DataOptions.SubscriptionOptions of(Object obj)

Creates a deep copy of the object as the expected Java type.