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

Class TableViewportSubscription

java.lang.Object

io.deephaven.web.client.api.event.HasEventHandling

io.deephaven.web.client.api.subscription.AbstractTableSubscription

io.deephaven.web.client.api.subscription.TableViewportSubscription

@TsName(namespace="dh")
public class TableViewportSubscription
extends AbstractTableSubscription

This object serves as a "handle" to a subscription, allowing it to be acted on directly or canceled outright. If you retain an instance of this, you have two choices - either only use it to call `close()` on it to stop the table's viewport without creating a new one, or listen directly to this object instead of the table for data events, and always call `close()` when finished. Calling any method on this object other than close() will result in it continuing to live on after `setViewport` is called on the original table, or after the table is modified.

Nested Class Summary

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

AbstractTableSubscription.Status, AbstractTableSubscription.SubscriptionEventData, AbstractTableSubscription.SubscriptionRow, AbstractTableSubscription.UpdateEventData, AbstractTableSubscription.ViewportEventData

Nested classes/interfaces inherited from class io.deephaven.web.client.api.event.HasEventHandling

HasEventHandling.EventPair<T>

Field Summary

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

barrageSubscription, EVENT_UPDATED, rowStyleColumn, status, viewportRowSet

Fields inherited from class io.deephaven.web.client.api.event.HasEventHandling

INTERNAL_EVENT_RELEASED

Constructor Summary

Constructors

Constructor	Description
TableViewportSubscription(ClientTableState state, WorkerConnection connection, JsTable existingTable)

Method Summary

Modifier and Type	Method	Description
void	close()	Stops this viewport from running, stopping all events on itself and on the table that created it.
<T> void	fireEvent(Event<T> e)
void	fireEvent(String type)
<T> void	fireEvent(String type, T detail)
elemental2.promise.Promise<@TsTypeRef(ViewportData.class) AbstractTableSubscription.UpdateEventData>	getInternalViewportData()
elemental2.promise.Promise<@TsTypeRef(ViewportData.class) AbstractTableSubscription.UpdateEventData>	getViewportData()	Gets the data currently visible in this viewport
boolean	hasListeners(String name)
void	internalClose()	Internal API method to indicate that the Table itself has no further use for this.
static TableViewportSubscription	make(DataOptions.ViewportSubscriptionOptions options, JsTable jsTable)
protected void	notifyUpdate(RangeSet rowsAdded, RangeSet rowsRemoved, RangeSet totalMods, ShiftedRange[] shifted)
void	revive()	Creates the connection to the server.
protected void	sendFirstSubscriptionRequest()
void	setInternalViewport(DataOptions.ViewportSubscriptionOptions options)
void	setInternalViewport(RangeSet rows, Column[] columns, Double updateIntervalMs, Boolean isReverseViewport)
void	setViewport(double firstRow, double lastRow, @JsNullable Column[] columns, @JsNullable Double updateIntervalMs, @JsNullable Boolean isReverseViewport)	Deprecated. use update(Object) instead
elemental2.promise.Promise<TableData>	snapshot(JsRangeSet rows, Column[] columns)	Deprecated. Use JsTable.createSnapshot(Object) instead
void	update(@TsTypeRef(ViewportSubscriptionOptions.class) Object options)	Update the options for this viewport subscription.

Methods inherited from class io.deephaven.web.client.api.subscription.AbstractTableSubscription

connection, createPreview, getColumns, getPreviewListLengthLimit, hasValidSize, isClosed, isSubscriptionReady, makeColumnBitset, onStreamEnd, sendBarrageSubscriptionRequest, size, state, subscriptionRequest

Methods inherited from class io.deephaven.web.client.api.event.HasEventHandling

addEventListener, addEventListenerOneShot, addEventListenerOneShot, failureHandled, fireCriticalEvent, fireCriticalEvent, hasListener, isSuppress, logPrefix, nextEvent, removeEventListener, suppressEvents, unsuppressEvents

Methods inherited from class java.lang.Object

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

Constructor Details

TableViewportSubscription

public TableViewportSubscription(ClientTableState state,
 WorkerConnection connection,
 JsTable existingTable)

Method Details

make

public static TableViewportSubscription make(DataOptions.ViewportSubscriptionOptions options,
 JsTable jsTable)

revive

public void revive()

Description copied from class: AbstractTableSubscription

Creates the connection to the server. Used on initial connection, and for viewport reconnects.

Overrides:

revive in class AbstractTableSubscription

sendFirstSubscriptionRequest

protected void sendFirstSubscriptionRequest()

Specified by:

sendFirstSubscriptionRequest in class AbstractTableSubscription

notifyUpdate

protected void notifyUpdate(RangeSet rowsAdded,
 RangeSet rowsRemoved,
 RangeSet totalMods,
 ShiftedRange[] shifted)

Overrides:

notifyUpdate in class AbstractTableSubscription

fireEvent

public void fireEvent(String type)

Overrides:

fireEvent in class HasEventHandling

fireEvent

public <T> void fireEvent(String type,
 T detail)

Overrides:

fireEvent in class HasEventHandling

fireEvent

public <T> void fireEvent(Event<T> e)

Overrides:

fireEvent in class HasEventHandling

hasListeners

public boolean hasListeners(String name)

Overrides:

hasListeners in class HasEventHandling

setViewport

@JsMethod
public void setViewport(double firstRow,
 double lastRow,
 @JsOptional
 @JsNullable Column[] columns,
 @JsOptional
 @JsNullable Double updateIntervalMs,
 @JsOptional
 @JsNullable Boolean isReverseViewport)

Deprecated.

use update(Object) instead

Changes the rows and columns set on this viewport. This cannot be used to change the update interval.

Parameters:

firstRow -

lastRow -

columns -

updateIntervalMs -

update

@JsMethod
public void update(@TsTypeRef(ViewportSubscriptionOptions.class)
 @TsTypeRef(ViewportSubscriptionOptions.class) Object options)

Update the options for this viewport subscription. This cannot alter the update interval or preview options.

Parameters:

options - the subscription options

setInternalViewport

public void setInternalViewport(RangeSet rows,
 Column[] columns,
 Double updateIntervalMs,
 Boolean isReverseViewport)

setInternalViewport

public void setInternalViewport(DataOptions.ViewportSubscriptionOptions options)

close

@JsMethod
public void close()

Stops this viewport from running, stopping all events on itself and on the table that created it.

Overrides:

close in class AbstractTableSubscription

internalClose

public void internalClose()

Internal API method to indicate that the Table itself has no further use for this. The subscription should stop forwarding events and optionally close the underlying table/subscription.

getViewportData

@JsMethod
public elemental2.promise.Promise<@TsTypeRef(ViewportData.class) AbstractTableSubscription.UpdateEventData> getViewportData()

Gets the data currently visible in this viewport

Returns:

Promise of TableData.

getInternalViewportData

public elemental2.promise.Promise<@TsTypeRef(ViewportData.class) AbstractTableSubscription.UpdateEventData> getInternalViewportData()

snapshot

@JsMethod
@Deprecated
public elemental2.promise.Promise<TableData> snapshot(JsRangeSet rows,
 Column[] columns)

Deprecated.

Use JsTable.createSnapshot(Object) instead