Interface ViewportSubscriptionOptions

Options for requesting a viewport subscription to a table.

Hierarchy

Properties

columns: Column[]

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

isReverseViewport?: boolean

If true, the viewport will be filled starting from the end of the table, where 0 is the last row of the table. Default is false.

previewOptions?: PreviewOptions

Optional preview instructions for columns in the table data.

The rows to include in the viewport. This can be either a RangeSet or a single range with first and last properties.

updateIntervalMs?: number

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.