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

Class DataOptions.PreviewOptions

java.lang.Object

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

Enclosing class:

DataOptions

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

Options for requesting a preview of columns when requesting table data. The two properties convertArrayToString and array are mutually exclusive.

Field Summary

Fields

Modifier and Type	Field	Description
@JsNullable Double	array	Specifies the length of the array to serialize.
@JsNullable Boolean	convertArrayToString	If true, any array columns will be converted to strings for preview purposes.

Constructor Summary

Constructors

Constructor	Description
PreviewOptions()

Method Summary

Modifier and Type	Method	Description
static DataOptions.PreviewOptions	of(jsinterop.base.JsPropertyMap<Object> previewOptions)	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

convertArrayToString

@JsProperty
public @JsNullable Boolean convertArrayToString

If true, any array columns will be converted to strings for preview purposes. This is the legacy behavior.

array

@JsProperty
public @JsNullable Double array

Specifies the length of the array to serialize. If the array is longer than this length, one extra element will be included - the client is expected to truncate the array and append "..." to indicate that there are additional elements. Negative values indicate that the values should be counted from the end of the array rather than the beginning. Zero or null indicate that the entire array should be serialized. The default is null.

Constructor Details

PreviewOptions

public PreviewOptions()

Method Details

of

@JsIgnore
public static DataOptions.PreviewOptions of(jsinterop.base.JsPropertyMap<Object> previewOptions)

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