@deephaven/jsapi-types 1.0.0-dev0.37.0 → 1.0.0-dev0.37.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1970 -1901
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
// Minimum TypeScript Version: 4.3
|
|
2
2
|
// Generated using com.vertispan.tsdefs.doclet.TsDoclet
|
|
3
3
|
|
|
4
|
+
export interface IIterableResult<T> {
|
|
5
|
+
value:T;
|
|
6
|
+
done:boolean;
|
|
7
|
+
}
|
|
4
8
|
/**
|
|
5
9
|
* This is part of EcmaScript 2015, documented here for completeness. It supports a single method, <b>next()</b>, which
|
|
6
10
|
* returns an object with a <b>boolean</b> named <b>done</b> (true if there are no more items to return; false
|
|
@@ -11,12 +15,24 @@ export interface Iterator<T> {
|
|
|
11
15
|
hasNext():boolean;
|
|
12
16
|
next():IIterableResult<T>;
|
|
13
17
|
}
|
|
14
|
-
export interface IIterableResult<T> {
|
|
15
|
-
value:T;
|
|
16
|
-
done:boolean;
|
|
17
|
-
}
|
|
18
18
|
export namespace dh.storage {
|
|
19
19
|
|
|
20
|
+
/**
|
|
21
|
+
* Represents a file's contents loaded from the server. If an etag was specified when loading, client should first test
|
|
22
|
+
* if the etag of this instance matches - if so, the contents will be empty, and the client's existing contents should
|
|
23
|
+
* be used.
|
|
24
|
+
*/
|
|
25
|
+
export class FileContents {
|
|
26
|
+
protected constructor();
|
|
27
|
+
|
|
28
|
+
static blob(blob:Blob):FileContents;
|
|
29
|
+
static text(...text:string[]):FileContents;
|
|
30
|
+
static arrayBuffers(...buffers:ArrayBuffer[]):FileContents;
|
|
31
|
+
text():Promise<string>;
|
|
32
|
+
arrayBuffer():Promise<ArrayBuffer>;
|
|
33
|
+
get etag():string;
|
|
34
|
+
}
|
|
35
|
+
|
|
20
36
|
/**
|
|
21
37
|
* Remote service to read and write files on the server. Paths use "/" as a separator, and should not start with "/".
|
|
22
38
|
*/
|
|
@@ -75,22 +91,6 @@ export namespace dh.storage {
|
|
|
75
91
|
createDirectory(path:string):Promise<void>;
|
|
76
92
|
}
|
|
77
93
|
|
|
78
|
-
/**
|
|
79
|
-
* Represents a file's contents loaded from the server. If an etag was specified when loading, client should first test
|
|
80
|
-
* if the etag of this instance matches - if so, the contents will be empty, and the client's existing contents should
|
|
81
|
-
* be used.
|
|
82
|
-
*/
|
|
83
|
-
export class FileContents {
|
|
84
|
-
protected constructor();
|
|
85
|
-
|
|
86
|
-
static blob(blob:Blob):FileContents;
|
|
87
|
-
static text(...text:string[]):FileContents;
|
|
88
|
-
static arrayBuffers(...buffers:ArrayBuffer[]):FileContents;
|
|
89
|
-
text():Promise<string>;
|
|
90
|
-
arrayBuffer():Promise<ArrayBuffer>;
|
|
91
|
-
get etag():string;
|
|
92
|
-
}
|
|
93
|
-
|
|
94
94
|
/**
|
|
95
95
|
* Storage service metadata about files and folders.
|
|
96
96
|
*/
|
|
@@ -117,15 +117,6 @@ export namespace dh.storage {
|
|
|
117
117
|
|
|
118
118
|
export namespace dh {
|
|
119
119
|
|
|
120
|
-
/**
|
|
121
|
-
* This object may be pooled internally or discarded and not updated. Do not retain references to it. Instead,
|
|
122
|
-
* request the viewport again.
|
|
123
|
-
*/
|
|
124
|
-
export interface ViewportRow extends Row {
|
|
125
|
-
get(column:Column):any;
|
|
126
|
-
getFormat(column:Column):Format;
|
|
127
|
-
get index():LongWrapper;
|
|
128
|
-
}
|
|
129
120
|
export interface HasEventHandling {
|
|
130
121
|
/**
|
|
131
122
|
* Listen for events on this object.
|
|
@@ -146,11 +137,6 @@ export namespace dh {
|
|
|
146
137
|
*/
|
|
147
138
|
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
148
139
|
}
|
|
149
|
-
export interface ColumnGroup {
|
|
150
|
-
get name():string|null;
|
|
151
|
-
get children():string[]|null;
|
|
152
|
-
get color():string|null;
|
|
153
|
-
}
|
|
154
140
|
/**
|
|
155
141
|
* Row implementation that also provides additional read-only properties. represents visible rows in the table, but
|
|
156
142
|
* with additional properties to reflect the tree structure.
|
|
@@ -178,34 +164,199 @@ export namespace dh {
|
|
|
178
164
|
get hasChildren():boolean;
|
|
179
165
|
get index():LongWrapper;
|
|
180
166
|
}
|
|
167
|
+
/**
|
|
168
|
+
* Extends {@link dh.TableData}, but only contains data in the current viewport. The only API change from TableData is that
|
|
169
|
+
* ViewportData also contains the offset to this data, so that the actual row number may be determined.
|
|
170
|
+
* <p>
|
|
171
|
+
* For viewport subscriptions, it is not necessary to read with the key, only with the position.
|
|
172
|
+
* <p>
|
|
173
|
+
* Do not assume that the first row in `rows` is the first visible row, because extra rows may be provided for easier
|
|
174
|
+
* scrolling without going to the server.
|
|
175
|
+
*/
|
|
176
|
+
export interface ViewportData extends TableData {
|
|
177
|
+
/**
|
|
178
|
+
* Reads a row object from the viewport, based on its position in the table.
|
|
179
|
+
*/
|
|
180
|
+
get(index:LongWrapper|number):ViewportRow;
|
|
181
|
+
getData(index:LongWrapper|number, column:Column):any;
|
|
182
|
+
getFormat(index:LongWrapper|number, column:Column):Format;
|
|
183
|
+
/**
|
|
184
|
+
* The position of the first returned row, null if this data is not for a viewport.
|
|
185
|
+
*/
|
|
186
|
+
get offset():number;
|
|
187
|
+
get columns():Array<Column>;
|
|
188
|
+
get rows():Array<ViewportRow>;
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* Wrap LocalTime values for use in JS. Provides text formatting for display and access to the underlying value.
|
|
192
|
+
*/
|
|
193
|
+
export interface LocalTimeWrapper {
|
|
194
|
+
valueOf():string;
|
|
195
|
+
getHour():number;
|
|
196
|
+
getMinute():number;
|
|
197
|
+
getSecond():number;
|
|
198
|
+
getNano():number;
|
|
199
|
+
toString():string;
|
|
200
|
+
}
|
|
201
|
+
export interface LayoutHints {
|
|
202
|
+
readonly searchDisplayMode?:SearchDisplayModeType|null;
|
|
203
|
+
|
|
204
|
+
get hiddenColumns():string[]|null;
|
|
205
|
+
get frozenColumns():string[]|null;
|
|
206
|
+
get columnGroups():ColumnGroup[]|null;
|
|
207
|
+
get areSavedLayoutsAllowed():boolean;
|
|
208
|
+
get frontColumns():string[]|null;
|
|
209
|
+
get backColumns():string[]|null;
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* Represents a table which can be joined to another table. Current implementations are {@link dh.Table} and
|
|
213
|
+
* {@link dh.TotalsTable}.
|
|
214
|
+
*/
|
|
215
|
+
export interface JoinableTable {
|
|
216
|
+
freeze():Promise<Table>;
|
|
217
|
+
snapshot(baseTable:Table, doInitialSnapshot?:boolean, stampColumns?:string[]):Promise<Table>;
|
|
218
|
+
/**
|
|
219
|
+
* Joins this table to the provided table, using one of the specified join types:
|
|
220
|
+
* <ul>
|
|
221
|
+
* <li><code>AJ</code>, <code>ReverseAJ</code> (or <code>RAJ</code>) - inexact timeseries joins, based on the
|
|
222
|
+
* provided matching rule.</li>
|
|
223
|
+
* <li><code>CROSS_JOIN</code> (or <code>Join</code>) - cross join of all rows that have matching values in both
|
|
224
|
+
* tables.</li>
|
|
225
|
+
* <li><code>EXACT_JOIN</code> (or <code>ExactJoin</code> - matches values in exactly one row in the right table,
|
|
226
|
+
* with errors if there is not exactly one.</li>
|
|
227
|
+
* <li><code>NATURAL_JOIN</code> (or <code>Natural</code> - matches values in at most one row in the right table,
|
|
228
|
+
* with nulls if there is no match or errors if there are multiple matches.</li>
|
|
229
|
+
* </ul>
|
|
230
|
+
*
|
|
231
|
+
* Note that <code>Left</code> join is not supported here, unlike DHE.
|
|
232
|
+
* <p>
|
|
233
|
+
* See the <a href="https://deephaven.io/core/docs/conceptual/choose-joins/">Choose a join method</a> document for
|
|
234
|
+
* more guidance on picking a join operation.
|
|
235
|
+
* @deprecated Instead, call the specific method for the join type.
|
|
236
|
+
* @param joinType - The type of join to perform, see the list above.
|
|
237
|
+
* @param rightTable - The table to match to values in this table
|
|
238
|
+
* @param columnsToMatch - Columns that should match
|
|
239
|
+
* @param columnsToAdd - Columns from the right table to add to the result - empty/null/absent to add all columns
|
|
240
|
+
* @param asOfMatchRule - If joinType is AJ/RAJ/ReverseAJ, the match rule to use
|
|
241
|
+
* @return a promise that will resolve to the joined table
|
|
242
|
+
*/
|
|
243
|
+
join(joinType:string, rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>|undefined|null, asOfMatchRule?:string|undefined|null):Promise<Table>;
|
|
244
|
+
/**
|
|
245
|
+
* Performs an inexact timeseries join, where rows in this table will have columns added from the closest matching
|
|
246
|
+
* row from the right table.
|
|
247
|
+
* <p>
|
|
248
|
+
* The `asOfMatchRule` value can be one of:
|
|
249
|
+
* <ul>
|
|
250
|
+
* <li>LESS_THAN_EQUAL</li>
|
|
251
|
+
* <li>LESS_THAN</li>
|
|
252
|
+
* <li>GREATER_THAN_EQUAL</li>
|
|
253
|
+
* <li>GREATER_THAN</li>
|
|
254
|
+
* </ul>
|
|
255
|
+
* @param rightTable - the table to match to values in this table
|
|
256
|
+
* @param columnsToMatch - the columns that should match, according to the asOfMatchRole
|
|
257
|
+
* @param columnsToAdd - columns from the right table to add to the resulting table, empty/null/absent to add all
|
|
258
|
+
* columns
|
|
259
|
+
* @param asOfMatchRule - the match rule to use, see above
|
|
260
|
+
* @return a promise that will resolve to the joined table
|
|
261
|
+
*/
|
|
262
|
+
asOfJoin(rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>|undefined|null, asOfMatchRule?:string|undefined|null):Promise<Table>;
|
|
263
|
+
/**
|
|
264
|
+
* a promise that will be resolved with the newly created table holding the results of the specified cross join
|
|
265
|
+
* operation. The <b>columnsToAdd</b> parameter is optional, not specifying it will result in all columns from the
|
|
266
|
+
* right table being added to the output. The <b>reserveBits</b> optional parameter lets the client control how the
|
|
267
|
+
* key space is distributed between the rows in the two tables, see the Java <b>Table</b> class for details.
|
|
268
|
+
* @param rightTable - the table to match to values in this table
|
|
269
|
+
* @param columnsToMatch - the columns that should match exactly
|
|
270
|
+
* @param columnsToAdd - columns from the right table to add to the resulting table, empty/null/absent to add all
|
|
271
|
+
* columns
|
|
272
|
+
* @param reserveBits - the number of bits of key-space to initially reserve per group, null/absent will let the
|
|
273
|
+
* server select a value
|
|
274
|
+
* @return a promise that will resolve to the joined table
|
|
275
|
+
*/
|
|
276
|
+
crossJoin(rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>|undefined|null, reserveBits?:number|undefined|null):Promise<Table>;
|
|
277
|
+
/**
|
|
278
|
+
* a promise that will be resolved with the newly created table holding the results of the specified exact join
|
|
279
|
+
* operation. The `columnsToAdd` parameter is optional, not specifying it will result in all columns from the right
|
|
280
|
+
* table being added to the output.
|
|
281
|
+
* @param rightTable - the table to match to values in this table
|
|
282
|
+
* @param columnsToMatch - the columns that should match exactly
|
|
283
|
+
* @param columnsToAdd - columns from the right table to add to the resulting table, empty/null/absent to add all
|
|
284
|
+
* columns
|
|
285
|
+
* @return a promise that will resolve to the joined table
|
|
286
|
+
*/
|
|
287
|
+
exactJoin(rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>|undefined|null):Promise<Table>;
|
|
288
|
+
/**
|
|
289
|
+
* a promise that will be resolved with the newly created table holding the results of the specified natural join
|
|
290
|
+
* operation. The <b>columnsToAdd</b> parameter is optional, not specifying it will result in all columns from the
|
|
291
|
+
* right table being added to the output.
|
|
292
|
+
* @param rightTable - the table to match to values in this table
|
|
293
|
+
* @param columnsToMatch - the columns that should match exactly
|
|
294
|
+
* @param columnsToAdd - columns from the right table to add to the resulting table, empty/null/absent to add all
|
|
295
|
+
* columns
|
|
296
|
+
* @return a promise that will resolve to the joined table
|
|
297
|
+
*/
|
|
298
|
+
naturalJoin(rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>|undefined|null):Promise<Table>;
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* This object may be pooled internally or discarded and not updated. Do not retain references to it. Instead,
|
|
302
|
+
* request the viewport again.
|
|
303
|
+
*/
|
|
304
|
+
export interface ViewportRow extends Row {
|
|
305
|
+
get(column:Column):any;
|
|
306
|
+
getFormat(column:Column):Format;
|
|
307
|
+
get index():LongWrapper;
|
|
308
|
+
}
|
|
309
|
+
export interface TreeViewportData extends TableData {
|
|
310
|
+
get(index:LongWrapper|number):TreeRow;
|
|
311
|
+
getData(index:LongWrapper|number, column:Column):any;
|
|
312
|
+
getFormat(index:LongWrapper|number, column:Column):Format;
|
|
313
|
+
get treeSize():number;
|
|
314
|
+
get columns():Array<Column>;
|
|
315
|
+
get rows():Array<TreeRow>;
|
|
316
|
+
}
|
|
181
317
|
export interface RefreshToken {
|
|
182
318
|
get bytes():string;
|
|
183
319
|
get expiry():number;
|
|
184
320
|
}
|
|
185
321
|
/**
|
|
186
|
-
*
|
|
322
|
+
* Common interface for various ways of accessing table data and formatting for viewport or non-viewport subscriptions
|
|
323
|
+
* on tables, data in trees, and snapshots.
|
|
324
|
+
* <p>
|
|
325
|
+
* Generally speaking, it is more efficient to access data in column-major order, rather than iterating through each Row
|
|
326
|
+
* and accessing all columns that it holds. The {@link rows} accessor can be useful to read row data, but may
|
|
327
|
+
* incur other costs - it is likely faster to access data by columns using {@link getData}.
|
|
187
328
|
*/
|
|
188
|
-
export interface
|
|
329
|
+
export interface TableData {
|
|
189
330
|
/**
|
|
190
|
-
*
|
|
191
|
-
* @
|
|
331
|
+
* Reads a row object from the table, from which any subscribed column can be read.
|
|
332
|
+
* @param index - the position or key to access
|
|
333
|
+
* @return the row at the given location
|
|
192
334
|
*/
|
|
193
|
-
|
|
335
|
+
get(index:LongWrapper|number):Row;
|
|
194
336
|
/**
|
|
195
|
-
*
|
|
196
|
-
* @
|
|
337
|
+
* Reads a specific cell from the table, by row key and column.
|
|
338
|
+
* @param index - the row in the table to get data from
|
|
339
|
+
* @param column - the column to read
|
|
340
|
+
* @return the value in the table
|
|
197
341
|
*/
|
|
198
|
-
|
|
342
|
+
getData(index:LongWrapper|number, column:Column):any;
|
|
199
343
|
/**
|
|
200
|
-
*
|
|
201
|
-
* @
|
|
344
|
+
* The server-specified Format to use for the cell at the given position.
|
|
345
|
+
* @param index - the row to read
|
|
346
|
+
* @param column - the column to read
|
|
347
|
+
* @return a Format instance with any server-specified details
|
|
202
348
|
*/
|
|
203
|
-
|
|
349
|
+
getFormat(index:LongWrapper|number, column:Column):Format;
|
|
350
|
+
get columns():Array<Column>;
|
|
204
351
|
/**
|
|
205
|
-
*
|
|
206
|
-
* @deprecated Prefer formatString. Number format string to apply to the value in this cell.
|
|
352
|
+
* A lazily computed array of all rows available on the client.
|
|
207
353
|
*/
|
|
208
|
-
|
|
354
|
+
get rows():Array<Row>;
|
|
355
|
+
}
|
|
356
|
+
export interface ColumnGroup {
|
|
357
|
+
get name():string|null;
|
|
358
|
+
get children():string[]|null;
|
|
359
|
+
get color():string|null;
|
|
209
360
|
}
|
|
210
361
|
/**
|
|
211
362
|
* Represents a server-side object that may not yet have been fetched by the client. When this object will no longer be
|
|
@@ -239,16 +390,97 @@ export namespace dh {
|
|
|
239
390
|
*/
|
|
240
391
|
close():void;
|
|
241
392
|
}
|
|
242
|
-
export interface WorkerHeapInfo {
|
|
243
|
-
/**
|
|
244
|
-
* Total heap size available for this worker.
|
|
245
|
-
*/
|
|
246
|
-
get totalHeapSize():number;
|
|
247
|
-
get freeMemory():number;
|
|
248
|
-
get maximumHeapSize():number;
|
|
249
|
-
}
|
|
250
393
|
/**
|
|
251
|
-
*
|
|
394
|
+
* Represents the contents of a single widget data message from the server, with a binary data paylod and exported
|
|
395
|
+
* objects. Implemented both by Widget itself and by the `event.details` when data is received by the client.
|
|
396
|
+
*
|
|
397
|
+
* Terminology note: the name of this type should probably use "Data" instead of "Message", and the methods should use
|
|
398
|
+
* "payload" rather than "data" to match other platforms and the protobuf itself. These names are instead used for
|
|
399
|
+
* backwards compatibility and to better follow JS expectations.
|
|
400
|
+
*/
|
|
401
|
+
export interface WidgetMessageDetails {
|
|
402
|
+
/**
|
|
403
|
+
* Returns the data from this message as a base64-encoded string.
|
|
404
|
+
*/
|
|
405
|
+
getDataAsBase64():string;
|
|
406
|
+
/**
|
|
407
|
+
* Returns the data from this message as a Uint8Array.
|
|
408
|
+
*/
|
|
409
|
+
getDataAsU8():Uint8Array;
|
|
410
|
+
/**
|
|
411
|
+
* Returns the data from this message as a utf-8 string.
|
|
412
|
+
*/
|
|
413
|
+
getDataAsString():string;
|
|
414
|
+
/**
|
|
415
|
+
* Returns an array of exported objects sent from the server. The plugin implementation is now responsible for these
|
|
416
|
+
* objects, and should close them when no longer needed.
|
|
417
|
+
*/
|
|
418
|
+
get exportedObjects():WidgetExportedObject[];
|
|
419
|
+
}
|
|
420
|
+
/**
|
|
421
|
+
* Wrap LocalDate values for use in JS. Provides text formatting for display and access to the underlying value.
|
|
422
|
+
*/
|
|
423
|
+
export interface LocalDateWrapper {
|
|
424
|
+
valueOf():string;
|
|
425
|
+
getYear():number;
|
|
426
|
+
getMonthValue():number;
|
|
427
|
+
getDayOfMonth():number;
|
|
428
|
+
toString():string;
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* This object may be pooled internally or discarded and not updated. Do not retain references to it.
|
|
432
|
+
*/
|
|
433
|
+
export interface Format {
|
|
434
|
+
/**
|
|
435
|
+
* The format string to apply to the value of this cell.
|
|
436
|
+
* @return String
|
|
437
|
+
*/
|
|
438
|
+
readonly formatString?:string|null;
|
|
439
|
+
/**
|
|
440
|
+
* Color to apply to the cell's background, in <b>#rrggbb</b> format.
|
|
441
|
+
* @return String
|
|
442
|
+
*/
|
|
443
|
+
readonly backgroundColor?:string|null;
|
|
444
|
+
/**
|
|
445
|
+
* Color to apply to the text, in <b>#rrggbb</b> format.
|
|
446
|
+
* @return String
|
|
447
|
+
*/
|
|
448
|
+
readonly color?:string|null;
|
|
449
|
+
/**
|
|
450
|
+
*
|
|
451
|
+
* @deprecated Prefer formatString. Number format string to apply to the value in this cell.
|
|
452
|
+
*/
|
|
453
|
+
readonly numberFormat?:string|null;
|
|
454
|
+
}
|
|
455
|
+
/**
|
|
456
|
+
* Represents statistics for a given table column.
|
|
457
|
+
*/
|
|
458
|
+
export interface ColumnStatistics {
|
|
459
|
+
/**
|
|
460
|
+
* Gets the type of formatting that should be used for given statistic.
|
|
461
|
+
* <p>
|
|
462
|
+
* the format type for a statistic. A null return value means that the column formatting should be used.
|
|
463
|
+
* @param name - the display name of the statistic
|
|
464
|
+
* @return String
|
|
465
|
+
*/
|
|
466
|
+
getType(name:string):string;
|
|
467
|
+
/**
|
|
468
|
+
* Gets a map with the name of each unique value as key and the count as the value. A map of each unique value's
|
|
469
|
+
* name to the count of how many times it occurred in the column. This map will be empty for tables containing more
|
|
470
|
+
* than 19 unique values.
|
|
471
|
+
* @return Map of String double
|
|
472
|
+
*/
|
|
473
|
+
get uniqueValues():Map<string, number>;
|
|
474
|
+
/**
|
|
475
|
+
* Gets a map with the display name of statistics as keys and the numeric stat as a value.
|
|
476
|
+
* <p>
|
|
477
|
+
* A map of each statistic's name to its value.
|
|
478
|
+
* @return Map of String and Object
|
|
479
|
+
*/
|
|
480
|
+
get statisticsMap():Map<string, object>;
|
|
481
|
+
}
|
|
482
|
+
/**
|
|
483
|
+
* Behaves like a Table, but doesn't expose all of its API for changing the internal state. Instead, state is driven by
|
|
252
484
|
* the upstream table - when it changes handle, this listens and updates its own handle accordingly.
|
|
253
485
|
*
|
|
254
486
|
* Additionally, this is automatically subscribed to its one and only row, across all columns.
|
|
@@ -376,58 +608,50 @@ export namespace dh {
|
|
|
376
608
|
*/
|
|
377
609
|
get isRefreshing():boolean;
|
|
378
610
|
}
|
|
379
|
-
export interface TreeViewportData extends TableData {
|
|
380
|
-
get(index:LongWrapper|number):TreeRow;
|
|
381
|
-
getData(index:LongWrapper|number, column:Column):any;
|
|
382
|
-
getFormat(index:LongWrapper|number, column:Column):Format;
|
|
383
|
-
get treeSize():number;
|
|
384
|
-
get columns():Array<Column>;
|
|
385
|
-
get rows():Array<TreeRow>;
|
|
386
|
-
}
|
|
387
611
|
/**
|
|
388
|
-
*
|
|
389
|
-
*
|
|
612
|
+
* Event data, describing the indexes that were added/removed/updated, and providing access to Rows (and thus data in
|
|
613
|
+
* columns) either by index, or scanning the complete present index.
|
|
390
614
|
* <p>
|
|
391
|
-
*
|
|
392
|
-
*
|
|
393
|
-
*
|
|
615
|
+
* This class supports two ways of reading the table - checking the changes made since the last update, and reading all
|
|
616
|
+
* data currently in the table. While it is more expensive to always iterate over every single row in the table, it may
|
|
617
|
+
* in some cases actually be cheaper than maintaining state separately and updating only the changes, though both
|
|
618
|
+
* options should be considered.
|
|
619
|
+
* <p>
|
|
620
|
+
* The RangeSet objects allow iterating over the LongWrapper indexes in the table. Note that these "indexes" are not
|
|
621
|
+
* necessarily contiguous and may be negative, and represent some internal state on the server, allowing it to keep
|
|
622
|
+
* track of data efficiently. Those LongWrapper objects can be passed to the various methods on this instance to read
|
|
623
|
+
* specific rows or cells out of the table.
|
|
394
624
|
*/
|
|
395
|
-
export interface TableData {
|
|
625
|
+
export interface SubscriptionTableData extends TableData {
|
|
626
|
+
get fullIndex():RangeSet;
|
|
396
627
|
/**
|
|
397
|
-
*
|
|
398
|
-
* @
|
|
399
|
-
* @return the row at the given location
|
|
628
|
+
* The ordered set of row indexes removed since the last update
|
|
629
|
+
* @return the rangeset of removed rows
|
|
400
630
|
*/
|
|
401
|
-
get(
|
|
631
|
+
get removed():RangeSet;
|
|
402
632
|
/**
|
|
403
|
-
*
|
|
404
|
-
* @
|
|
405
|
-
* @param column - the column to read
|
|
406
|
-
* @return the value in the table
|
|
633
|
+
* The ordered set of row indexes added since the last update.
|
|
634
|
+
* @return the rangeset of rows added
|
|
407
635
|
*/
|
|
408
|
-
|
|
636
|
+
get added():RangeSet;
|
|
637
|
+
get columns():Array<Column>;
|
|
409
638
|
/**
|
|
410
|
-
* The
|
|
411
|
-
* @
|
|
412
|
-
* @param column - the column to read
|
|
413
|
-
* @return a Format instance with any server-specified details
|
|
639
|
+
* The ordered set of row indexes updated since the last update
|
|
640
|
+
* @return the rnageset of modified rows
|
|
414
641
|
*/
|
|
415
|
-
|
|
416
|
-
get columns():Array<Column>;
|
|
642
|
+
get modified():RangeSet;
|
|
417
643
|
/**
|
|
418
644
|
* A lazily computed array of all rows available on the client.
|
|
419
645
|
*/
|
|
420
646
|
get rows():Array<Row>;
|
|
421
647
|
}
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
get type():string;
|
|
648
|
+
export interface WorkerHeapInfo {
|
|
649
|
+
/**
|
|
650
|
+
* Total heap size available for this worker.
|
|
651
|
+
*/
|
|
652
|
+
get totalHeapSize():number;
|
|
653
|
+
get freeMemory():number;
|
|
654
|
+
get maximumHeapSize():number;
|
|
431
655
|
}
|
|
432
656
|
/**
|
|
433
657
|
* Represents a row available in a subscription/snapshot on the client. Do not retain references to rows - they will
|
|
@@ -440,238 +664,100 @@ export namespace dh {
|
|
|
440
664
|
get index():LongWrapper;
|
|
441
665
|
}
|
|
442
666
|
/**
|
|
443
|
-
*
|
|
444
|
-
*
|
|
667
|
+
* Similar to the browser `CustomEvent` type, this class holds only the type of the event, and optionally some
|
|
668
|
+
* details about the event.
|
|
669
|
+
* @typeParam T - the type of the event detail
|
|
445
670
|
*/
|
|
446
|
-
export interface
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
671
|
+
export interface Event<T> {
|
|
672
|
+
readonly detail?:null|@jsinterop.annotations.JsNullable T;
|
|
673
|
+
|
|
674
|
+
get type():string;
|
|
675
|
+
}
|
|
676
|
+
|
|
677
|
+
export class LoginCredentials {
|
|
678
|
+
type?:string|null;
|
|
679
|
+
username?:string|null;
|
|
680
|
+
token?:string|null;
|
|
681
|
+
|
|
682
|
+
constructor();
|
|
683
|
+
}
|
|
684
|
+
|
|
685
|
+
/**
|
|
686
|
+
* Represents a non-viewport subscription to a table, and all data currently known to be present in the subscribed
|
|
687
|
+
* columns. This class handles incoming snapshots and deltas, and fires events to consumers to notify of data changes.
|
|
688
|
+
*
|
|
689
|
+
* Unlike {@link dh.TableViewportSubscription}, the "original" table does not have a reference to this instance, only the
|
|
690
|
+
* "private" table instance does, since the original cannot modify the subscription, and the private instance must
|
|
691
|
+
* forward data to it.
|
|
692
|
+
*
|
|
693
|
+
* Represents a subscription to the table on the server. Changes made to the table will not be reflected here - the
|
|
694
|
+
* subscription must be closed and a new one optioned to see those changes. The event model is slightly different from
|
|
695
|
+
* viewports to make it less expensive to compute for large tables.
|
|
696
|
+
*/
|
|
697
|
+
export class TableSubscription implements HasEventHandling {
|
|
698
|
+
protected constructor();
|
|
699
|
+
|
|
475
700
|
/**
|
|
476
|
-
*
|
|
477
|
-
*
|
|
478
|
-
*
|
|
479
|
-
* The `asOfMatchRule` value can be one of:
|
|
480
|
-
* <ul>
|
|
481
|
-
* <li>LESS_THAN_EQUAL</li>
|
|
482
|
-
* <li>LESS_THAN</li>
|
|
483
|
-
* <li>GREATER_THAN_EQUAL</li>
|
|
484
|
-
* <li>GREATER_THAN</li>
|
|
485
|
-
* </ul>
|
|
486
|
-
* @param rightTable - the table to match to values in this table
|
|
487
|
-
* @param columnsToMatch - the columns that should match, according to the asOfMatchRole
|
|
488
|
-
* @param columnsToAdd - columns from the right table to add to the resulting table, empty/null/absent to add all
|
|
489
|
-
* columns
|
|
490
|
-
* @param asOfMatchRule - the match rule to use, see above
|
|
491
|
-
* @return a promise that will resolve to the joined table
|
|
701
|
+
* Updates the subscription to use the given columns and update interval.
|
|
702
|
+
* @param columns - the new columns to subscribe to
|
|
703
|
+
* @param updateIntervalMs - the new update interval, or null/omit to use the default of one second
|
|
492
704
|
*/
|
|
493
|
-
|
|
705
|
+
changeSubscription(columns:Array<Column>, updateIntervalMs:number|undefined|null):void;
|
|
706
|
+
get columns():Array<Column>;
|
|
494
707
|
/**
|
|
495
|
-
*
|
|
496
|
-
* operation. The <b>columnsToAdd</b> parameter is optional, not specifying it will result in all columns from the
|
|
497
|
-
* right table being added to the output. The <b>reserveBits</b> optional parameter lets the client control how the
|
|
498
|
-
* key space is distributed between the rows in the two tables, see the Java <b>Table</b> class for details.
|
|
499
|
-
* @param rightTable - the table to match to values in this table
|
|
500
|
-
* @param columnsToMatch - the columns that should match exactly
|
|
501
|
-
* @param columnsToAdd - columns from the right table to add to the resulting table, empty/null/absent to add all
|
|
502
|
-
* columns
|
|
503
|
-
* @param reserveBits - the number of bits of key-space to initially reserve per group, null/absent will let the
|
|
504
|
-
* server select a value
|
|
505
|
-
* @return a promise that will resolve to the joined table
|
|
708
|
+
* Stops the subscription on the server.
|
|
506
709
|
*/
|
|
507
|
-
|
|
710
|
+
close():void;
|
|
508
711
|
/**
|
|
509
|
-
*
|
|
510
|
-
*
|
|
511
|
-
*
|
|
512
|
-
* @
|
|
513
|
-
* @
|
|
514
|
-
* @param columnsToAdd - columns from the right table to add to the resulting table, empty/null/absent to add all
|
|
515
|
-
* columns
|
|
516
|
-
* @return a promise that will resolve to the joined table
|
|
517
|
-
*/
|
|
518
|
-
exactJoin(rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>|undefined|null):Promise<Table>;
|
|
519
|
-
/**
|
|
520
|
-
* a promise that will be resolved with the newly created table holding the results of the specified natural join
|
|
521
|
-
* operation. The <b>columnsToAdd</b> parameter is optional, not specifying it will result in all columns from the
|
|
522
|
-
* right table being added to the output.
|
|
523
|
-
* @param rightTable - the table to match to values in this table
|
|
524
|
-
* @param columnsToMatch - the columns that should match exactly
|
|
525
|
-
* @param columnsToAdd - columns from the right table to add to the resulting table, empty/null/absent to add all
|
|
526
|
-
* columns
|
|
527
|
-
* @return a promise that will resolve to the joined table
|
|
528
|
-
*/
|
|
529
|
-
naturalJoin(rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>|undefined|null):Promise<Table>;
|
|
530
|
-
}
|
|
531
|
-
/**
|
|
532
|
-
* Represents the contents of a single widget data message from the server, with a binary data paylod and exported
|
|
533
|
-
* objects. Implemented both by Widget itself and by the `event.details` when data is received by the client.
|
|
534
|
-
*
|
|
535
|
-
* Terminology note: the name of this type should probably use "Data" instead of "Message", and the methods should use
|
|
536
|
-
* "payload" rather than "data" to match other platforms and the protobuf itself. These names are instead used for
|
|
537
|
-
* backwards compatibility and to better follow JS expectations.
|
|
538
|
-
*/
|
|
539
|
-
export interface WidgetMessageDetails {
|
|
540
|
-
/**
|
|
541
|
-
* Returns the data from this message as a base64-encoded string.
|
|
542
|
-
*/
|
|
543
|
-
getDataAsBase64():string;
|
|
544
|
-
/**
|
|
545
|
-
* Returns the data from this message as a Uint8Array.
|
|
546
|
-
*/
|
|
547
|
-
getDataAsU8():Uint8Array;
|
|
548
|
-
/**
|
|
549
|
-
* Returns the data from this message as a utf-8 string.
|
|
550
|
-
*/
|
|
551
|
-
getDataAsString():string;
|
|
552
|
-
/**
|
|
553
|
-
* Returns an array of exported objects sent from the server. The plugin implementation is now responsible for these
|
|
554
|
-
* objects, and should close them when no longer needed.
|
|
555
|
-
*/
|
|
556
|
-
get exportedObjects():WidgetExportedObject[];
|
|
557
|
-
}
|
|
558
|
-
/**
|
|
559
|
-
* Extends {@link dh.TableData}, but only contains data in the current viewport. The only API change from TableData is that
|
|
560
|
-
* ViewportData also contains the offset to this data, so that the actual row number may be determined.
|
|
561
|
-
* <p>
|
|
562
|
-
* For viewport subscriptions, it is not necessary to read with the key, only with the position.
|
|
563
|
-
* <p>
|
|
564
|
-
* Do not assume that the first row in `rows` is the first visible row, because extra rows may be provided for easier
|
|
565
|
-
* scrolling without going to the server.
|
|
566
|
-
*/
|
|
567
|
-
export interface ViewportData extends TableData {
|
|
568
|
-
/**
|
|
569
|
-
* Reads a row object from the viewport, based on its position in the table.
|
|
712
|
+
* Listen for events on this object.
|
|
713
|
+
* @param name - the name of the event to listen for
|
|
714
|
+
* @param callback - a function to call when the event occurs
|
|
715
|
+
* @return Returns a cleanup function.
|
|
716
|
+
* @typeParam T - the type of the data that the event will provide
|
|
570
717
|
*/
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
718
|
+
addEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):()=>void;
|
|
719
|
+
nextEvent<T>(eventName:string, timeoutInMillis?:number):Promise<Event<T>>;
|
|
720
|
+
hasListeners(name:string):boolean;
|
|
574
721
|
/**
|
|
575
|
-
*
|
|
722
|
+
* Removes an event listener added to this table.
|
|
723
|
+
* @param name -
|
|
724
|
+
* @param callback -
|
|
725
|
+
* @return
|
|
726
|
+
* @typeParam T -
|
|
576
727
|
*/
|
|
577
|
-
|
|
578
|
-
get columns():Array<Column>;
|
|
579
|
-
get rows():Array<ViewportRow>;
|
|
728
|
+
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
580
729
|
}
|
|
730
|
+
|
|
581
731
|
/**
|
|
582
|
-
*
|
|
583
|
-
* columns) either by index, or scanning the complete present index.
|
|
584
|
-
* <p>
|
|
585
|
-
* This class supports two ways of reading the table - checking the changes made since the last update, and reading all
|
|
586
|
-
* data currently in the table. While it is more expensive to always iterate over every single row in the table, it may
|
|
587
|
-
* in some cases actually be cheaper than maintaining state separately and updating only the changes, though both
|
|
588
|
-
* options should be considered.
|
|
589
|
-
* <p>
|
|
590
|
-
* The RangeSet objects allow iterating over the LongWrapper indexes in the table. Note that these "indexes" are not
|
|
591
|
-
* necessarily contiguous and may be negative, and represent some internal state on the server, allowing it to keep
|
|
592
|
-
* track of data efficiently. Those LongWrapper objects can be passed to the various methods on this instance to read
|
|
593
|
-
* specific rows or cells out of the table.
|
|
732
|
+
* Addition optional configuration that can be passed to the {@link dh.CoreClient} constructor.
|
|
594
733
|
*/
|
|
595
|
-
export
|
|
596
|
-
get fullIndex():RangeSet;
|
|
597
|
-
/**
|
|
598
|
-
* The ordered set of row indexes removed since the last update
|
|
599
|
-
* @return the rangeset of removed rows
|
|
600
|
-
*/
|
|
601
|
-
get removed():RangeSet;
|
|
602
|
-
/**
|
|
603
|
-
* The ordered set of row indexes added since the last update.
|
|
604
|
-
* @return the rangeset of rows added
|
|
605
|
-
*/
|
|
606
|
-
get added():RangeSet;
|
|
607
|
-
get columns():Array<Column>;
|
|
734
|
+
export class ConnectOptions {
|
|
608
735
|
/**
|
|
609
|
-
*
|
|
610
|
-
* @return the rnageset of modified rows
|
|
736
|
+
* Optional map of http header names and values to send to the server with each request.
|
|
611
737
|
*/
|
|
612
|
-
|
|
738
|
+
headers?:{ [key: string]: string; }|null;
|
|
613
739
|
/**
|
|
614
|
-
*
|
|
740
|
+
* True to enable debug logging. At this time, only enables logging for gRPC calls.
|
|
615
741
|
*/
|
|
616
|
-
|
|
617
|
-
}
|
|
618
|
-
/**
|
|
619
|
-
* Represents statistics for a given table column.
|
|
620
|
-
*/
|
|
621
|
-
export interface ColumnStatistics {
|
|
742
|
+
debug?:boolean|null;
|
|
622
743
|
/**
|
|
623
|
-
*
|
|
744
|
+
* Set this to true to force the use of websockets when connecting to the deephaven instance, false to force the use
|
|
745
|
+
* of `fetch`. Ignored if {@link dh.transportFactory} is set.
|
|
624
746
|
* <p>
|
|
625
|
-
*
|
|
626
|
-
* @param name - the display name of the statistic
|
|
627
|
-
* @return String
|
|
628
|
-
*/
|
|
629
|
-
getType(name:string):string;
|
|
630
|
-
/**
|
|
631
|
-
* Gets a map with the name of each unique value as key and the count as the value. A map of each unique value's
|
|
632
|
-
* name to the count of how many times it occurred in the column. This map will be empty for tables containing more
|
|
633
|
-
* than 19 unique values.
|
|
634
|
-
* @return Map of String double
|
|
747
|
+
* Defaults to null, indicating that the server URL should be checked to see if we connect with fetch or websockets.
|
|
635
748
|
*/
|
|
636
|
-
|
|
749
|
+
useWebsockets?:boolean|null;
|
|
637
750
|
/**
|
|
638
|
-
*
|
|
751
|
+
* The transport factory to use for creating gRPC streams. If specified, the JS API will ignore
|
|
752
|
+
* {@link dh.useWebsockets} and its own internal logic for determining the appropriate transport to use.
|
|
639
753
|
* <p>
|
|
640
|
-
*
|
|
641
|
-
*
|
|
754
|
+
* Defaults to null, indicating that the JS API should determine the appropriate transport to use. If
|
|
755
|
+
* `useWebsockets` is set to true, the JS API will use websockets, otherwise if the server url begins with
|
|
756
|
+
* https, it will use fetch, otherwise it will use websockets.
|
|
642
757
|
*/
|
|
643
|
-
|
|
644
|
-
}
|
|
645
|
-
export interface LayoutHints {
|
|
646
|
-
readonly searchDisplayMode?:SearchDisplayModeType|null;
|
|
758
|
+
transportFactory?:dh.grpc.GrpcTransportFactory|null;
|
|
647
759
|
|
|
648
|
-
|
|
649
|
-
get frozenColumns():string[]|null;
|
|
650
|
-
get columnGroups():ColumnGroup[]|null;
|
|
651
|
-
get areSavedLayoutsAllowed():boolean;
|
|
652
|
-
get frontColumns():string[]|null;
|
|
653
|
-
get backColumns():string[]|null;
|
|
654
|
-
}
|
|
655
|
-
/**
|
|
656
|
-
* Wrap LocalDate values for use in JS. Provides text formatting for display and access to the underlying value.
|
|
657
|
-
*/
|
|
658
|
-
export interface LocalDateWrapper {
|
|
659
|
-
valueOf():string;
|
|
660
|
-
getYear():number;
|
|
661
|
-
getMonthValue():number;
|
|
662
|
-
getDayOfMonth():number;
|
|
663
|
-
toString():string;
|
|
664
|
-
}
|
|
665
|
-
/**
|
|
666
|
-
* Wrap LocalTime values for use in JS. Provides text formatting for display and access to the underlying value.
|
|
667
|
-
*/
|
|
668
|
-
export interface LocalTimeWrapper {
|
|
669
|
-
valueOf():string;
|
|
670
|
-
getHour():number;
|
|
671
|
-
getMinute():number;
|
|
672
|
-
getSecond():number;
|
|
673
|
-
getNano():number;
|
|
674
|
-
toString():string;
|
|
760
|
+
constructor();
|
|
675
761
|
}
|
|
676
762
|
|
|
677
763
|
/**
|
|
@@ -768,620 +854,95 @@ export namespace dh {
|
|
|
768
854
|
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
769
855
|
}
|
|
770
856
|
|
|
771
|
-
export class DateWrapper extends LongWrapper {
|
|
772
|
-
protected constructor();
|
|
773
|
-
|
|
774
|
-
static ofJsDate(date:Date):DateWrapper;
|
|
775
|
-
asDate():Date;
|
|
776
|
-
}
|
|
777
|
-
|
|
778
857
|
/**
|
|
779
|
-
* Describes
|
|
780
|
-
*
|
|
858
|
+
* Describes the structure of the column, and if desired can be used to get access to the data to be rendered in this
|
|
859
|
+
* column.
|
|
781
860
|
*/
|
|
782
|
-
export class
|
|
783
|
-
/**
|
|
784
|
-
* Ordered list of columns to group by to form the hierarchy of the resulting roll-up table.
|
|
785
|
-
*/
|
|
786
|
-
groupingColumns:Array<String>;
|
|
787
|
-
/**
|
|
788
|
-
* Mapping from each aggregation name to the ordered list of columns it should be applied to in the resulting
|
|
789
|
-
* roll-up table.
|
|
790
|
-
*/
|
|
791
|
-
aggregations:{ [key: string]: Array<string>; };
|
|
792
|
-
/**
|
|
793
|
-
* Optional parameter indicating if an extra leaf node should be added at the bottom of the hierarchy, showing the
|
|
794
|
-
* rows in the underlying table which make up that grouping. Since these values might be a different type from the
|
|
795
|
-
* rest of the column, any client code must check if TreeRow.hasChildren = false, and if so, interpret those values
|
|
796
|
-
* as if they were Column.constituentType instead of Column.type. Defaults to false.
|
|
797
|
-
*/
|
|
798
|
-
includeConstituents:boolean;
|
|
799
|
-
includeOriginalColumns?:boolean|null;
|
|
861
|
+
export class Column {
|
|
800
862
|
/**
|
|
801
|
-
*
|
|
863
|
+
* If this column is part of a roll-up tree table, represents the type of the row data that can be found in this
|
|
864
|
+
* column for leaf nodes if includeConstituents is enabled. Otherwise, it is <b>null</b>.
|
|
865
|
+
* @return String
|
|
802
866
|
*/
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
constructor();
|
|
806
|
-
}
|
|
807
|
-
|
|
808
|
-
/**
|
|
809
|
-
* Wrap BigInteger values for use in JS. Provides text formatting for display and access to the underlying value.
|
|
810
|
-
*/
|
|
811
|
-
export class BigIntegerWrapper {
|
|
812
|
-
protected constructor();
|
|
813
|
-
|
|
814
|
-
static ofString(str:string):BigIntegerWrapper;
|
|
815
|
-
asNumber():number;
|
|
816
|
-
valueOf():string;
|
|
817
|
-
toString():string;
|
|
818
|
-
}
|
|
819
|
-
|
|
820
|
-
export class QueryInfo {
|
|
821
|
-
static readonly EVENT_TABLE_OPENED:string;
|
|
822
|
-
static readonly EVENT_DISCONNECT:string;
|
|
823
|
-
static readonly EVENT_RECONNECT:string;
|
|
824
|
-
static readonly EVENT_CONNECT:string;
|
|
825
|
-
|
|
826
|
-
protected constructor();
|
|
827
|
-
}
|
|
828
|
-
|
|
829
|
-
export class IdeSession implements HasEventHandling {
|
|
830
|
-
static readonly EVENT_COMMANDSTARTED:string;
|
|
831
|
-
static readonly EVENT_REQUEST_FAILED:string;
|
|
867
|
+
readonly constituentType?:string|null;
|
|
868
|
+
readonly description?:string|null;
|
|
832
869
|
|
|
833
870
|
protected constructor();
|
|
834
871
|
|
|
835
872
|
/**
|
|
836
|
-
*
|
|
837
|
-
* @param
|
|
838
|
-
* @
|
|
839
|
-
* @return {@link Promise} of {@link dh.Table}
|
|
873
|
+
* the value for this column in the given row. Type will be consistent with the type of the Column.
|
|
874
|
+
* @param row -
|
|
875
|
+
* @return Any
|
|
840
876
|
*/
|
|
841
|
-
|
|
877
|
+
get(row:Row):any;
|
|
878
|
+
getFormat(row:Row):Format;
|
|
842
879
|
/**
|
|
843
|
-
*
|
|
844
|
-
* @
|
|
845
|
-
* @return promise of dh.plot.Figure
|
|
880
|
+
* Creates a sort builder object, to be used when sorting by this column.
|
|
881
|
+
* @return {@link dh.Sort}
|
|
846
882
|
*/
|
|
847
|
-
|
|
883
|
+
sort():Sort;
|
|
848
884
|
/**
|
|
849
|
-
*
|
|
850
|
-
*
|
|
851
|
-
* @
|
|
852
|
-
* @return {@link Promise} of {@link dh.TreeTable}
|
|
853
|
-
*/
|
|
854
|
-
getTreeTable(name:string):Promise<TreeTable>;
|
|
855
|
-
getHierarchicalTable(name:string):Promise<TreeTable>;
|
|
856
|
-
getPartitionedTable(name:string):Promise<PartitionedTable>;
|
|
857
|
-
getObject(definitionObject:dh.ide.VariableDescriptor):Promise<any>;
|
|
858
|
-
newTable(columnNames:string[], types:string[], data:string[][], userTimeZone:string):Promise<Table>;
|
|
859
|
-
/**
|
|
860
|
-
* Merges the given tables into a single table. Assumes all tables have the same structure.
|
|
861
|
-
* @param tables -
|
|
862
|
-
* @return {@link Promise} of {@link dh.Table}
|
|
863
|
-
*/
|
|
864
|
-
mergeTables(tables:Table[]):Promise<Table>;
|
|
865
|
-
bindTableToVariable(table:Table, name:string):Promise<void>;
|
|
866
|
-
subscribeToFieldUpdates(callback:(arg0:dh.ide.VariableChanges)=>void):()=>void;
|
|
867
|
-
close():void;
|
|
868
|
-
runCode(code:string):Promise<dh.ide.CommandResult>;
|
|
869
|
-
onLogMessage(callback:(arg0:dh.ide.LogItem)=>void):()=>void;
|
|
870
|
-
openDocument(params:object):void;
|
|
871
|
-
changeDocument(params:object):void;
|
|
872
|
-
getCompletionItems(params:object):Promise<Array<dh.lsp.CompletionItem>>;
|
|
873
|
-
getSignatureHelp(params:object):Promise<Array<dh.lsp.SignatureInformation>>;
|
|
874
|
-
getHover(params:object):Promise<dh.lsp.Hover>;
|
|
875
|
-
closeDocument(params:object):void;
|
|
876
|
-
/**
|
|
877
|
-
* Creates an empty table with the specified number of rows. Optionally columns and types may be specified, but all
|
|
878
|
-
* values will be null.
|
|
879
|
-
* @param size -
|
|
880
|
-
* @return {@link Promise} of {@link dh.Table}
|
|
881
|
-
*/
|
|
882
|
-
emptyTable(size:number):Promise<Table>;
|
|
883
|
-
/**
|
|
884
|
-
* Creates a new table that ticks automatically every "periodNanos" nanoseconds. A start time may be provided; if so
|
|
885
|
-
* the table will be populated with the interval from the specified date until now.
|
|
886
|
-
* @param periodNanos -
|
|
887
|
-
* @param startTime -
|
|
888
|
-
* @return {@link Promise} of {@link dh.Table}
|
|
889
|
-
*/
|
|
890
|
-
timeTable(periodNanos:number, startTime?:DateWrapper):Promise<Table>;
|
|
891
|
-
addEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):()=>void;
|
|
892
|
-
nextEvent<T>(eventName:string, timeoutInMillis?:number):Promise<Event<T>>;
|
|
893
|
-
hasListeners(name:string):boolean;
|
|
894
|
-
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
895
|
-
}
|
|
896
|
-
|
|
897
|
-
/**
|
|
898
|
-
* A js type for operating on input tables.
|
|
899
|
-
*
|
|
900
|
-
* Represents a User Input Table, which can have data added to it from other sources.
|
|
901
|
-
*
|
|
902
|
-
* You may add rows using dictionaries of key-value tuples (representing columns by name), add tables containing all the
|
|
903
|
-
* key/value columns to add, or delete tables containing the keys to delete. Each operation is atomic, and will either
|
|
904
|
-
* succeed completely or fail completely. To guarantee order of operations, apply an operation and wait for the response
|
|
905
|
-
* before sending the next operation.
|
|
906
|
-
*
|
|
907
|
-
* Each table has one or more key columns, where each unique combination of keys will appear at most once in the table.
|
|
908
|
-
*
|
|
909
|
-
* To view the results of the Input Table, you should use standard table operations on the InputTable's source Table
|
|
910
|
-
* object.
|
|
911
|
-
*/
|
|
912
|
-
export class InputTable {
|
|
913
|
-
protected constructor();
|
|
914
|
-
|
|
915
|
-
/**
|
|
916
|
-
* Adds a single row to the table. For each key or value column name in the Input Table, we retrieve that javascript
|
|
917
|
-
* property at that name and validate it can be put into the given column type.
|
|
918
|
-
* @param row -
|
|
919
|
-
* @param userTimeZone -
|
|
920
|
-
* @return Promise of dh.InputTable
|
|
921
|
-
*/
|
|
922
|
-
addRow(row:{ [key: string]: any; }, userTimeZone?:string):Promise<InputTable>;
|
|
923
|
-
/**
|
|
924
|
-
* Add multiple rows to a table.
|
|
925
|
-
* @param rows -
|
|
926
|
-
* @param userTimeZone -
|
|
927
|
-
* @return Promise of dh.InputTable
|
|
928
|
-
*/
|
|
929
|
-
addRows(rows:{ [key: string]: any; }[], userTimeZone?:string):Promise<InputTable>;
|
|
930
|
-
/**
|
|
931
|
-
* Add an entire table to this Input Table. Only column names that match the definition of the input table will be
|
|
932
|
-
* copied, and all key columns must have values filled in. This only copies the current state of the source table;
|
|
933
|
-
* future updates to the source table will not be reflected in the Input Table. The returned promise will be
|
|
934
|
-
* resolved to the same InputTable instance this method was called upon once the server returns.
|
|
935
|
-
* @param tableToAdd -
|
|
936
|
-
* @return Promise of dh.InputTable
|
|
937
|
-
*/
|
|
938
|
-
addTable(tableToAdd:Table):Promise<InputTable>;
|
|
939
|
-
/**
|
|
940
|
-
* Add multiple tables to this Input Table.
|
|
941
|
-
* @param tablesToAdd -
|
|
942
|
-
* @return Promise of dh.InputTable
|
|
943
|
-
*/
|
|
944
|
-
addTables(tablesToAdd:Table[]):Promise<InputTable>;
|
|
945
|
-
/**
|
|
946
|
-
* Deletes an entire table from this Input Table. Key columns must match the Input Table.
|
|
947
|
-
* @param tableToDelete -
|
|
948
|
-
* @return Promise of dh.InputTable
|
|
949
|
-
*/
|
|
950
|
-
deleteTable(tableToDelete:Table):Promise<InputTable>;
|
|
951
|
-
/**
|
|
952
|
-
* Delete multiple tables from this Input Table.
|
|
953
|
-
* @param tablesToDelete -
|
|
954
|
-
* @return
|
|
955
|
-
*/
|
|
956
|
-
deleteTables(tablesToDelete:Table[]):Promise<InputTable>;
|
|
957
|
-
/**
|
|
958
|
-
* A list of the key columns, by name
|
|
959
|
-
* @return String array.
|
|
960
|
-
*/
|
|
961
|
-
get keys():string[];
|
|
962
|
-
/**
|
|
963
|
-
* A list of the value columns, by name
|
|
964
|
-
* @return String array.
|
|
965
|
-
*/
|
|
966
|
-
get values():string[];
|
|
967
|
-
/**
|
|
968
|
-
* A list of the key columns.
|
|
969
|
-
* @return Column array.
|
|
970
|
-
*/
|
|
971
|
-
get keyColumns():Column[];
|
|
972
|
-
/**
|
|
973
|
-
* A list of the value Column objects
|
|
974
|
-
* @return {@link dh.Column} array.
|
|
975
|
-
*/
|
|
976
|
-
get valueColumns():Column[];
|
|
977
|
-
/**
|
|
978
|
-
* The source table for this Input Table
|
|
979
|
-
* @return dh.table
|
|
980
|
-
*/
|
|
981
|
-
get table():Table;
|
|
982
|
-
}
|
|
983
|
-
|
|
984
|
-
/**
|
|
985
|
-
* Addition optional configuration that can be passed to the {@link dh.CoreClient} constructor.
|
|
986
|
-
*/
|
|
987
|
-
export class ConnectOptions {
|
|
988
|
-
/**
|
|
989
|
-
* Optional map of http header names and values to send to the server with each request.
|
|
990
|
-
*/
|
|
991
|
-
headers?:{ [key: string]: string; }|null;
|
|
992
|
-
/**
|
|
993
|
-
* True to enable debug logging. At this time, only enables logging for gRPC calls.
|
|
994
|
-
*/
|
|
995
|
-
debug?:boolean|null;
|
|
996
|
-
/**
|
|
997
|
-
* Set this to true to force the use of websockets when connecting to the deephaven instance, false to force the use
|
|
998
|
-
* of `fetch`.
|
|
999
|
-
* <p>
|
|
1000
|
-
* Defaults to null, indicating that the server URL should be checked to see if we connect with fetch or websockets.
|
|
1001
|
-
*/
|
|
1002
|
-
useWebsockets?:boolean|null;
|
|
1003
|
-
|
|
1004
|
-
constructor();
|
|
1005
|
-
}
|
|
1006
|
-
|
|
1007
|
-
export class CoreClient implements HasEventHandling {
|
|
1008
|
-
static readonly EVENT_CONNECT:string;
|
|
1009
|
-
static readonly EVENT_DISCONNECT:string;
|
|
1010
|
-
static readonly EVENT_RECONNECT:string;
|
|
1011
|
-
static readonly EVENT_RECONNECT_AUTH_FAILED:string;
|
|
1012
|
-
static readonly EVENT_REQUEST_FAILED:string;
|
|
1013
|
-
static readonly EVENT_REQUEST_STARTED:string;
|
|
1014
|
-
static readonly EVENT_REQUEST_SUCCEEDED:string;
|
|
1015
|
-
/**
|
|
1016
|
-
* @deprecated
|
|
1017
|
-
*/
|
|
1018
|
-
static readonly EVENT_REFRESH_TOKEN_UPDATED:string;
|
|
1019
|
-
static readonly LOGIN_TYPE_PASSWORD:string;
|
|
1020
|
-
static readonly LOGIN_TYPE_ANONYMOUS:string;
|
|
1021
|
-
|
|
1022
|
-
constructor(serverUrl:string, connectOptions?:ConnectOptions);
|
|
1023
|
-
|
|
1024
|
-
running():Promise<CoreClient>;
|
|
1025
|
-
getServerUrl():string;
|
|
1026
|
-
getAuthConfigValues():Promise<string[][]>;
|
|
1027
|
-
login(credentials:LoginCredentials):Promise<void>;
|
|
1028
|
-
relogin(token:RefreshToken):Promise<void>;
|
|
1029
|
-
onConnected(timeoutInMillis?:number):Promise<void>;
|
|
1030
|
-
getServerConfigValues():Promise<string[][]>;
|
|
1031
|
-
getStorageService():dh.storage.StorageService;
|
|
1032
|
-
getAsIdeConnection():Promise<IdeConnection>;
|
|
1033
|
-
disconnect():void;
|
|
1034
|
-
addEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):()=>void;
|
|
1035
|
-
nextEvent<T>(eventName:string, timeoutInMillis?:number):Promise<Event<T>>;
|
|
1036
|
-
hasListeners(name:string):boolean;
|
|
1037
|
-
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
1038
|
-
}
|
|
1039
|
-
|
|
1040
|
-
/**
|
|
1041
|
-
* Event fired when a command is issued from the client.
|
|
1042
|
-
*/
|
|
1043
|
-
export class CommandInfo {
|
|
1044
|
-
constructor(code:string, result:Promise<dh.ide.CommandResult>);
|
|
1045
|
-
|
|
1046
|
-
get result():Promise<dh.ide.CommandResult>;
|
|
1047
|
-
get code():string;
|
|
1048
|
-
}
|
|
1049
|
-
|
|
1050
|
-
/**
|
|
1051
|
-
* Behaves like a {@link dh.Table} externally, but data, state, and viewports are managed by an entirely different
|
|
1052
|
-
* mechanism, and so reimplemented here.
|
|
1053
|
-
* <p>
|
|
1054
|
-
* Any time a change is made, we build a new request and send it to the server, and wait for the updated state.
|
|
1055
|
-
* <p>
|
|
1056
|
-
* Semantics around getting updates from the server are slightly different - we don't "unset" the viewport here after
|
|
1057
|
-
* operations are performed, but encourage the client code to re-set them to the desired position.
|
|
1058
|
-
* <p>
|
|
1059
|
-
* The table size will be -1 until a viewport has been fetched.
|
|
1060
|
-
* <p>
|
|
1061
|
-
* Similar to a table, a Tree Table provides access to subscribed viewport data on the current hierarchy. A different
|
|
1062
|
-
* Row type is used within that viewport, showing the depth of that node within the tree and indicating details about
|
|
1063
|
-
* whether it has children or is expanded. The Tree Table itself then provides the ability to change if a row is
|
|
1064
|
-
* expanded or not. Methods used to control or check if a row should be expanded or not can be invoked on a TreeRow
|
|
1065
|
-
* instance, or on the number of the row (thus allowing for expanding/collapsing rows which are not currently visible in
|
|
1066
|
-
* the viewport).
|
|
1067
|
-
* <p>
|
|
1068
|
-
* Events and viewports are somewhat different from tables, due to the expense of computing the expanded/collapsed rows
|
|
1069
|
-
* and count of children at each level of the hierarchy, and differences in the data that is available.
|
|
1070
|
-
* <p>
|
|
1071
|
-
* <ul>
|
|
1072
|
-
* <li>There is no {@link Table.totalSize | totalSize} property.</li>
|
|
1073
|
-
* <li>The viewport is not un-set when changes are made to filter or sort, but changes will continue to be streamed in.
|
|
1074
|
-
* It is suggested that the viewport be changed to the desired position (usually the first N rows) after any filter/sort
|
|
1075
|
-
* change is made. Likewise, {@link getViewportData} will always return the most recent data, and will not wait if a
|
|
1076
|
-
* new operation is pending.</li>
|
|
1077
|
-
* <li>Custom columns are not directly supported. If the TreeTable was created client-side, the original Table can have
|
|
1078
|
-
* custom columns applied, and the TreeTable can be recreated.</li>
|
|
1079
|
-
* <li>Whereas Table has a {@link Table.totalsTableConfig} property, it is defined here as a method,
|
|
1080
|
-
* {@link getTotalsTableConfig}. This returns a promise so the config can be fetched asynchronously.</li>
|
|
1081
|
-
* <li>Totals Tables for trees vary in behavior between tree tables and roll-up tables. This behavior is based on the
|
|
1082
|
-
* original flat table used to produce the Tree Table - for a hierarchical table (i.e. Table.treeTable in the query
|
|
1083
|
-
* config), the totals will include non-leaf nodes (since they are themselves actual rows in the table), but in a
|
|
1084
|
-
* roll-up table, the totals only include leaf nodes (as non-leaf nodes are generated through grouping the contents of
|
|
1085
|
-
* the original table). Roll-ups also have the {@link dh.includeConstituents} property, indicating that a
|
|
1086
|
-
* {@link dh.Column} in the tree may have a {@link Column.constituentType} property reflecting that the type of cells
|
|
1087
|
-
* where {@link TreeRowImpl.hasChildren} is false will be different from usual.</li>
|
|
1088
|
-
* </ul>
|
|
1089
|
-
*/
|
|
1090
|
-
export class TreeTable implements HasEventHandling {
|
|
1091
|
-
/**
|
|
1092
|
-
* event.detail is the currently visible viewport data based on the active viewport configuration.
|
|
1093
|
-
*/
|
|
1094
|
-
static readonly EVENT_UPDATED:string;
|
|
1095
|
-
/**
|
|
1096
|
-
* event.detail is the currently visible viewport data based on the active viewport configuration.
|
|
1097
|
-
*/
|
|
1098
|
-
static readonly EVENT_DISCONNECT:string;
|
|
1099
|
-
/**
|
|
1100
|
-
* event.detail is the currently visible viewport data based on the active viewport configuration.
|
|
1101
|
-
*/
|
|
1102
|
-
static readonly EVENT_RECONNECT:string;
|
|
1103
|
-
/**
|
|
1104
|
-
* event.detail is the currently visible viewport data based on the active viewport configuration.
|
|
1105
|
-
*/
|
|
1106
|
-
static readonly EVENT_RECONNECTFAILED:string;
|
|
1107
|
-
/**
|
|
1108
|
-
* event.detail is the currently visible viewport data based on the active viewport configuration.
|
|
1109
|
-
*/
|
|
1110
|
-
static readonly EVENT_REQUEST_FAILED:string;
|
|
1111
|
-
readonly description?:string|null;
|
|
1112
|
-
readonly layoutHints?:null|LayoutHints;
|
|
1113
|
-
|
|
1114
|
-
protected constructor();
|
|
1115
|
-
|
|
1116
|
-
/**
|
|
1117
|
-
* Expands the given node, so that its children are visible when they are in the viewport. The parameter can be the
|
|
1118
|
-
* row index, or the row object itself. The second parameter is a boolean value, false by default, specifying if the
|
|
1119
|
-
* row and all descendants should be fully expanded. Equivalent to `setExpanded(row, true)` with an optional third
|
|
1120
|
-
* boolean parameter.
|
|
1121
|
-
* @param row -
|
|
1122
|
-
* @param expandDescendants -
|
|
1123
|
-
*/
|
|
1124
|
-
expand(row:TreeRow|number, expandDescendants?:boolean):void;
|
|
1125
|
-
/**
|
|
1126
|
-
* Collapses the given node, so that its children and descendants are not visible in the size or the viewport. The
|
|
1127
|
-
* parameter can be the row index, or the row object itself. Equivalent to <b>setExpanded(row, false, false)</b>.
|
|
1128
|
-
* @param row -
|
|
1129
|
-
*/
|
|
1130
|
-
collapse(row:TreeRow|number):void;
|
|
1131
|
-
/**
|
|
1132
|
-
* Specifies if the given node should be expanded or collapsed. If this node has children, and the value is changed,
|
|
1133
|
-
* the size of the table will change. If node is to be expanded and the third parameter, <b>expandDescendants</b>,
|
|
1134
|
-
* is true, then its children will also be expanded.
|
|
1135
|
-
* @param row - the row to expand or collapse, either the absolute row index or the row object
|
|
1136
|
-
* @param isExpanded - true to expand the row, false to collapse
|
|
1137
|
-
* @param expandDescendants - true to expand the row and all descendants, false to expand only the row, defaults to
|
|
1138
|
-
* false
|
|
1139
|
-
*/
|
|
1140
|
-
setExpanded(row:TreeRow|number, isExpanded:boolean, expandDescendants?:boolean):void;
|
|
1141
|
-
expandAll():void;
|
|
1142
|
-
collapseAll():void;
|
|
1143
|
-
/**
|
|
1144
|
-
* Tests if the specified row is expanded.
|
|
1145
|
-
* @param row - the row to test, either the absolute row index or the row object
|
|
1146
|
-
* @return boolean true if the row is expanded, false otherwise
|
|
1147
|
-
*/
|
|
1148
|
-
isExpanded(row:TreeRow|number):boolean;
|
|
1149
|
-
setViewport(firstRow:number, lastRow:number, columns?:Array<Column>|undefined|null, updateInterval?:number|undefined|null):void;
|
|
1150
|
-
getViewportData():Promise<TreeViewportData>;
|
|
1151
|
-
/**
|
|
1152
|
-
* Indicates that the table will no longer be used, and server resources can be freed.
|
|
1153
|
-
*/
|
|
1154
|
-
close():void;
|
|
1155
|
-
/**
|
|
1156
|
-
* Applies the given sort to all levels of the tree. Returns the previous sort in use.
|
|
1157
|
-
* @param sort -
|
|
1158
|
-
* @return {@link dh.Sort} array
|
|
1159
|
-
*/
|
|
1160
|
-
applySort(sort:Sort[]):Array<Sort>;
|
|
1161
|
-
/**
|
|
1162
|
-
* Applies the given filter to the contents of the tree in such a way that if any node is visible, then any parent
|
|
1163
|
-
* node will be visible as well even if that parent node would not normally be visible due to the filter's
|
|
1164
|
-
* condition. Returns the previous sort in use.
|
|
1165
|
-
* @param filter -
|
|
1166
|
-
* @return {@link dh.FilterCondition} array
|
|
1167
|
-
*/
|
|
1168
|
-
applyFilter(filter:FilterCondition[]):Array<FilterCondition>;
|
|
1169
|
-
/**
|
|
1170
|
-
* a column with the given name, or throws an exception if it cannot be found
|
|
1171
|
-
* @param key -
|
|
1172
|
-
* @return {@link dh.Column}
|
|
1173
|
-
*/
|
|
1174
|
-
findColumn(key:string):Column;
|
|
1175
|
-
/**
|
|
1176
|
-
* an array with all of the named columns in order, or throws an exception if one cannot be found.
|
|
1177
|
-
* @param keys -
|
|
1178
|
-
* @return {@link dh.Column} array
|
|
1179
|
-
*/
|
|
1180
|
-
findColumns(keys:string[]):Column[];
|
|
1181
|
-
/**
|
|
1182
|
-
* Provides Table-like selectDistinct functionality, but with a few quirks, since it is only fetching the distinct
|
|
1183
|
-
* values for the given columns in the source table:
|
|
1184
|
-
* <ul>
|
|
1185
|
-
* <li>Rollups may make no sense, since values are aggregated.</li>
|
|
1186
|
-
* <li>Values found on orphaned (and removed) nodes will show up in the resulting table, even though they are not in
|
|
1187
|
-
* the tree.</li>
|
|
1188
|
-
* <li>Values found on parent nodes which are only present in the tree since a child is visible will not be present
|
|
1189
|
-
* in the resulting table.</li>
|
|
1190
|
-
* </ul>
|
|
1191
|
-
*/
|
|
1192
|
-
selectDistinct(columns:Column[]):Promise<Table>;
|
|
1193
|
-
getTotalsTableConfig():Promise<TotalsTableConfig>;
|
|
1194
|
-
getTotalsTable(config?:object):Promise<TotalsTable>;
|
|
1195
|
-
getGrandTotalsTable(config?:object):Promise<TotalsTable>;
|
|
1196
|
-
/**
|
|
1197
|
-
* a new copy of this treetable, so it can be sorted and filtered separately, and maintain a different viewport.
|
|
1198
|
-
* Unlike Table, this will _not_ copy the filter or sort, since tree table viewport semantics differ, and without a
|
|
1199
|
-
* viewport set, the treetable doesn't evaluate these settings, and they aren't readable on the properties. Expanded
|
|
1200
|
-
* state is also not copied.
|
|
1201
|
-
* @return Promise of dh.TreeTable
|
|
1202
|
-
*/
|
|
1203
|
-
copy():Promise<TreeTable>;
|
|
1204
|
-
/**
|
|
1205
|
-
* The current filter configuration of this Tree Table.
|
|
1206
|
-
* @return {@link dh.FilterCondition} array
|
|
1207
|
-
*/
|
|
1208
|
-
get filter():Array<FilterCondition>;
|
|
1209
|
-
/**
|
|
1210
|
-
* True if this is a roll-up and will provide the original rows that make up each grouping.
|
|
1211
|
-
* @return boolean
|
|
1212
|
-
*/
|
|
1213
|
-
get includeConstituents():boolean;
|
|
1214
|
-
get groupedColumns():Array<Column>;
|
|
1215
|
-
/**
|
|
1216
|
-
* True if this table has been closed.
|
|
1217
|
-
* @return boolean
|
|
1218
|
-
*/
|
|
1219
|
-
get isClosed():boolean;
|
|
1220
|
-
/**
|
|
1221
|
-
* The current number of rows given the table's contents and the various expand/collapse states of each node. (No
|
|
1222
|
-
* totalSize is provided at this time; its definition becomes unclear between roll-up and tree tables, especially
|
|
1223
|
-
* when considering collapse/expand states).
|
|
1224
|
-
* @return double
|
|
1225
|
-
*/
|
|
1226
|
-
get size():number;
|
|
1227
|
-
/**
|
|
1228
|
-
* The columns that can be shown in this Tree Table.
|
|
1229
|
-
* @return {@link dh.Column} array
|
|
1230
|
-
*/
|
|
1231
|
-
get columns():Array<Column>;
|
|
1232
|
-
/**
|
|
1233
|
-
* The current sort configuration of this Tree Table
|
|
1234
|
-
* @return {@link dh.Sort} array.
|
|
1235
|
-
*/
|
|
1236
|
-
get sort():Array<Sort>;
|
|
1237
|
-
/**
|
|
1238
|
-
* True if this table may receive updates from the server, including size changed events, updated events after
|
|
1239
|
-
* initial snapshot.
|
|
1240
|
-
* @return boolean
|
|
1241
|
-
*/
|
|
1242
|
-
get isRefreshing():boolean;
|
|
1243
|
-
/**
|
|
1244
|
-
* Listen for events on this object.
|
|
1245
|
-
* @param name - the name of the event to listen for
|
|
1246
|
-
* @param callback - a function to call when the event occurs
|
|
1247
|
-
* @return Returns a cleanup function.
|
|
1248
|
-
* @typeParam T - the type of the data that the event will provide
|
|
1249
|
-
*/
|
|
1250
|
-
addEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):()=>void;
|
|
1251
|
-
nextEvent<T>(eventName:string, timeoutInMillis?:number):Promise<Event<T>>;
|
|
1252
|
-
hasListeners(name:string):boolean;
|
|
1253
|
-
/**
|
|
1254
|
-
* Removes an event listener added to this table.
|
|
1255
|
-
* @param name -
|
|
1256
|
-
* @param callback -
|
|
1257
|
-
* @return
|
|
1258
|
-
* @typeParam T -
|
|
1259
|
-
*/
|
|
1260
|
-
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
1261
|
-
}
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
/**
|
|
1265
|
-
* Describes a filter which can be applied to a table. Replacing these instances may be more expensive than reusing
|
|
1266
|
-
* them. These instances are immutable - all operations that compose them to build bigger expressions return a new
|
|
1267
|
-
* instance.
|
|
1268
|
-
*/
|
|
1269
|
-
export class FilterCondition {
|
|
1270
|
-
protected constructor();
|
|
1271
|
-
|
|
1272
|
-
/**
|
|
1273
|
-
* the opposite of this condition
|
|
1274
|
-
* @return FilterCondition
|
|
1275
|
-
*/
|
|
1276
|
-
not():FilterCondition;
|
|
1277
|
-
/**
|
|
1278
|
-
* a condition representing the current condition logically ANDed with the other parameters
|
|
1279
|
-
* @param filters -
|
|
1280
|
-
* @return FilterCondition
|
|
1281
|
-
*/
|
|
1282
|
-
and(...filters:FilterCondition[]):FilterCondition;
|
|
1283
|
-
/**
|
|
1284
|
-
* a condition representing the current condition logically ORed with the other parameters
|
|
1285
|
-
* @param filters -
|
|
1286
|
-
* @return FilterCondition.
|
|
1287
|
-
*/
|
|
1288
|
-
or(...filters:FilterCondition[]):FilterCondition;
|
|
1289
|
-
/**
|
|
1290
|
-
* a string suitable for debugging showing the details of this condition.
|
|
1291
|
-
* @return String.
|
|
885
|
+
* Creates a new value for use in filters based on this column. Used either as a parameter to another filter
|
|
886
|
+
* operation, or as a builder to create a filter operation.
|
|
887
|
+
* @return {@link dh.FilterValue}
|
|
1292
888
|
*/
|
|
1293
|
-
|
|
1294
|
-
get columns():Array<Column>;
|
|
889
|
+
filter():FilterValue;
|
|
1295
890
|
/**
|
|
1296
|
-
* a
|
|
1297
|
-
*
|
|
1298
|
-
*
|
|
1299
|
-
* <li><b>inRange</b>: Given three comparable values, returns true if the first is less than the second but greater
|
|
1300
|
-
* than the third</li>
|
|
1301
|
-
* <li><b>isInf</b>:Returns true if the given number is <i>infinity</i></li>
|
|
1302
|
-
* <li><b>isNaN</b>:Returns true if the given number is <i>not a number</i></li>
|
|
1303
|
-
* <li><b>isNormal</b>:Returns true if the given number <i>is not null</i>, <i>is not infinity</i>, and <i>is not
|
|
1304
|
-
* "not a number"</i></li>
|
|
1305
|
-
* <li><b>startsWith</b>:Returns true if the first string starts with the second string</li>
|
|
1306
|
-
* <li><b>endsWith</b>Returns true if the first string ends with the second string</li>
|
|
1307
|
-
* <li><b>matches</b>:Returns true if the first string argument matches the second string used as a Java regular
|
|
1308
|
-
* expression</li>
|
|
1309
|
-
* <li><b>contains</b>:Returns true if the first string argument contains the second string as a substring</li>
|
|
1310
|
-
* <li><b>in</b>:Returns true if the first string argument can be found in the second array argument.
|
|
1311
|
-
* <p>
|
|
1312
|
-
* Note that the array can only be specified as a column reference at this time - typically the `FilterValue.in`
|
|
1313
|
-
* method should be used in other cases
|
|
1314
|
-
* </p>
|
|
1315
|
-
* </li>
|
|
1316
|
-
* </ul>
|
|
1317
|
-
* @param function -
|
|
1318
|
-
* @param args -
|
|
1319
|
-
* @return dh.FilterCondition
|
|
891
|
+
* a <b>CustomColumn</b> object to apply using `applyCustomColumns` with the expression specified.
|
|
892
|
+
* @param expression -
|
|
893
|
+
* @return {@link dh.CustomColumn}
|
|
1320
894
|
*/
|
|
1321
|
-
|
|
895
|
+
formatColor(expression:string):CustomColumn;
|
|
1322
896
|
/**
|
|
1323
|
-
* a
|
|
1324
|
-
*
|
|
1325
|
-
*
|
|
1326
|
-
* number, the column will be filtered to numbers which equal, or can be "rounded" effectively to this number. On
|
|
1327
|
-
* String columns, the given value will match any column which contains this string in a case-insensitive search. An
|
|
1328
|
-
* optional second argument can be passed, an array of `FilterValue` from the columns to limit this search to (see
|
|
1329
|
-
* {@link dh.Column.filter}).
|
|
1330
|
-
* @param value -
|
|
1331
|
-
* @param columns -
|
|
1332
|
-
* @return dh.FilterCondition
|
|
897
|
+
* a <b>CustomColumn</b> object to apply using <b>applyCustomColumns</b> with the expression specified.
|
|
898
|
+
* @param expression -
|
|
899
|
+
* @return {@link dh.CustomColumn}
|
|
1333
900
|
*/
|
|
1334
|
-
|
|
1335
|
-
}
|
|
1336
|
-
|
|
1337
|
-
/**
|
|
1338
|
-
* This class allows iteration over non-contiguous indexes. In the future, this will support the EcmaScript 2015
|
|
1339
|
-
* Iteration protocol, but for now has one method which returns an iterator, and also supports querying the size.
|
|
1340
|
-
* Additionally, we may add support for creating RangeSet objects to better serve some use cases.
|
|
1341
|
-
*/
|
|
1342
|
-
export class RangeSet {
|
|
1343
|
-
protected constructor();
|
|
1344
|
-
|
|
1345
|
-
static ofRange(first:number, last:number):RangeSet;
|
|
1346
|
-
static ofItems(rows:number[]):RangeSet;
|
|
1347
|
-
static ofRanges(ranges:RangeSet[]):RangeSet;
|
|
1348
|
-
static ofSortedRanges(ranges:RangeSet[]):RangeSet;
|
|
901
|
+
formatNumber(expression:string):CustomColumn;
|
|
1349
902
|
/**
|
|
1350
|
-
* a
|
|
1351
|
-
* @
|
|
903
|
+
* a <b>CustomColumn</b> object to apply using <b>applyCustomColumns</b> with the expression specified.
|
|
904
|
+
* @param expression -
|
|
905
|
+
* @return {@link dh.CustomColumn}
|
|
1352
906
|
*/
|
|
1353
|
-
|
|
907
|
+
formatDate(expression:string):CustomColumn;
|
|
908
|
+
toString():string;
|
|
1354
909
|
/**
|
|
1355
|
-
*
|
|
1356
|
-
*
|
|
1357
|
-
* property each time through a loop).
|
|
1358
|
-
* @return double
|
|
910
|
+
* Label for this column.
|
|
911
|
+
* @return String
|
|
1359
912
|
*/
|
|
1360
|
-
get
|
|
1361
|
-
}
|
|
1362
|
-
|
|
1363
|
-
/**
|
|
1364
|
-
* Configuration object for running Table.treeTable to produce a hierarchical view of a given "flat" table.
|
|
1365
|
-
*
|
|
1366
|
-
* Like TotalsTableConfig, `TreeTableConfig` supports an operation map indicating how to aggregate the data, as well as
|
|
1367
|
-
* an array of column names which will be the layers in the roll-up tree, grouped at each level. An additional optional
|
|
1368
|
-
* value can be provided describing the strategy the engine should use when grouping the rows.
|
|
1369
|
-
*/
|
|
1370
|
-
export class TreeTableConfig {
|
|
913
|
+
get name():string;
|
|
1371
914
|
/**
|
|
1372
|
-
*
|
|
915
|
+
* True if this column is a partition column. Partition columns are used for filtering uncoalesced tables - see
|
|
916
|
+
* {@link Table.uncoalesced}.
|
|
917
|
+
* @return true if the column is a partition column
|
|
1373
918
|
*/
|
|
1374
|
-
|
|
919
|
+
get isPartitionColumn():boolean;
|
|
1375
920
|
/**
|
|
1376
|
-
*
|
|
921
|
+
*
|
|
922
|
+
* @deprecated do not use. Internal index of the column in the table, to be used as a key on the Row.
|
|
923
|
+
* @return int
|
|
1377
924
|
*/
|
|
1378
|
-
|
|
925
|
+
get index():number;
|
|
926
|
+
get isSortable():boolean;
|
|
1379
927
|
/**
|
|
1380
|
-
*
|
|
928
|
+
* Type of the row data that can be found in this column.
|
|
929
|
+
* @return String
|
|
1381
930
|
*/
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
931
|
+
get type():string;
|
|
932
|
+
/**
|
|
933
|
+
* Format entire rows colors using the expression specified. Returns a <b>CustomColumn</b> object to apply to a
|
|
934
|
+
* table using <b>applyCustomColumns</b> with the parameters specified.
|
|
935
|
+
* @param expression -
|
|
936
|
+
* @return {@link dh.CustomColumn}
|
|
937
|
+
*/
|
|
938
|
+
static formatRowColor(expression:string):CustomColumn;
|
|
939
|
+
/**
|
|
940
|
+
* a <b>CustomColumn</b> object to apply using <b>applyCustomColumns</b> with the expression specified.
|
|
941
|
+
* @param name -
|
|
942
|
+
* @param expression -
|
|
943
|
+
* @return {@link dh.CustomColumn}
|
|
944
|
+
*/
|
|
945
|
+
static createCustomColumn(name:string, expression:string):CustomColumn;
|
|
1385
946
|
}
|
|
1386
947
|
|
|
1387
948
|
/**
|
|
@@ -1556,39 +1117,122 @@ export namespace dh {
|
|
|
1556
1117
|
static ofBoolean(b:boolean):FilterValue;
|
|
1557
1118
|
}
|
|
1558
1119
|
|
|
1120
|
+
|
|
1559
1121
|
/**
|
|
1560
|
-
*
|
|
1561
|
-
*
|
|
1122
|
+
* Describes a Sort present on the table. No visible constructor, created through the use of Column.sort(), will be tied
|
|
1123
|
+
* to that particular column data. Sort instances are immutable, and use a builder pattern to make modifications. All
|
|
1124
|
+
* methods return a new Sort instance.
|
|
1562
1125
|
*/
|
|
1563
|
-
export class
|
|
1126
|
+
export class Sort {
|
|
1127
|
+
static readonly ASCENDING:string;
|
|
1128
|
+
static readonly DESCENDING:string;
|
|
1129
|
+
static readonly REVERSE:string;
|
|
1130
|
+
|
|
1131
|
+
protected constructor();
|
|
1132
|
+
|
|
1564
1133
|
/**
|
|
1565
|
-
*
|
|
1134
|
+
* Builds a Sort instance to sort values in ascending order.
|
|
1135
|
+
* @return {@link dh.Sort}
|
|
1566
1136
|
*/
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
|
|
1137
|
+
asc():Sort;
|
|
1138
|
+
/**
|
|
1139
|
+
* Builds a Sort instance to sort values in descending order.
|
|
1140
|
+
* @return {@link dh.Sort}
|
|
1141
|
+
*/
|
|
1142
|
+
desc():Sort;
|
|
1143
|
+
/**
|
|
1144
|
+
* Builds a Sort instance which takes the absolute value before applying order.
|
|
1145
|
+
* @return {@link dh.Sort}
|
|
1146
|
+
*/
|
|
1147
|
+
abs():Sort;
|
|
1148
|
+
toString():string;
|
|
1149
|
+
/**
|
|
1150
|
+
* True if the absolute value of the column should be used when sorting; defaults to false.
|
|
1151
|
+
* @return boolean
|
|
1152
|
+
*/
|
|
1153
|
+
get isAbs():boolean;
|
|
1154
|
+
/**
|
|
1155
|
+
* The column which is sorted.
|
|
1156
|
+
* @return {@link dh.Column}
|
|
1157
|
+
*/
|
|
1158
|
+
get column():Column;
|
|
1159
|
+
/**
|
|
1160
|
+
* The direction of this sort, either <b>ASC</b>, <b>DESC</b>, or <b>REVERSE</b>.
|
|
1161
|
+
* @return String
|
|
1162
|
+
*/
|
|
1163
|
+
get direction():string;
|
|
1164
|
+
}
|
|
1571
1165
|
|
|
1166
|
+
/**
|
|
1167
|
+
* Wrap BigInteger values for use in JS. Provides text formatting for display and access to the underlying value.
|
|
1168
|
+
*/
|
|
1169
|
+
export class BigIntegerWrapper {
|
|
1572
1170
|
protected constructor();
|
|
1573
1171
|
|
|
1172
|
+
static ofString(str:string):BigIntegerWrapper;
|
|
1173
|
+
asNumber():number;
|
|
1174
|
+
valueOf():string;
|
|
1175
|
+
toString():string;
|
|
1176
|
+
}
|
|
1177
|
+
|
|
1178
|
+
/**
|
|
1179
|
+
* Describes a grouping and aggregations for a roll-up table. Pass to the <b>Table.rollup</b> function to create a
|
|
1180
|
+
* roll-up table.
|
|
1181
|
+
*/
|
|
1182
|
+
export class RollupConfig {
|
|
1574
1183
|
/**
|
|
1575
|
-
*
|
|
1184
|
+
* Ordered list of columns to group by to form the hierarchy of the resulting roll-up table.
|
|
1185
|
+
*/
|
|
1186
|
+
groupingColumns:Array<String>;
|
|
1187
|
+
/**
|
|
1188
|
+
* Mapping from each aggregation name to the ordered list of columns it should be applied to in the resulting
|
|
1189
|
+
* roll-up table.
|
|
1190
|
+
*/
|
|
1191
|
+
aggregations:{ [key: string]: Array<string>; };
|
|
1192
|
+
/**
|
|
1193
|
+
* Optional parameter indicating if an extra leaf node should be added at the bottom of the hierarchy, showing the
|
|
1194
|
+
* rows in the underlying table which make up that grouping. Since these values might be a different type from the
|
|
1195
|
+
* rest of the column, any client code must check if TreeRow.hasChildren = false, and if so, interpret those values
|
|
1196
|
+
* as if they were Column.constituentType instead of Column.type. Defaults to false.
|
|
1197
|
+
*/
|
|
1198
|
+
includeConstituents:boolean;
|
|
1199
|
+
includeOriginalColumns?:boolean|null;
|
|
1200
|
+
/**
|
|
1201
|
+
* Optional parameter indicating if original column descriptions should be included. Defaults to true.
|
|
1202
|
+
*/
|
|
1203
|
+
includeDescriptions:boolean;
|
|
1204
|
+
|
|
1205
|
+
constructor();
|
|
1206
|
+
}
|
|
1207
|
+
|
|
1208
|
+
/**
|
|
1209
|
+
* This object serves as a "handle" to a subscription, allowing it to be acted on directly or canceled outright. If you
|
|
1210
|
+
* retain an instance of this, you have two choices - either only use it to call `close()` on it to stop the table's
|
|
1211
|
+
* viewport without creating a new one, or listen directly to this object instead of the table for data events, and
|
|
1212
|
+
* always call `close()` when finished. Calling any method on this object other than close() will result in it
|
|
1213
|
+
* continuing to live on after `setViewport` is called on the original table, or after the table is modified.
|
|
1214
|
+
*/
|
|
1215
|
+
export class TableViewportSubscription implements HasEventHandling {
|
|
1216
|
+
protected constructor();
|
|
1217
|
+
|
|
1218
|
+
/**
|
|
1219
|
+
* Changes the rows and columns set on this viewport. This cannot be used to change the update interval.
|
|
1220
|
+
* @param firstRow -
|
|
1221
|
+
* @param lastRow -
|
|
1222
|
+
* @param columns -
|
|
1223
|
+
* @param updateIntervalMs -
|
|
1224
|
+
*/
|
|
1225
|
+
setViewport(firstRow:number, lastRow:number, columns?:Column[]|undefined|null, updateIntervalMs?:number|undefined|null, isReverseViewport?:boolean|undefined|null):void;
|
|
1226
|
+
/**
|
|
1227
|
+
* Stops this viewport from running, stopping all events on itself and on the table that created it.
|
|
1576
1228
|
*/
|
|
1577
1229
|
close():void;
|
|
1578
|
-
running():Promise<IdeConnection>;
|
|
1579
|
-
getObject(definitionObject:dh.ide.VariableDescriptor):Promise<any>;
|
|
1580
|
-
subscribeToFieldUpdates(callback:(arg0:dh.ide.VariableChanges)=>void):()=>void;
|
|
1581
1230
|
/**
|
|
1582
|
-
*
|
|
1583
|
-
*
|
|
1584
|
-
* log messages as are presently available.
|
|
1585
|
-
* @param callback -
|
|
1586
|
-
* @return {@link io.deephaven.web.shared.fu.JsRunnable}
|
|
1231
|
+
* Gets the data currently visible in this viewport
|
|
1232
|
+
* @return Promise of {@link dh.TableData}.
|
|
1587
1233
|
*/
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
getConsoleTypes():Promise<Array<string>>;
|
|
1591
|
-
getWorkerHeapInfo():Promise<WorkerHeapInfo>;
|
|
1234
|
+
getViewportData():Promise<ViewportData>;
|
|
1235
|
+
snapshot(rows:RangeSet, columns:Column[]):Promise<TableData>;
|
|
1592
1236
|
/**
|
|
1593
1237
|
* Listen for events on this object.
|
|
1594
1238
|
* @param name - the name of the event to listen for
|
|
@@ -1609,419 +1253,499 @@ export namespace dh {
|
|
|
1609
1253
|
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
1610
1254
|
}
|
|
1611
1255
|
|
|
1612
|
-
|
|
1613
|
-
|
|
1256
|
+
/**
|
|
1257
|
+
* Configuration object for running Table.treeTable to produce a hierarchical view of a given "flat" table.
|
|
1258
|
+
*
|
|
1259
|
+
* Like TotalsTableConfig, `TreeTableConfig` supports an operation map indicating how to aggregate the data, as well as
|
|
1260
|
+
* an array of column names which will be the layers in the roll-up tree, grouped at each level. An additional optional
|
|
1261
|
+
* value can be provided describing the strategy the engine should use when grouping the rows.
|
|
1262
|
+
*/
|
|
1263
|
+
export class TreeTableConfig {
|
|
1264
|
+
/**
|
|
1265
|
+
* The column representing the unique ID for each item
|
|
1266
|
+
*/
|
|
1267
|
+
idColumn:string;
|
|
1268
|
+
/**
|
|
1269
|
+
* The column representing the parent ID for each item
|
|
1270
|
+
*/
|
|
1271
|
+
parentColumn:string;
|
|
1272
|
+
/**
|
|
1273
|
+
* Optional parameter indicating if items with an invalid parent ID should be promoted to root. Defaults to false.
|
|
1274
|
+
*/
|
|
1275
|
+
promoteOrphansToRoot:boolean;
|
|
1614
1276
|
|
|
1615
|
-
|
|
1616
|
-
asNumber():number;
|
|
1617
|
-
valueOf():string;
|
|
1618
|
-
toString():string;
|
|
1277
|
+
constructor();
|
|
1619
1278
|
}
|
|
1620
1279
|
|
|
1621
1280
|
/**
|
|
1622
|
-
*
|
|
1623
|
-
*
|
|
1624
|
-
*
|
|
1625
|
-
*
|
|
1626
|
-
*
|
|
1627
|
-
* forward data to it.
|
|
1281
|
+
* Describes how a Totals Table will be generated from its parent table. Each table has a default (which may be null)
|
|
1282
|
+
* indicating how that table was configured when it was declared, and each Totals Table has a similar property
|
|
1283
|
+
* describing how it was created. Both the <b>Table.getTotalsTable</b> and <b>Table.getGrandTotalsTable</b> methods take
|
|
1284
|
+
* this config as an optional parameter - without it, the table's default will be used, or if null, a default instance
|
|
1285
|
+
* of <b>TotalsTableConfig</b> will be supplied.
|
|
1628
1286
|
*
|
|
1629
|
-
*
|
|
1630
|
-
*
|
|
1631
|
-
*
|
|
1287
|
+
* This class has a no-arg constructor, allowing an instance to be made with the default values provided. However, any
|
|
1288
|
+
* JS object can be passed in to the methods which accept instances of this type, provided their values adhere to the
|
|
1289
|
+
* expected formats.
|
|
1632
1290
|
*/
|
|
1633
|
-
export class
|
|
1634
|
-
protected constructor();
|
|
1635
|
-
|
|
1291
|
+
export class TotalsTableConfig {
|
|
1636
1292
|
/**
|
|
1637
|
-
*
|
|
1638
|
-
|
|
1639
|
-
|
|
1293
|
+
* @deprecated
|
|
1294
|
+
*/
|
|
1295
|
+
static readonly COUNT:string;
|
|
1296
|
+
/**
|
|
1297
|
+
* @deprecated
|
|
1298
|
+
*/
|
|
1299
|
+
static readonly MIN:string;
|
|
1300
|
+
/**
|
|
1301
|
+
* @deprecated
|
|
1302
|
+
*/
|
|
1303
|
+
static readonly MAX:string;
|
|
1304
|
+
/**
|
|
1305
|
+
* @deprecated
|
|
1306
|
+
*/
|
|
1307
|
+
static readonly SUM:string;
|
|
1308
|
+
/**
|
|
1309
|
+
* @deprecated
|
|
1310
|
+
*/
|
|
1311
|
+
static readonly ABS_SUM:string;
|
|
1312
|
+
/**
|
|
1313
|
+
* @deprecated
|
|
1640
1314
|
*/
|
|
1641
|
-
|
|
1642
|
-
get columns():Array<Column>;
|
|
1315
|
+
static readonly VAR:string;
|
|
1643
1316
|
/**
|
|
1644
|
-
*
|
|
1645
|
-
* @param name - the name of the event to listen for
|
|
1646
|
-
* @param callback - a function to call when the event occurs
|
|
1647
|
-
* @return Returns a cleanup function.
|
|
1648
|
-
* @typeParam T - the type of the data that the event will provide
|
|
1317
|
+
* @deprecated
|
|
1649
1318
|
*/
|
|
1650
|
-
|
|
1651
|
-
nextEvent<T>(eventName:string, timeoutInMillis?:number):Promise<Event<T>>;
|
|
1652
|
-
hasListeners(name:string):boolean;
|
|
1319
|
+
static readonly AVG:string;
|
|
1653
1320
|
/**
|
|
1654
|
-
*
|
|
1655
|
-
* @param name -
|
|
1656
|
-
* @param callback -
|
|
1657
|
-
* @return
|
|
1658
|
-
* @typeParam T -
|
|
1321
|
+
* @deprecated
|
|
1659
1322
|
*/
|
|
1660
|
-
|
|
1661
|
-
}
|
|
1662
|
-
|
|
1663
|
-
export class CustomColumn {
|
|
1664
|
-
static readonly TYPE_FORMAT_COLOR:string;
|
|
1665
|
-
static readonly TYPE_FORMAT_NUMBER:string;
|
|
1666
|
-
static readonly TYPE_FORMAT_DATE:string;
|
|
1667
|
-
static readonly TYPE_NEW:string;
|
|
1668
|
-
|
|
1669
|
-
protected constructor();
|
|
1670
|
-
|
|
1671
|
-
valueOf():string;
|
|
1672
|
-
toString():string;
|
|
1323
|
+
static readonly STD:string;
|
|
1673
1324
|
/**
|
|
1674
|
-
*
|
|
1675
|
-
* @return String
|
|
1325
|
+
* @deprecated
|
|
1676
1326
|
*/
|
|
1677
|
-
|
|
1327
|
+
static readonly FIRST:string;
|
|
1678
1328
|
/**
|
|
1679
|
-
*
|
|
1680
|
-
* @return String
|
|
1329
|
+
* @deprecated
|
|
1681
1330
|
*/
|
|
1682
|
-
|
|
1331
|
+
static readonly LAST:string;
|
|
1683
1332
|
/**
|
|
1684
|
-
*
|
|
1685
|
-
*
|
|
1686
|
-
* <ul>
|
|
1687
|
-
* <li>FORMAT_COLOR</li>
|
|
1688
|
-
* <li>FORMAT_NUMBER</li>
|
|
1689
|
-
* <li>FORMAT_DATE</li>
|
|
1690
|
-
* <li>NEW</li>
|
|
1691
|
-
* </ul>
|
|
1692
|
-
* @return String
|
|
1333
|
+
* @deprecated
|
|
1693
1334
|
*/
|
|
1694
|
-
|
|
1695
|
-
}
|
|
1696
|
-
|
|
1697
|
-
/**
|
|
1698
|
-
* Provides access to data in a table. Note that several methods present their response through Promises. This allows
|
|
1699
|
-
* the client to both avoid actually connecting to the server until necessary, and also will permit some changes not to
|
|
1700
|
-
* inform the UI right away that they have taken place.
|
|
1701
|
-
*/
|
|
1702
|
-
export class Table implements JoinableTable, HasEventHandling {
|
|
1703
|
-
readonly description?:string|null;
|
|
1704
|
-
readonly pluginName?:string|null;
|
|
1705
|
-
readonly layoutHints?:null|LayoutHints;
|
|
1335
|
+
static readonly SKIP:string;
|
|
1706
1336
|
/**
|
|
1707
|
-
*
|
|
1337
|
+
* Specifies if a Totals Table should be expanded by default in the UI. Defaults to false.
|
|
1708
1338
|
*/
|
|
1709
|
-
|
|
1339
|
+
showTotalsByDefault:boolean;
|
|
1710
1340
|
/**
|
|
1711
|
-
*
|
|
1341
|
+
* Specifies if a Grand Totals Table should be expanded by default in the UI. Defaults to false.
|
|
1712
1342
|
*/
|
|
1713
|
-
|
|
1343
|
+
showGrandTotalsByDefault:boolean;
|
|
1714
1344
|
/**
|
|
1715
|
-
*
|
|
1345
|
+
* Specifies the default operation for columns that do not have a specific operation applied; defaults to "Sum".
|
|
1716
1346
|
*/
|
|
1717
|
-
|
|
1347
|
+
defaultOperation:AggregationOperationType;
|
|
1718
1348
|
/**
|
|
1719
|
-
*
|
|
1349
|
+
* Mapping from each column name to the aggregation(s) that should be applied to that column in the resulting Totals
|
|
1350
|
+
* Table. If a column is omitted, the defaultOperation is used.
|
|
1720
1351
|
*/
|
|
1721
|
-
|
|
1352
|
+
operationMap:{ [key: string]: Array<AggregationOperationType>; };
|
|
1722
1353
|
/**
|
|
1723
|
-
*
|
|
1354
|
+
* Groupings to use when generating the Totals Table. One row will exist for each unique set of values observed in
|
|
1355
|
+
* these columns. See also `Table.selectDistinct`.
|
|
1724
1356
|
*/
|
|
1725
|
-
|
|
1357
|
+
groupBy:Array<string>;
|
|
1358
|
+
|
|
1359
|
+
constructor();
|
|
1360
|
+
|
|
1361
|
+
toString():string;
|
|
1362
|
+
}
|
|
1363
|
+
|
|
1364
|
+
/**
|
|
1365
|
+
* Deprecated for use in Deephaven Core.
|
|
1366
|
+
* @deprecated
|
|
1367
|
+
*/
|
|
1368
|
+
export class Client {
|
|
1369
|
+
static readonly EVENT_REQUEST_FAILED:string;
|
|
1370
|
+
static readonly EVENT_REQUEST_STARTED:string;
|
|
1371
|
+
static readonly EVENT_REQUEST_SUCCEEDED:string;
|
|
1372
|
+
|
|
1373
|
+
constructor();
|
|
1374
|
+
}
|
|
1375
|
+
|
|
1376
|
+
/**
|
|
1377
|
+
* Exists to keep the dh.TableMap namespace so that the web UI can remain compatible with the DHE API, which still calls
|
|
1378
|
+
* this type TableMap.
|
|
1379
|
+
* @deprecated
|
|
1380
|
+
*/
|
|
1381
|
+
export class TableMap {
|
|
1382
|
+
static readonly EVENT_KEYADDED:string;
|
|
1383
|
+
static readonly EVENT_DISCONNECT:string;
|
|
1384
|
+
static readonly EVENT_RECONNECT:string;
|
|
1385
|
+
static readonly EVENT_RECONNECTFAILED:string;
|
|
1386
|
+
|
|
1387
|
+
protected constructor();
|
|
1388
|
+
}
|
|
1389
|
+
|
|
1390
|
+
/**
|
|
1391
|
+
* This class allows iteration over non-contiguous indexes. In the future, this will support the EcmaScript 2015
|
|
1392
|
+
* Iteration protocol, but for now has one method which returns an iterator, and also supports querying the size.
|
|
1393
|
+
* Additionally, we may add support for creating RangeSet objects to better serve some use cases.
|
|
1394
|
+
*/
|
|
1395
|
+
export class RangeSet {
|
|
1396
|
+
protected constructor();
|
|
1397
|
+
|
|
1398
|
+
static ofRange(first:number, last:number):RangeSet;
|
|
1399
|
+
static ofItems(rows:number[]):RangeSet;
|
|
1400
|
+
static ofRanges(ranges:RangeSet[]):RangeSet;
|
|
1401
|
+
static ofSortedRanges(ranges:RangeSet[]):RangeSet;
|
|
1726
1402
|
/**
|
|
1727
|
-
*
|
|
1403
|
+
* a new iterator over all indexes in this collection.
|
|
1404
|
+
* @return Iterator of {@link dh.LongWrapper}
|
|
1728
1405
|
*/
|
|
1729
|
-
|
|
1406
|
+
iterator():Iterator<LongWrapper>;
|
|
1730
1407
|
/**
|
|
1731
|
-
* The
|
|
1408
|
+
* The total count of items contained in this collection. In some cases this can be expensive to compute, and
|
|
1409
|
+
* generally should not be needed except for debugging purposes, or preallocating space (i.e., do not call this
|
|
1410
|
+
* property each time through a loop).
|
|
1411
|
+
* @return double
|
|
1732
1412
|
*/
|
|
1733
|
-
|
|
1413
|
+
get size():number;
|
|
1414
|
+
}
|
|
1415
|
+
|
|
1416
|
+
/**
|
|
1417
|
+
* Behaves like a {@link dh.Table} externally, but data, state, and viewports are managed by an entirely different
|
|
1418
|
+
* mechanism, and so reimplemented here.
|
|
1419
|
+
* <p>
|
|
1420
|
+
* Any time a change is made, we build a new request and send it to the server, and wait for the updated state.
|
|
1421
|
+
* <p>
|
|
1422
|
+
* Semantics around getting updates from the server are slightly different - we don't "unset" the viewport here after
|
|
1423
|
+
* operations are performed, but encourage the client code to re-set them to the desired position.
|
|
1424
|
+
* <p>
|
|
1425
|
+
* The table size will be -1 until a viewport has been fetched.
|
|
1426
|
+
* <p>
|
|
1427
|
+
* Similar to a table, a Tree Table provides access to subscribed viewport data on the current hierarchy. A different
|
|
1428
|
+
* Row type is used within that viewport, showing the depth of that node within the tree and indicating details about
|
|
1429
|
+
* whether it has children or is expanded. The Tree Table itself then provides the ability to change if a row is
|
|
1430
|
+
* expanded or not. Methods used to control or check if a row should be expanded or not can be invoked on a TreeRow
|
|
1431
|
+
* instance, or on the number of the row (thus allowing for expanding/collapsing rows which are not currently visible in
|
|
1432
|
+
* the viewport).
|
|
1433
|
+
* <p>
|
|
1434
|
+
* Events and viewports are somewhat different from tables, due to the expense of computing the expanded/collapsed rows
|
|
1435
|
+
* and count of children at each level of the hierarchy, and differences in the data that is available.
|
|
1436
|
+
* <p>
|
|
1437
|
+
* <ul>
|
|
1438
|
+
* <li>There is no {@link Table.totalSize | totalSize} property.</li>
|
|
1439
|
+
* <li>The viewport is not un-set when changes are made to filter or sort, but changes will continue to be streamed in.
|
|
1440
|
+
* It is suggested that the viewport be changed to the desired position (usually the first N rows) after any filter/sort
|
|
1441
|
+
* change is made. Likewise, {@link getViewportData} will always return the most recent data, and will not wait if a
|
|
1442
|
+
* new operation is pending.</li>
|
|
1443
|
+
* <li>Custom columns are not directly supported. If the TreeTable was created client-side, the original Table can have
|
|
1444
|
+
* custom columns applied, and the TreeTable can be recreated.</li>
|
|
1445
|
+
* <li>Whereas Table has a {@link Table.totalsTableConfig} property, it is defined here as a method,
|
|
1446
|
+
* {@link getTotalsTableConfig}. This returns a promise so the config can be fetched asynchronously.</li>
|
|
1447
|
+
* <li>Totals Tables for trees vary in behavior between tree tables and roll-up tables. This behavior is based on the
|
|
1448
|
+
* original flat table used to produce the Tree Table - for a hierarchical table (i.e. Table.treeTable in the query
|
|
1449
|
+
* config), the totals will include non-leaf nodes (since they are themselves actual rows in the table), but in a
|
|
1450
|
+
* roll-up table, the totals only include leaf nodes (as non-leaf nodes are generated through grouping the contents of
|
|
1451
|
+
* the original table). Roll-ups also have the {@link dh.includeConstituents} property, indicating that a
|
|
1452
|
+
* {@link dh.Column} in the tree may have a {@link Column.constituentType} property reflecting that the type of cells
|
|
1453
|
+
* where {@link TreeRowImpl.hasChildren} is false will be different from usual.</li>
|
|
1454
|
+
* </ul>
|
|
1455
|
+
*/
|
|
1456
|
+
export class TreeTable implements HasEventHandling {
|
|
1734
1457
|
/**
|
|
1735
|
-
*
|
|
1458
|
+
* event.detail is the currently visible viewport data based on the active viewport configuration.
|
|
1736
1459
|
*/
|
|
1737
|
-
static readonly
|
|
1460
|
+
static readonly EVENT_UPDATED:string;
|
|
1738
1461
|
/**
|
|
1739
|
-
*
|
|
1462
|
+
* event.detail is the currently visible viewport data based on the active viewport configuration.
|
|
1740
1463
|
*/
|
|
1741
1464
|
static readonly EVENT_DISCONNECT:string;
|
|
1742
1465
|
/**
|
|
1743
|
-
*
|
|
1466
|
+
* event.detail is the currently visible viewport data based on the active viewport configuration.
|
|
1744
1467
|
*/
|
|
1745
1468
|
static readonly EVENT_RECONNECT:string;
|
|
1746
1469
|
/**
|
|
1747
|
-
*
|
|
1470
|
+
* event.detail is the currently visible viewport data based on the active viewport configuration.
|
|
1748
1471
|
*/
|
|
1749
1472
|
static readonly EVENT_RECONNECTFAILED:string;
|
|
1750
1473
|
/**
|
|
1751
|
-
*
|
|
1474
|
+
* event.detail is the currently visible viewport data based on the active viewport configuration.
|
|
1752
1475
|
*/
|
|
1753
1476
|
static readonly EVENT_REQUEST_FAILED:string;
|
|
1754
|
-
|
|
1755
|
-
|
|
1756
|
-
*/
|
|
1757
|
-
static readonly EVENT_REQUEST_SUCCEEDED:string;
|
|
1758
|
-
/**
|
|
1759
|
-
* The size the table will have if it is uncoalesced.
|
|
1760
|
-
*/
|
|
1761
|
-
static readonly SIZE_UNCOALESCED:number;
|
|
1477
|
+
readonly description?:string|null;
|
|
1478
|
+
readonly layoutHints?:null|LayoutHints;
|
|
1762
1479
|
|
|
1763
1480
|
protected constructor();
|
|
1764
1481
|
|
|
1765
|
-
batch(userCode:(arg0:unknown)=>void):Promise<Table>;
|
|
1766
1482
|
/**
|
|
1767
|
-
*
|
|
1768
|
-
*
|
|
1769
|
-
*
|
|
1770
|
-
*
|
|
1483
|
+
* Expands the given node, so that its children are visible when they are in the viewport. The parameter can be the
|
|
1484
|
+
* row index, or the row object itself. The second parameter is a boolean value, false by default, specifying if the
|
|
1485
|
+
* row and all descendants should be fully expanded. Equivalent to `setExpanded(row, true)` with an optional third
|
|
1486
|
+
* boolean parameter.
|
|
1487
|
+
* @param row -
|
|
1488
|
+
* @param expandDescendants -
|
|
1771
1489
|
*/
|
|
1772
|
-
|
|
1490
|
+
expand(row:TreeRow|number, expandDescendants?:boolean):void;
|
|
1773
1491
|
/**
|
|
1774
|
-
*
|
|
1775
|
-
*
|
|
1776
|
-
* @
|
|
1492
|
+
* Collapses the given node, so that its children and descendants are not visible in the size or the viewport. The
|
|
1493
|
+
* parameter can be the row index, or the row object itself. Equivalent to <b>setExpanded(row, false, false)</b>.
|
|
1494
|
+
* @param row -
|
|
1777
1495
|
*/
|
|
1778
|
-
|
|
1779
|
-
isBlinkTable():boolean;
|
|
1496
|
+
collapse(row:TreeRow|number):void;
|
|
1780
1497
|
/**
|
|
1781
|
-
*
|
|
1782
|
-
*
|
|
1783
|
-
*
|
|
1498
|
+
* Specifies if the given node should be expanded or collapsed. If this node has children, and the value is changed,
|
|
1499
|
+
* the size of the table will change. If node is to be expanded and the third parameter, <b>expandDescendants</b>,
|
|
1500
|
+
* is true, then its children will also be expanded.
|
|
1501
|
+
* @param row - the row to expand or collapse, either the absolute row index or the row object
|
|
1502
|
+
* @param isExpanded - true to expand the row, false to collapse
|
|
1503
|
+
* @param expandDescendants - true to expand the row and all descendants, false to expand only the row, defaults to
|
|
1504
|
+
* false
|
|
1784
1505
|
*/
|
|
1785
|
-
|
|
1506
|
+
setExpanded(row:TreeRow|number, isExpanded:boolean, expandDescendants?:boolean):void;
|
|
1507
|
+
expandAll():void;
|
|
1508
|
+
collapseAll():void;
|
|
1786
1509
|
/**
|
|
1787
|
-
*
|
|
1510
|
+
* Tests if the specified row is expanded.
|
|
1511
|
+
* @param row - the row to test, either the absolute row index or the row object
|
|
1512
|
+
* @return boolean true if the row is expanded, false otherwise
|
|
1788
1513
|
*/
|
|
1789
|
-
|
|
1790
|
-
|
|
1514
|
+
isExpanded(row:TreeRow|number):boolean;
|
|
1515
|
+
setViewport(firstRow:number, lastRow:number, columns?:Array<Column>|undefined|null, updateInterval?:number|undefined|null):void;
|
|
1516
|
+
getViewportData():Promise<TreeViewportData>;
|
|
1791
1517
|
/**
|
|
1792
|
-
*
|
|
1793
|
-
* <Table>``` that will either resolve with a table or error out if the object can't be passed to JS.
|
|
1794
|
-
* @param attributeName -
|
|
1795
|
-
* @return Object
|
|
1518
|
+
* Indicates that the table will no longer be used, and server resources can be freed.
|
|
1796
1519
|
*/
|
|
1797
|
-
|
|
1520
|
+
close():void;
|
|
1798
1521
|
/**
|
|
1799
|
-
*
|
|
1800
|
-
* immediately return the new value, but you may receive update events using the old sort before the new sort is
|
|
1801
|
-
* applied, and the <b>sortchanged</b> event fires. Reusing existing, applied sorts may enable this to perform
|
|
1802
|
-
* better on the server. The <b>updated</b> event will also fire, but <b>rowadded</b> and <b>rowremoved</b> will
|
|
1803
|
-
* not.
|
|
1522
|
+
* Applies the given sort to all levels of the tree. Returns the previous sort in use.
|
|
1804
1523
|
* @param sort -
|
|
1805
1524
|
* @return {@link dh.Sort} array
|
|
1806
1525
|
*/
|
|
1807
1526
|
applySort(sort:Sort[]):Array<Sort>;
|
|
1808
1527
|
/**
|
|
1809
|
-
*
|
|
1810
|
-
* will
|
|
1811
|
-
*
|
|
1812
|
-
* perform better on the server. The <b>updated</b> event will also fire, but <b>rowadded</b> and <b>rowremoved</b>
|
|
1813
|
-
* will not.
|
|
1528
|
+
* Applies the given filter to the contents of the tree in such a way that if any node is visible, then any parent
|
|
1529
|
+
* node will be visible as well even if that parent node would not normally be visible due to the filter's
|
|
1530
|
+
* condition. Returns the previous sort in use.
|
|
1814
1531
|
* @param filter -
|
|
1815
1532
|
* @return {@link dh.FilterCondition} array
|
|
1816
1533
|
*/
|
|
1817
1534
|
applyFilter(filter:FilterCondition[]):Array<FilterCondition>;
|
|
1818
1535
|
/**
|
|
1819
|
-
*
|
|
1820
|
-
* @param
|
|
1821
|
-
* @return {@link dh.
|
|
1536
|
+
* a column with the given name, or throws an exception if it cannot be found
|
|
1537
|
+
* @param key -
|
|
1538
|
+
* @return {@link dh.Column}
|
|
1822
1539
|
*/
|
|
1823
|
-
|
|
1540
|
+
findColumn(key:string):Column;
|
|
1824
1541
|
/**
|
|
1825
|
-
*
|
|
1826
|
-
*
|
|
1827
|
-
*
|
|
1828
|
-
* <b>rowadded</b> event per row in that range. The returned object allows the viewport to be closed when no longer
|
|
1829
|
-
* needed.
|
|
1830
|
-
* @param firstRow -
|
|
1831
|
-
* @param lastRow -
|
|
1832
|
-
* @param columns -
|
|
1833
|
-
* @param updateIntervalMs -
|
|
1834
|
-
* @return {@link dh.TableViewportSubscription}
|
|
1542
|
+
* an array with all of the named columns in order, or throws an exception if one cannot be found.
|
|
1543
|
+
* @param keys -
|
|
1544
|
+
* @return {@link dh.Column} array
|
|
1835
1545
|
*/
|
|
1836
|
-
|
|
1546
|
+
findColumns(keys:string[]):Column[];
|
|
1837
1547
|
/**
|
|
1838
|
-
*
|
|
1839
|
-
*
|
|
1840
|
-
*
|
|
1841
|
-
*
|
|
1842
|
-
*
|
|
1548
|
+
* Provides Table-like selectDistinct functionality, but with a few quirks, since it is only fetching the distinct
|
|
1549
|
+
* values for the given columns in the source table:
|
|
1550
|
+
* <ul>
|
|
1551
|
+
* <li>Rollups may make no sense, since values are aggregated.</li>
|
|
1552
|
+
* <li>Values found on orphaned (and removed) nodes will show up in the resulting table, even though they are not in
|
|
1553
|
+
* the tree.</li>
|
|
1554
|
+
* <li>Values found on parent nodes which are only present in the tree since a child is visible will not be present
|
|
1555
|
+
* in the resulting table.</li>
|
|
1556
|
+
* </ul>
|
|
1843
1557
|
*/
|
|
1844
|
-
|
|
1558
|
+
selectDistinct(columns:Column[]):Promise<Table>;
|
|
1559
|
+
getTotalsTableConfig():Promise<TotalsTableConfig>;
|
|
1560
|
+
getTotalsTable(config?:object):Promise<TotalsTable>;
|
|
1561
|
+
getGrandTotalsTable(config?:object):Promise<TotalsTable>;
|
|
1845
1562
|
/**
|
|
1846
|
-
*
|
|
1847
|
-
*
|
|
1848
|
-
*
|
|
1849
|
-
*
|
|
1850
|
-
*
|
|
1851
|
-
* called on it to stop it, and all events are fired from the TableSubscription instance.
|
|
1852
|
-
* @param columns -
|
|
1853
|
-
* @param updateIntervalMs -
|
|
1854
|
-
* @return {@link dh.TableSubscription}
|
|
1563
|
+
* a new copy of this treetable, so it can be sorted and filtered separately, and maintain a different viewport.
|
|
1564
|
+
* Unlike Table, this will _not_ copy the filter or sort, since tree table viewport semantics differ, and without a
|
|
1565
|
+
* viewport set, the treetable doesn't evaluate these settings, and they aren't readable on the properties. Expanded
|
|
1566
|
+
* state is also not copied.
|
|
1567
|
+
* @return Promise of dh.TreeTable
|
|
1855
1568
|
*/
|
|
1856
|
-
|
|
1569
|
+
copy():Promise<TreeTable>;
|
|
1857
1570
|
/**
|
|
1858
|
-
*
|
|
1859
|
-
*
|
|
1860
|
-
* order of appearance of values from the original table.
|
|
1861
|
-
* @param columns -
|
|
1862
|
-
* @return Promise of dh.Table
|
|
1571
|
+
* The current filter configuration of this Tree Table.
|
|
1572
|
+
* @return {@link dh.FilterCondition} array
|
|
1863
1573
|
*/
|
|
1864
|
-
|
|
1574
|
+
get filter():Array<FilterCondition>;
|
|
1865
1575
|
/**
|
|
1866
|
-
*
|
|
1867
|
-
* @return
|
|
1576
|
+
* True if this is a roll-up and will provide the original rows that make up each grouping.
|
|
1577
|
+
* @return boolean
|
|
1868
1578
|
*/
|
|
1869
|
-
|
|
1579
|
+
get includeConstituents():boolean;
|
|
1580
|
+
get groupedColumns():Array<Column>;
|
|
1870
1581
|
/**
|
|
1871
|
-
*
|
|
1872
|
-
*
|
|
1873
|
-
* necessary. Note that multiple calls to this method will each produce a new TotalsTable which must have close()
|
|
1874
|
-
* called on it when not in use.
|
|
1875
|
-
* @param config -
|
|
1876
|
-
* @return Promise of dh.TotalsTable
|
|
1582
|
+
* True if this table has been closed.
|
|
1583
|
+
* @return boolean
|
|
1877
1584
|
*/
|
|
1878
|
-
|
|
1585
|
+
get isClosed():boolean;
|
|
1879
1586
|
/**
|
|
1880
|
-
*
|
|
1881
|
-
*
|
|
1882
|
-
*
|
|
1883
|
-
* @return
|
|
1587
|
+
* The current number of rows given the table's contents and the various expand/collapse states of each node. (No
|
|
1588
|
+
* totalSize is provided at this time; its definition becomes unclear between roll-up and tree tables, especially
|
|
1589
|
+
* when considering collapse/expand states).
|
|
1590
|
+
* @return double
|
|
1884
1591
|
*/
|
|
1885
|
-
|
|
1592
|
+
get size():number;
|
|
1886
1593
|
/**
|
|
1887
|
-
*
|
|
1888
|
-
*
|
|
1889
|
-
* @param configObject -
|
|
1890
|
-
* @return Promise of dh.TreeTable
|
|
1594
|
+
* The columns that can be shown in this Tree Table.
|
|
1595
|
+
* @return {@link dh.Column} array
|
|
1891
1596
|
*/
|
|
1892
|
-
|
|
1597
|
+
get columns():Array<Column>;
|
|
1893
1598
|
/**
|
|
1894
|
-
*
|
|
1895
|
-
*
|
|
1896
|
-
* @param configObject -
|
|
1897
|
-
* @return Promise dh.TreeTable
|
|
1599
|
+
* The current sort configuration of this Tree Table
|
|
1600
|
+
* @return {@link dh.Sort} array.
|
|
1898
1601
|
*/
|
|
1899
|
-
|
|
1602
|
+
get sort():Array<Sort>;
|
|
1900
1603
|
/**
|
|
1901
|
-
*
|
|
1902
|
-
*
|
|
1903
|
-
*
|
|
1904
|
-
* @return Promise of dh.Table
|
|
1604
|
+
* True if this table may receive updates from the server, including size changed events, updated events after
|
|
1605
|
+
* initial snapshot.
|
|
1606
|
+
* @return boolean
|
|
1905
1607
|
*/
|
|
1906
|
-
|
|
1907
|
-
snapshot(baseTable:Table, doInitialSnapshot?:boolean, stampColumns?:string[]):Promise<Table>;
|
|
1608
|
+
get isRefreshing():boolean;
|
|
1908
1609
|
/**
|
|
1909
|
-
*
|
|
1910
|
-
* @
|
|
1911
|
-
* @
|
|
1610
|
+
* Listen for events on this object.
|
|
1611
|
+
* @param name - the name of the event to listen for
|
|
1612
|
+
* @param callback - a function to call when the event occurs
|
|
1613
|
+
* @return Returns a cleanup function.
|
|
1614
|
+
* @typeParam T - the type of the data that the event will provide
|
|
1912
1615
|
*/
|
|
1913
|
-
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
exactJoin(rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>):Promise<Table>;
|
|
1917
|
-
naturalJoin(rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>):Promise<Table>;
|
|
1918
|
-
byExternal(keys:object, dropKeys?:boolean):Promise<PartitionedTable>;
|
|
1616
|
+
addEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):()=>void;
|
|
1617
|
+
nextEvent<T>(eventName:string, timeoutInMillis?:number):Promise<Event<T>>;
|
|
1618
|
+
hasListeners(name:string):boolean;
|
|
1919
1619
|
/**
|
|
1920
|
-
*
|
|
1921
|
-
*
|
|
1922
|
-
* @param
|
|
1923
|
-
* @
|
|
1924
|
-
* @
|
|
1620
|
+
* Removes an event listener added to this table.
|
|
1621
|
+
* @param name -
|
|
1622
|
+
* @param callback -
|
|
1623
|
+
* @return
|
|
1624
|
+
* @typeParam T -
|
|
1925
1625
|
*/
|
|
1926
|
-
|
|
1626
|
+
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
1627
|
+
}
|
|
1628
|
+
|
|
1629
|
+
/**
|
|
1630
|
+
* A js type for operating on input tables.
|
|
1631
|
+
*
|
|
1632
|
+
* Represents a User Input Table, which can have data added to it from other sources.
|
|
1633
|
+
*
|
|
1634
|
+
* You may add rows using dictionaries of key-value tuples (representing columns by name), add tables containing all the
|
|
1635
|
+
* key/value columns to add, or delete tables containing the keys to delete. Each operation is atomic, and will either
|
|
1636
|
+
* succeed completely or fail completely. To guarantee order of operations, apply an operation and wait for the response
|
|
1637
|
+
* before sending the next operation.
|
|
1638
|
+
*
|
|
1639
|
+
* Each table has one or more key columns, where each unique combination of keys will appear at most once in the table.
|
|
1640
|
+
*
|
|
1641
|
+
* To view the results of the Input Table, you should use standard table operations on the InputTable's source Table
|
|
1642
|
+
* object.
|
|
1643
|
+
*/
|
|
1644
|
+
export class InputTable {
|
|
1645
|
+
protected constructor();
|
|
1646
|
+
|
|
1927
1647
|
/**
|
|
1928
|
-
* a
|
|
1929
|
-
*
|
|
1930
|
-
* @
|
|
1648
|
+
* Adds a single row to the table. For each key or value column name in the Input Table, we retrieve that javascript
|
|
1649
|
+
* property at that name and validate it can be put into the given column type.
|
|
1650
|
+
* @param row -
|
|
1651
|
+
* @param userTimeZone -
|
|
1652
|
+
* @return Promise of dh.InputTable
|
|
1931
1653
|
*/
|
|
1932
|
-
|
|
1654
|
+
addRow(row:{ [key: string]: any; }, userTimeZone?:string):Promise<InputTable>;
|
|
1933
1655
|
/**
|
|
1934
|
-
*
|
|
1935
|
-
* @param
|
|
1936
|
-
* @param
|
|
1937
|
-
* @
|
|
1938
|
-
* @param seekValue - Value to seek
|
|
1939
|
-
* @param insensitive - Optional value to flag a search as case-insensitive. Defaults to `false`.
|
|
1940
|
-
* @param contains - Optional value to have the seek value do a contains search instead of exact equality. Defaults to
|
|
1941
|
-
* `false`.
|
|
1942
|
-
* @param isBackwards - Optional value to seek backwards through the table instead of forwards. Defaults to `false`.
|
|
1943
|
-
* @return A promise that resolves to the row value found.
|
|
1656
|
+
* Add multiple rows to a table.
|
|
1657
|
+
* @param rows -
|
|
1658
|
+
* @param userTimeZone -
|
|
1659
|
+
* @return Promise of dh.InputTable
|
|
1944
1660
|
*/
|
|
1945
|
-
|
|
1946
|
-
toString():string;
|
|
1661
|
+
addRows(rows:{ [key: string]: any; }[], userTimeZone?:string):Promise<InputTable>;
|
|
1947
1662
|
/**
|
|
1948
|
-
*
|
|
1949
|
-
* .
|
|
1950
|
-
*
|
|
1663
|
+
* Add an entire table to this Input Table. Only column names that match the definition of the input table will be
|
|
1664
|
+
* copied, and all key columns must have values filled in. This only copies the current state of the source table;
|
|
1665
|
+
* future updates to the source table will not be reflected in the Input Table. The returned promise will be
|
|
1666
|
+
* resolved to the same InputTable instance this method was called upon once the server returns.
|
|
1667
|
+
* @param tableToAdd -
|
|
1668
|
+
* @return Promise of dh.InputTable
|
|
1951
1669
|
*/
|
|
1952
|
-
|
|
1670
|
+
addTable(tableToAdd:Table):Promise<InputTable>;
|
|
1953
1671
|
/**
|
|
1954
|
-
*
|
|
1955
|
-
*
|
|
1956
|
-
*
|
|
1957
|
-
* in exceptional cases (eg. the table is uncoalesced, see the <b>isUncoalesced</b> property for details).
|
|
1958
|
-
* @return {@link dh.Column} array
|
|
1672
|
+
* Add multiple tables to this Input Table.
|
|
1673
|
+
* @param tablesToAdd -
|
|
1674
|
+
* @return Promise of dh.InputTable
|
|
1959
1675
|
*/
|
|
1960
|
-
|
|
1676
|
+
addTables(tablesToAdd:Table[]):Promise<InputTable>;
|
|
1961
1677
|
/**
|
|
1962
|
-
*
|
|
1963
|
-
* @
|
|
1678
|
+
* Deletes an entire table from this Input Table. Key columns must match the Input Table.
|
|
1679
|
+
* @param tableToDelete -
|
|
1680
|
+
* @return Promise of dh.InputTable
|
|
1964
1681
|
*/
|
|
1965
|
-
|
|
1682
|
+
deleteTable(tableToDelete:Table):Promise<InputTable>;
|
|
1966
1683
|
/**
|
|
1967
|
-
*
|
|
1968
|
-
*
|
|
1969
|
-
*
|
|
1970
|
-
|
|
1684
|
+
* Delete multiple tables from this Input Table.
|
|
1685
|
+
* @param tablesToDelete -
|
|
1686
|
+
* @return
|
|
1687
|
+
*/
|
|
1688
|
+
deleteTables(tablesToDelete:Table[]):Promise<InputTable>;
|
|
1689
|
+
/**
|
|
1690
|
+
* A list of the key columns, by name
|
|
1691
|
+
* @return String array.
|
|
1971
1692
|
*/
|
|
1972
|
-
get
|
|
1693
|
+
get keys():string[];
|
|
1973
1694
|
/**
|
|
1974
|
-
*
|
|
1975
|
-
*
|
|
1976
|
-
* @return {@link dh.CustomColumn} array
|
|
1695
|
+
* A list of the value columns, by name
|
|
1696
|
+
* @return String array.
|
|
1977
1697
|
*/
|
|
1978
|
-
get
|
|
1698
|
+
get values():string[];
|
|
1979
1699
|
/**
|
|
1980
|
-
*
|
|
1981
|
-
*
|
|
1982
|
-
* @return boolean
|
|
1700
|
+
* A list of the key columns.
|
|
1701
|
+
* @return Column array.
|
|
1983
1702
|
*/
|
|
1984
|
-
get
|
|
1703
|
+
get keyColumns():Column[];
|
|
1985
1704
|
/**
|
|
1986
|
-
*
|
|
1987
|
-
* return
|
|
1988
|
-
* for the <b>filterchanged</b> event to know when to update the UI.
|
|
1989
|
-
* @return {@link dh.FilterCondition} array
|
|
1705
|
+
* A list of the value Column objects
|
|
1706
|
+
* @return {@link dh.Column} array.
|
|
1990
1707
|
*/
|
|
1991
|
-
get
|
|
1708
|
+
get valueColumns():Column[];
|
|
1992
1709
|
/**
|
|
1993
|
-
* The
|
|
1994
|
-
*
|
|
1995
|
-
* If this table was uncoalesced before it was filtered, this will return {@link dh.Table.SIZE_UNCOALESCED}.
|
|
1996
|
-
* @return the size of the table before filters, or {@link dh.Table.SIZE_UNCOALESCED}
|
|
1710
|
+
* The source table for this Input Table
|
|
1711
|
+
* @return dh.table
|
|
1997
1712
|
*/
|
|
1998
|
-
get
|
|
1713
|
+
get table():Table;
|
|
1714
|
+
}
|
|
1715
|
+
|
|
1716
|
+
/**
|
|
1717
|
+
* Presently, this is the entrypoint into the Deephaven JS API. By creating an instance of this with the server URL and
|
|
1718
|
+
* some options, JS applications can run code on the server, and interact with available exportable objects.
|
|
1719
|
+
*/
|
|
1720
|
+
export class IdeConnection implements HasEventHandling {
|
|
1999
1721
|
/**
|
|
2000
|
-
*
|
|
2001
|
-
* the subscription updates. If not, and {@link Table.uncoalesced} is true, the size will be
|
|
2002
|
-
* {@link dh.Table.SIZE_UNCOALESCED}. Otherwise, the size will be updated when the server's update graph processes changes.
|
|
2003
|
-
* <p>
|
|
2004
|
-
* When the size changes, the {@link dh.Table.EVENT_SIZECHANGED} event will be fired.
|
|
2005
|
-
* @return the size of the table, or {@link dh.Table.SIZE_UNCOALESCED} if there is no subscription and the table is
|
|
2006
|
-
* uncoalesced.
|
|
1722
|
+
* @deprecated
|
|
2007
1723
|
*/
|
|
2008
|
-
|
|
1724
|
+
static readonly HACK_CONNECTION_FAILURE:string;
|
|
1725
|
+
static readonly EVENT_DISCONNECT:string;
|
|
1726
|
+
static readonly EVENT_RECONNECT:string;
|
|
1727
|
+
static readonly EVENT_SHUTDOWN:string;
|
|
1728
|
+
|
|
1729
|
+
protected constructor();
|
|
1730
|
+
|
|
2009
1731
|
/**
|
|
2010
|
-
*
|
|
2011
|
-
* @return boolean
|
|
1732
|
+
* Closes the current connection, releasing any resources on the server or client.
|
|
2012
1733
|
*/
|
|
2013
|
-
|
|
1734
|
+
close():void;
|
|
1735
|
+
running():Promise<IdeConnection>;
|
|
1736
|
+
getObject(definitionObject:dh.ide.VariableDescriptor):Promise<any>;
|
|
1737
|
+
subscribeToFieldUpdates(callback:(arg0:dh.ide.VariableChanges)=>void):()=>void;
|
|
2014
1738
|
/**
|
|
2015
|
-
*
|
|
2016
|
-
*
|
|
2017
|
-
*
|
|
2018
|
-
*
|
|
2019
|
-
*
|
|
2020
|
-
* have {@link Column.isPartitionColumn} as `true`, and filter those columns. To read the possible values
|
|
2021
|
-
* for those columns, use {@link Table.selectDistinct}.
|
|
2022
|
-
* @return True if the table is uncoaleced and should be filtered before operating on it, otherwise false.
|
|
1739
|
+
* Register a callback function to handle any log messages that are emitted on the server. Returns a function ,
|
|
1740
|
+
* which can be invoked to remove this log handler. Any log handler registered in this way will receive as many old
|
|
1741
|
+
* log messages as are presently available.
|
|
1742
|
+
* @param callback -
|
|
1743
|
+
* @return {@link io.deephaven.web.shared.fu.JsRunnable}
|
|
2023
1744
|
*/
|
|
2024
|
-
|
|
1745
|
+
onLogMessage(callback:(arg0:dh.ide.LogItem)=>void):()=>void;
|
|
1746
|
+
startSession(type:string):Promise<IdeSession>;
|
|
1747
|
+
getConsoleTypes():Promise<Array<string>>;
|
|
1748
|
+
getWorkerHeapInfo():Promise<WorkerHeapInfo>;
|
|
2025
1749
|
/**
|
|
2026
1750
|
* Listen for events on this object.
|
|
2027
1751
|
* @param name - the name of the event to listen for
|
|
@@ -2040,105 +1764,162 @@ export namespace dh {
|
|
|
2040
1764
|
* @typeParam T -
|
|
2041
1765
|
*/
|
|
2042
1766
|
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
1767
|
+
}
|
|
1768
|
+
|
|
1769
|
+
export class CoreClient implements HasEventHandling {
|
|
1770
|
+
static readonly EVENT_CONNECT:string;
|
|
1771
|
+
static readonly EVENT_DISCONNECT:string;
|
|
1772
|
+
static readonly EVENT_RECONNECT:string;
|
|
1773
|
+
static readonly EVENT_RECONNECT_AUTH_FAILED:string;
|
|
1774
|
+
static readonly EVENT_REQUEST_FAILED:string;
|
|
1775
|
+
static readonly EVENT_REQUEST_STARTED:string;
|
|
1776
|
+
static readonly EVENT_REQUEST_SUCCEEDED:string;
|
|
2043
1777
|
/**
|
|
2044
|
-
*
|
|
2045
|
-
* do not support reverse.
|
|
2046
|
-
* @return {@link dh.Sort}
|
|
1778
|
+
* @deprecated
|
|
2047
1779
|
*/
|
|
2048
|
-
static
|
|
1780
|
+
static readonly EVENT_REFRESH_TOKEN_UPDATED:string;
|
|
1781
|
+
static readonly LOGIN_TYPE_PASSWORD:string;
|
|
1782
|
+
static readonly LOGIN_TYPE_ANONYMOUS:string;
|
|
1783
|
+
|
|
1784
|
+
constructor(serverUrl:string, connectOptions?:ConnectOptions);
|
|
1785
|
+
|
|
1786
|
+
running():Promise<CoreClient>;
|
|
1787
|
+
getServerUrl():string;
|
|
1788
|
+
getAuthConfigValues():Promise<string[][]>;
|
|
1789
|
+
login(credentials:LoginCredentials):Promise<void>;
|
|
1790
|
+
relogin(token:RefreshToken):Promise<void>;
|
|
1791
|
+
onConnected(timeoutInMillis?:number):Promise<void>;
|
|
1792
|
+
getServerConfigValues():Promise<string[][]>;
|
|
1793
|
+
getStorageService():dh.storage.StorageService;
|
|
1794
|
+
getAsIdeConnection():Promise<IdeConnection>;
|
|
1795
|
+
disconnect():void;
|
|
1796
|
+
addEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):()=>void;
|
|
1797
|
+
nextEvent<T>(eventName:string, timeoutInMillis?:number):Promise<Event<T>>;
|
|
1798
|
+
hasListeners(name:string):boolean;
|
|
1799
|
+
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
2049
1800
|
}
|
|
2050
1801
|
|
|
2051
1802
|
/**
|
|
2052
|
-
* Describes a
|
|
2053
|
-
*
|
|
2054
|
-
*
|
|
1803
|
+
* Describes a filter which can be applied to a table. Replacing these instances may be more expensive than reusing
|
|
1804
|
+
* them. These instances are immutable - all operations that compose them to build bigger expressions return a new
|
|
1805
|
+
* instance.
|
|
2055
1806
|
*/
|
|
2056
|
-
export class
|
|
2057
|
-
static readonly ASCENDING:string;
|
|
2058
|
-
static readonly DESCENDING:string;
|
|
2059
|
-
static readonly REVERSE:string;
|
|
2060
|
-
|
|
1807
|
+
export class FilterCondition {
|
|
2061
1808
|
protected constructor();
|
|
2062
1809
|
|
|
2063
1810
|
/**
|
|
2064
|
-
*
|
|
2065
|
-
* @return
|
|
1811
|
+
* the opposite of this condition
|
|
1812
|
+
* @return FilterCondition
|
|
2066
1813
|
*/
|
|
2067
|
-
|
|
1814
|
+
not():FilterCondition;
|
|
2068
1815
|
/**
|
|
2069
|
-
*
|
|
2070
|
-
* @
|
|
1816
|
+
* a condition representing the current condition logically ANDed with the other parameters
|
|
1817
|
+
* @param filters -
|
|
1818
|
+
* @return FilterCondition
|
|
2071
1819
|
*/
|
|
2072
|
-
|
|
1820
|
+
and(...filters:FilterCondition[]):FilterCondition;
|
|
2073
1821
|
/**
|
|
2074
|
-
*
|
|
2075
|
-
* @
|
|
1822
|
+
* a condition representing the current condition logically ORed with the other parameters
|
|
1823
|
+
* @param filters -
|
|
1824
|
+
* @return FilterCondition.
|
|
2076
1825
|
*/
|
|
2077
|
-
|
|
2078
|
-
toString():string;
|
|
1826
|
+
or(...filters:FilterCondition[]):FilterCondition;
|
|
2079
1827
|
/**
|
|
2080
|
-
*
|
|
2081
|
-
* @return
|
|
1828
|
+
* a string suitable for debugging showing the details of this condition.
|
|
1829
|
+
* @return String.
|
|
2082
1830
|
*/
|
|
2083
|
-
|
|
1831
|
+
toString():string;
|
|
1832
|
+
get columns():Array<Column>;
|
|
2084
1833
|
/**
|
|
2085
|
-
*
|
|
2086
|
-
*
|
|
1834
|
+
* a filter condition invoking a static function with the given parameters. Currently supported Deephaven static
|
|
1835
|
+
* functions:
|
|
1836
|
+
* <ul>
|
|
1837
|
+
* <li><b>inRange</b>: Given three comparable values, returns true if the first is less than the second but greater
|
|
1838
|
+
* than the third</li>
|
|
1839
|
+
* <li><b>isInf</b>:Returns true if the given number is <i>infinity</i></li>
|
|
1840
|
+
* <li><b>isNaN</b>:Returns true if the given number is <i>not a number</i></li>
|
|
1841
|
+
* <li><b>isNormal</b>:Returns true if the given number <i>is not null</i>, <i>is not infinity</i>, and <i>is not
|
|
1842
|
+
* "not a number"</i></li>
|
|
1843
|
+
* <li><b>startsWith</b>:Returns true if the first string starts with the second string</li>
|
|
1844
|
+
* <li><b>endsWith</b>Returns true if the first string ends with the second string</li>
|
|
1845
|
+
* <li><b>matches</b>:Returns true if the first string argument matches the second string used as a Java regular
|
|
1846
|
+
* expression</li>
|
|
1847
|
+
* <li><b>contains</b>:Returns true if the first string argument contains the second string as a substring</li>
|
|
1848
|
+
* <li><b>in</b>:Returns true if the first string argument can be found in the second array argument.
|
|
1849
|
+
* <p>
|
|
1850
|
+
* Note that the array can only be specified as a column reference at this time - typically the `FilterValue.in`
|
|
1851
|
+
* method should be used in other cases
|
|
1852
|
+
* </p>
|
|
1853
|
+
* </li>
|
|
1854
|
+
* </ul>
|
|
1855
|
+
* @param function -
|
|
1856
|
+
* @param args -
|
|
1857
|
+
* @return dh.FilterCondition
|
|
2087
1858
|
*/
|
|
2088
|
-
|
|
1859
|
+
static invoke(func:string, ...args:FilterValue[]):FilterCondition;
|
|
2089
1860
|
/**
|
|
2090
|
-
*
|
|
2091
|
-
*
|
|
1861
|
+
* a filter condition which will check if the given value can be found in any supported column on whatever table
|
|
1862
|
+
* this FilterCondition is passed to. This FilterCondition is somewhat unique in that it need not be given a column
|
|
1863
|
+
* instance, but will adapt to any table. On numeric columns, with a value passed in which can be parsed as a
|
|
1864
|
+
* number, the column will be filtered to numbers which equal, or can be "rounded" effectively to this number. On
|
|
1865
|
+
* String columns, the given value will match any column which contains this string in a case-insensitive search. An
|
|
1866
|
+
* optional second argument can be passed, an array of `FilterValue` from the columns to limit this search to (see
|
|
1867
|
+
* {@link dh.Column.filter}).
|
|
1868
|
+
* @param value -
|
|
1869
|
+
* @param columns -
|
|
1870
|
+
* @return dh.FilterCondition
|
|
2092
1871
|
*/
|
|
2093
|
-
|
|
1872
|
+
static search(value:FilterValue, columns?:FilterValue[]):FilterCondition;
|
|
2094
1873
|
}
|
|
2095
1874
|
|
|
2096
|
-
|
|
2097
|
-
|
|
2098
|
-
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
|
|
2102
|
-
*/
|
|
2103
|
-
export class TableViewportSubscription implements HasEventHandling {
|
|
1875
|
+
export class CustomColumn {
|
|
1876
|
+
static readonly TYPE_FORMAT_COLOR:string;
|
|
1877
|
+
static readonly TYPE_FORMAT_NUMBER:string;
|
|
1878
|
+
static readonly TYPE_FORMAT_DATE:string;
|
|
1879
|
+
static readonly TYPE_NEW:string;
|
|
1880
|
+
|
|
2104
1881
|
protected constructor();
|
|
2105
1882
|
|
|
1883
|
+
valueOf():string;
|
|
1884
|
+
toString():string;
|
|
2106
1885
|
/**
|
|
2107
|
-
*
|
|
2108
|
-
* @
|
|
2109
|
-
* @param lastRow -
|
|
2110
|
-
* @param columns -
|
|
2111
|
-
* @param updateIntervalMs -
|
|
2112
|
-
*/
|
|
2113
|
-
setViewport(firstRow:number, lastRow:number, columns?:Column[]|undefined|null, updateIntervalMs?:number|undefined|null, isReverseViewport?:boolean|undefined|null):void;
|
|
2114
|
-
/**
|
|
2115
|
-
* Stops this viewport from running, stopping all events on itself and on the table that created it.
|
|
2116
|
-
*/
|
|
2117
|
-
close():void;
|
|
2118
|
-
/**
|
|
2119
|
-
* Gets the data currently visible in this viewport
|
|
2120
|
-
* @return Promise of {@link dh.TableData}.
|
|
1886
|
+
* The expression to evaluate this custom column.
|
|
1887
|
+
* @return String
|
|
2121
1888
|
*/
|
|
2122
|
-
|
|
2123
|
-
snapshot(rows:RangeSet, columns:Column[]):Promise<TableData>;
|
|
1889
|
+
get expression():string;
|
|
2124
1890
|
/**
|
|
2125
|
-
*
|
|
2126
|
-
* @
|
|
2127
|
-
* @param callback - a function to call when the event occurs
|
|
2128
|
-
* @return Returns a cleanup function.
|
|
2129
|
-
* @typeParam T - the type of the data that the event will provide
|
|
1891
|
+
* The name of the column to use.
|
|
1892
|
+
* @return String
|
|
2130
1893
|
*/
|
|
2131
|
-
|
|
2132
|
-
nextEvent<T>(eventName:string, timeoutInMillis?:number):Promise<Event<T>>;
|
|
2133
|
-
hasListeners(name:string):boolean;
|
|
1894
|
+
get name():string;
|
|
2134
1895
|
/**
|
|
2135
|
-
*
|
|
2136
|
-
*
|
|
2137
|
-
*
|
|
2138
|
-
*
|
|
2139
|
-
*
|
|
1896
|
+
* Type of custom column. One of
|
|
1897
|
+
*
|
|
1898
|
+
* <ul>
|
|
1899
|
+
* <li>FORMAT_COLOR</li>
|
|
1900
|
+
* <li>FORMAT_NUMBER</li>
|
|
1901
|
+
* <li>FORMAT_DATE</li>
|
|
1902
|
+
* <li>NEW</li>
|
|
1903
|
+
* </ul>
|
|
1904
|
+
* @return String
|
|
2140
1905
|
*/
|
|
2141
|
-
|
|
1906
|
+
get type():string;
|
|
1907
|
+
}
|
|
1908
|
+
|
|
1909
|
+
export class LongWrapper {
|
|
1910
|
+
protected constructor();
|
|
1911
|
+
|
|
1912
|
+
static ofString(str:string):LongWrapper;
|
|
1913
|
+
asNumber():number;
|
|
1914
|
+
valueOf():string;
|
|
1915
|
+
toString():string;
|
|
1916
|
+
}
|
|
1917
|
+
|
|
1918
|
+
export class DateWrapper extends LongWrapper {
|
|
1919
|
+
protected constructor();
|
|
1920
|
+
|
|
1921
|
+
static ofJsDate(date:Date):DateWrapper;
|
|
1922
|
+
asDate():Date;
|
|
2142
1923
|
}
|
|
2143
1924
|
|
|
2144
1925
|
/**
|
|
@@ -2232,224 +2013,456 @@ export namespace dh {
|
|
|
2232
2013
|
get type():string;
|
|
2233
2014
|
}
|
|
2234
2015
|
|
|
2235
|
-
|
|
2236
|
-
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
|
-
|
|
2240
|
-
static readonly EVENT_REQUEST_FAILED:string;
|
|
2241
|
-
static readonly EVENT_REQUEST_STARTED:string;
|
|
2242
|
-
static readonly EVENT_REQUEST_SUCCEEDED:string;
|
|
2016
|
+
export class QueryInfo {
|
|
2017
|
+
static readonly EVENT_TABLE_OPENED:string;
|
|
2018
|
+
static readonly EVENT_DISCONNECT:string;
|
|
2019
|
+
static readonly EVENT_RECONNECT:string;
|
|
2020
|
+
static readonly EVENT_CONNECT:string;
|
|
2243
2021
|
|
|
2244
|
-
constructor();
|
|
2022
|
+
protected constructor();
|
|
2245
2023
|
}
|
|
2246
2024
|
|
|
2247
2025
|
/**
|
|
2248
|
-
*
|
|
2026
|
+
* Event fired when a command is issued from the client.
|
|
2249
2027
|
*/
|
|
2250
|
-
export class
|
|
2251
|
-
|
|
2028
|
+
export class CommandInfo {
|
|
2029
|
+
constructor(code:string, result:Promise<dh.ide.CommandResult>);
|
|
2252
2030
|
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
valueOf():string;
|
|
2256
|
-
toString():string;
|
|
2031
|
+
get result():Promise<dh.ide.CommandResult>;
|
|
2032
|
+
get code():string;
|
|
2257
2033
|
}
|
|
2258
2034
|
|
|
2259
2035
|
/**
|
|
2260
|
-
*
|
|
2261
|
-
*
|
|
2262
|
-
*
|
|
2036
|
+
* Provides access to data in a table. Note that several methods present their response through Promises. This allows
|
|
2037
|
+
* the client to both avoid actually connecting to the server until necessary, and also will permit some changes not to
|
|
2038
|
+
* inform the UI right away that they have taken place.
|
|
2263
2039
|
*/
|
|
2264
|
-
export class
|
|
2265
|
-
|
|
2040
|
+
export class Table implements JoinableTable, HasEventHandling {
|
|
2041
|
+
readonly description?:string|null;
|
|
2042
|
+
readonly pluginName?:string|null;
|
|
2043
|
+
readonly layoutHints?:null|LayoutHints;
|
|
2044
|
+
/**
|
|
2045
|
+
* The table size has updated, so live scrollbars and the like can be updated accordingly.
|
|
2046
|
+
*/
|
|
2047
|
+
static readonly EVENT_SIZECHANGED:string;
|
|
2048
|
+
/**
|
|
2049
|
+
* The table size has updated, so live scrollbars and the like can be updated accordingly.
|
|
2050
|
+
*/
|
|
2051
|
+
static readonly EVENT_UPDATED:string;
|
|
2052
|
+
/**
|
|
2053
|
+
* The table size has updated, so live scrollbars and the like can be updated accordingly.
|
|
2054
|
+
*/
|
|
2055
|
+
static readonly EVENT_ROWADDED:string;
|
|
2056
|
+
/**
|
|
2057
|
+
* The table size has updated, so live scrollbars and the like can be updated accordingly.
|
|
2058
|
+
*/
|
|
2059
|
+
static readonly EVENT_ROWREMOVED:string;
|
|
2060
|
+
/**
|
|
2061
|
+
* The table size has updated, so live scrollbars and the like can be updated accordingly.
|
|
2062
|
+
*/
|
|
2063
|
+
static readonly EVENT_ROWUPDATED:string;
|
|
2064
|
+
/**
|
|
2065
|
+
* The table size has updated, so live scrollbars and the like can be updated accordingly.
|
|
2066
|
+
*/
|
|
2067
|
+
static readonly EVENT_SORTCHANGED:string;
|
|
2068
|
+
/**
|
|
2069
|
+
* The table size has updated, so live scrollbars and the like can be updated accordingly.
|
|
2070
|
+
*/
|
|
2071
|
+
static readonly EVENT_FILTERCHANGED:string;
|
|
2072
|
+
/**
|
|
2073
|
+
* The table size has updated, so live scrollbars and the like can be updated accordingly.
|
|
2074
|
+
*/
|
|
2075
|
+
static readonly EVENT_CUSTOMCOLUMNSCHANGED:string;
|
|
2076
|
+
/**
|
|
2077
|
+
* The table size has updated, so live scrollbars and the like can be updated accordingly.
|
|
2078
|
+
*/
|
|
2266
2079
|
static readonly EVENT_DISCONNECT:string;
|
|
2080
|
+
/**
|
|
2081
|
+
* The table size has updated, so live scrollbars and the like can be updated accordingly.
|
|
2082
|
+
*/
|
|
2267
2083
|
static readonly EVENT_RECONNECT:string;
|
|
2084
|
+
/**
|
|
2085
|
+
* The table size has updated, so live scrollbars and the like can be updated accordingly.
|
|
2086
|
+
*/
|
|
2268
2087
|
static readonly EVENT_RECONNECTFAILED:string;
|
|
2269
|
-
|
|
2270
|
-
protected constructor();
|
|
2271
|
-
}
|
|
2272
|
-
|
|
2273
|
-
export class LoginCredentials {
|
|
2274
|
-
type?:string|null;
|
|
2275
|
-
username?:string|null;
|
|
2276
|
-
token?:string|null;
|
|
2277
|
-
|
|
2278
|
-
constructor();
|
|
2279
|
-
}
|
|
2280
|
-
|
|
2281
|
-
/**
|
|
2282
|
-
* Describes the structure of the column, and if desired can be used to get access to the data to be rendered in this
|
|
2283
|
-
* column.
|
|
2284
|
-
*/
|
|
2285
|
-
export class Column {
|
|
2286
2088
|
/**
|
|
2287
|
-
*
|
|
2288
|
-
* column for leaf nodes if includeConstituents is enabled. Otherwise, it is <b>null</b>.
|
|
2289
|
-
* @return String
|
|
2089
|
+
* The table size has updated, so live scrollbars and the like can be updated accordingly.
|
|
2290
2090
|
*/
|
|
2291
|
-
readonly
|
|
2292
|
-
|
|
2091
|
+
static readonly EVENT_REQUEST_FAILED:string;
|
|
2092
|
+
/**
|
|
2093
|
+
* The table size has updated, so live scrollbars and the like can be updated accordingly.
|
|
2094
|
+
*/
|
|
2095
|
+
static readonly EVENT_REQUEST_SUCCEEDED:string;
|
|
2096
|
+
/**
|
|
2097
|
+
* The size the table will have if it is uncoalesced.
|
|
2098
|
+
*/
|
|
2099
|
+
static readonly SIZE_UNCOALESCED:number;
|
|
2293
2100
|
|
|
2294
2101
|
protected constructor();
|
|
2295
2102
|
|
|
2103
|
+
batch(userCode:(arg0:unknown)=>void):Promise<Table>;
|
|
2296
2104
|
/**
|
|
2297
|
-
*
|
|
2298
|
-
*
|
|
2299
|
-
* @
|
|
2105
|
+
* Retrieve a column by the given name. You should prefer to always retrieve a new Column instance instead of
|
|
2106
|
+
* caching a returned value.
|
|
2107
|
+
* @param key -
|
|
2108
|
+
* @return {@link dh.Column}
|
|
2300
2109
|
*/
|
|
2301
|
-
|
|
2302
|
-
|
|
2110
|
+
findColumn(key:string):Column;
|
|
2111
|
+
/**
|
|
2112
|
+
* Retrieve multiple columns specified by the given names.
|
|
2113
|
+
* @param keys -
|
|
2114
|
+
* @return {@link dh.Column} array
|
|
2115
|
+
*/
|
|
2116
|
+
findColumns(keys:string[]):Column[];
|
|
2117
|
+
isBlinkTable():boolean;
|
|
2118
|
+
/**
|
|
2119
|
+
* If .hasInputTable is true, you may call this method to gain access to an InputTable object which can be used to
|
|
2120
|
+
* mutate the data within the table. If the table is not an Input Table, the promise will be immediately rejected.
|
|
2121
|
+
* @return Promise of dh.InputTable
|
|
2122
|
+
*/
|
|
2123
|
+
inputTable():Promise<InputTable>;
|
|
2124
|
+
/**
|
|
2125
|
+
* Indicates that this Table instance will no longer be used, and its connection to the server can be cleaned up.
|
|
2126
|
+
*/
|
|
2127
|
+
close():void;
|
|
2128
|
+
getAttributes():string[];
|
|
2129
|
+
/**
|
|
2130
|
+
* null if no property exists, a string if it is an easily serializable property, or a ```Promise
|
|
2131
|
+
* <Table>``` that will either resolve with a table or error out if the object can't be passed to JS.
|
|
2132
|
+
* @param attributeName -
|
|
2133
|
+
* @return Object
|
|
2134
|
+
*/
|
|
2135
|
+
getAttribute(attributeName:string):unknown|undefined|null;
|
|
2136
|
+
/**
|
|
2137
|
+
* Replace the currently set sort on this table. Returns the previously set value. Note that the sort property will
|
|
2138
|
+
* immediately return the new value, but you may receive update events using the old sort before the new sort is
|
|
2139
|
+
* applied, and the <b>sortchanged</b> event fires. Reusing existing, applied sorts may enable this to perform
|
|
2140
|
+
* better on the server. The <b>updated</b> event will also fire, but <b>rowadded</b> and <b>rowremoved</b> will
|
|
2141
|
+
* not.
|
|
2142
|
+
* @param sort -
|
|
2143
|
+
* @return {@link dh.Sort} array
|
|
2144
|
+
*/
|
|
2145
|
+
applySort(sort:Sort[]):Array<Sort>;
|
|
2146
|
+
/**
|
|
2147
|
+
* Replace the currently set filters on the table. Returns the previously set value. Note that the filter property
|
|
2148
|
+
* will immediately return the new value, but you may receive update events using the old filter before the new one
|
|
2149
|
+
* is applied, and the <b>filterchanged</b> event fires. Reusing existing, applied filters may enable this to
|
|
2150
|
+
* perform better on the server. The <b>updated</b> event will also fire, but <b>rowadded</b> and <b>rowremoved</b>
|
|
2151
|
+
* will not.
|
|
2152
|
+
* @param filter -
|
|
2153
|
+
* @return {@link dh.FilterCondition} array
|
|
2154
|
+
*/
|
|
2155
|
+
applyFilter(filter:FilterCondition[]):Array<FilterCondition>;
|
|
2156
|
+
/**
|
|
2157
|
+
* used when adding new filter and sort operations to the table, as long as they are present.
|
|
2158
|
+
* @param customColumns -
|
|
2159
|
+
* @return {@link dh.CustomColumn} array
|
|
2160
|
+
*/
|
|
2161
|
+
applyCustomColumns(customColumns:Array<string|CustomColumn>):Array<CustomColumn>;
|
|
2162
|
+
/**
|
|
2163
|
+
* If the columns parameter is not provided, all columns will be used. If the updateIntervalMs parameter is not
|
|
2164
|
+
* provided, a default of one second will be used. Until this is called, no data will be available. Invoking this
|
|
2165
|
+
* will result in events to be fired once data becomes available, starting with an `updated` event and a
|
|
2166
|
+
* <b>rowadded</b> event per row in that range. The returned object allows the viewport to be closed when no longer
|
|
2167
|
+
* needed.
|
|
2168
|
+
* @param firstRow -
|
|
2169
|
+
* @param lastRow -
|
|
2170
|
+
* @param columns -
|
|
2171
|
+
* @param updateIntervalMs -
|
|
2172
|
+
* @return {@link dh.TableViewportSubscription}
|
|
2173
|
+
*/
|
|
2174
|
+
setViewport(firstRow:number, lastRow:number, columns?:Array<Column>|undefined|null, updateIntervalMs?:number|undefined|null, isReverseViewport?:boolean|undefined|null):TableViewportSubscription;
|
|
2175
|
+
/**
|
|
2176
|
+
* Gets the currently visible viewport. If the current set of operations has not yet resulted in data, it will not
|
|
2177
|
+
* resolve until that data is ready. If this table is closed before the promise resolves, it will be rejected - to
|
|
2178
|
+
* separate the lifespan of this promise from the table itself, call
|
|
2179
|
+
* {@link TableViewportSubscription.getViewportData} on the result from {@link Table.setViewport}.
|
|
2180
|
+
* @return Promise of {@link dh.TableData}
|
|
2181
|
+
*/
|
|
2182
|
+
getViewportData():Promise<ViewportData>;
|
|
2183
|
+
/**
|
|
2184
|
+
* Creates a subscription to the specified columns, across all rows in the table. The optional parameter
|
|
2185
|
+
* updateIntervalMs may be specified to indicate how often the server should send updates, defaulting to one second
|
|
2186
|
+
* if omitted. Useful for charts or taking a snapshot of the table atomically. The initial snapshot will arrive in a
|
|
2187
|
+
* single event, but later changes will be sent as updates. However, this may still be very expensive to run from a
|
|
2188
|
+
* browser for very large tables. Each call to subscribe creates a new subscription, which must have <b>close()</b>
|
|
2189
|
+
* called on it to stop it, and all events are fired from the TableSubscription instance.
|
|
2190
|
+
* @param columns -
|
|
2191
|
+
* @param updateIntervalMs -
|
|
2192
|
+
* @return {@link dh.TableSubscription}
|
|
2193
|
+
*/
|
|
2194
|
+
subscribe(columns:Array<Column>, updateIntervalMs?:number):TableSubscription;
|
|
2195
|
+
/**
|
|
2196
|
+
* a new table containing the distinct tuples of values from the given columns that are present in the original
|
|
2197
|
+
* table. This table can be manipulated as any other table. Sorting is often desired as the default sort is the
|
|
2198
|
+
* order of appearance of values from the original table.
|
|
2199
|
+
* @param columns -
|
|
2200
|
+
* @return Promise of dh.Table
|
|
2201
|
+
*/
|
|
2202
|
+
selectDistinct(columns:Column[]):Promise<Table>;
|
|
2203
|
+
/**
|
|
2204
|
+
* Creates a new copy of this table, so it can be sorted and filtered separately, and maintain a different viewport.
|
|
2205
|
+
* @return Promise of dh.Table
|
|
2206
|
+
*/
|
|
2207
|
+
copy():Promise<Table>;
|
|
2208
|
+
/**
|
|
2209
|
+
* a promise that will resolve to a Totals Table of this table. This table will obey the configurations provided as
|
|
2210
|
+
* a parameter, or will use the table's default if no parameter is provided, and be updated once per second as
|
|
2211
|
+
* necessary. Note that multiple calls to this method will each produce a new TotalsTable which must have close()
|
|
2212
|
+
* called on it when not in use.
|
|
2213
|
+
* @param config -
|
|
2214
|
+
* @return Promise of dh.TotalsTable
|
|
2215
|
+
*/
|
|
2216
|
+
getTotalsTable(config?:TotalsTableConfig|undefined|null):Promise<TotalsTable>;
|
|
2217
|
+
/**
|
|
2218
|
+
* a promise that will resolve to a Totals Table of this table, ignoring any filters. See <b>getTotalsTable()</b>
|
|
2219
|
+
* above for more specifics.
|
|
2220
|
+
* @param config -
|
|
2221
|
+
* @return promise of dh.TotalsTable
|
|
2222
|
+
*/
|
|
2223
|
+
getGrandTotalsTable(config?:TotalsTableConfig|undefined|null):Promise<TotalsTable>;
|
|
2303
2224
|
/**
|
|
2304
|
-
*
|
|
2305
|
-
*
|
|
2225
|
+
* a promise that will resolve to a new roll-up <b>TreeTable</b> of this table. Multiple calls to this method will
|
|
2226
|
+
* each produce a new <b>TreeTable</b> which must have close() called on it when not in use.
|
|
2227
|
+
* @param configObject -
|
|
2228
|
+
* @return Promise of dh.TreeTable
|
|
2306
2229
|
*/
|
|
2307
|
-
|
|
2230
|
+
rollup(configObject:RollupConfig):Promise<TreeTable>;
|
|
2308
2231
|
/**
|
|
2309
|
-
*
|
|
2310
|
-
*
|
|
2311
|
-
* @
|
|
2232
|
+
* a promise that will resolve to a new `TreeTable` of this table. Multiple calls to this method will each produce a
|
|
2233
|
+
* new `TreeTable` which must have close() called on it when not in use.
|
|
2234
|
+
* @param configObject -
|
|
2235
|
+
* @return Promise dh.TreeTable
|
|
2312
2236
|
*/
|
|
2313
|
-
|
|
2237
|
+
treeTable(configObject:TreeTableConfig):Promise<TreeTable>;
|
|
2314
2238
|
/**
|
|
2315
|
-
* a
|
|
2316
|
-
*
|
|
2317
|
-
*
|
|
2239
|
+
* a "frozen" version of this table (a server-side snapshot of the entire source table). Viewports on the frozen
|
|
2240
|
+
* table will not update. This does not change the original table, and the new table will not have any of the client
|
|
2241
|
+
* side sorts/filters/columns. New client side sorts/filters/columns can be added to the frozen copy.
|
|
2242
|
+
* @return Promise of dh.Table
|
|
2318
2243
|
*/
|
|
2319
|
-
|
|
2244
|
+
freeze():Promise<Table>;
|
|
2245
|
+
snapshot(baseTable:Table, doInitialSnapshot?:boolean, stampColumns?:string[]):Promise<Table>;
|
|
2320
2246
|
/**
|
|
2321
|
-
*
|
|
2322
|
-
* @
|
|
2323
|
-
* @
|
|
2247
|
+
*
|
|
2248
|
+
* @inheritDoc
|
|
2249
|
+
* @deprecated
|
|
2324
2250
|
*/
|
|
2325
|
-
|
|
2251
|
+
join(joinType:string, rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>|undefined|null, asOfMatchRule?:string|undefined|null):Promise<Table>;
|
|
2252
|
+
asOfJoin(rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>|undefined|null, asOfMatchRule?:string|undefined|null):Promise<Table>;
|
|
2253
|
+
crossJoin(rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>|undefined|null, reserveBits?:number|undefined|null):Promise<Table>;
|
|
2254
|
+
exactJoin(rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>):Promise<Table>;
|
|
2255
|
+
naturalJoin(rightTable:JoinableTable, columnsToMatch:Array<string>, columnsToAdd?:Array<string>):Promise<Table>;
|
|
2256
|
+
byExternal(keys:object, dropKeys?:boolean):Promise<PartitionedTable>;
|
|
2326
2257
|
/**
|
|
2327
|
-
* a
|
|
2328
|
-
*
|
|
2329
|
-
* @
|
|
2258
|
+
* Creates a new PartitionedTable from the contents of the current table, partitioning data based on the specified
|
|
2259
|
+
* keys.
|
|
2260
|
+
* @param keys -
|
|
2261
|
+
* @param dropKeys -
|
|
2262
|
+
* @return Promise dh.PartitionedTable
|
|
2330
2263
|
*/
|
|
2331
|
-
|
|
2332
|
-
toString():string;
|
|
2264
|
+
partitionBy(keys:object, dropKeys?:boolean):Promise<PartitionedTable>;
|
|
2333
2265
|
/**
|
|
2334
|
-
*
|
|
2335
|
-
* @
|
|
2266
|
+
* a promise that will resolve to ColumnStatistics for the column of this table.
|
|
2267
|
+
* @param column -
|
|
2268
|
+
* @return Promise of dh.ColumnStatistics
|
|
2336
2269
|
*/
|
|
2337
|
-
|
|
2270
|
+
getColumnStatistics(column:Column):Promise<ColumnStatistics>;
|
|
2338
2271
|
/**
|
|
2339
|
-
*
|
|
2340
|
-
*
|
|
2341
|
-
* @
|
|
2272
|
+
* Seek the row matching the data provided
|
|
2273
|
+
* @param startingRow - Row to start the seek from
|
|
2274
|
+
* @param column - Column to seek for value on
|
|
2275
|
+
* @param valueType - Type of value provided
|
|
2276
|
+
* @param seekValue - Value to seek
|
|
2277
|
+
* @param insensitive - Optional value to flag a search as case-insensitive. Defaults to `false`.
|
|
2278
|
+
* @param contains - Optional value to have the seek value do a contains search instead of exact equality. Defaults to
|
|
2279
|
+
* `false`.
|
|
2280
|
+
* @param isBackwards - Optional value to seek backwards through the table instead of forwards. Defaults to `false`.
|
|
2281
|
+
* @return A promise that resolves to the row value found.
|
|
2342
2282
|
*/
|
|
2343
|
-
|
|
2283
|
+
seekRow(startingRow:number, column:Column, valueType:ValueTypeType, seekValue:any, insensitive?:boolean|undefined|null, contains?:boolean|undefined|null, isBackwards?:boolean|undefined|null):Promise<number>;
|
|
2284
|
+
toString():string;
|
|
2344
2285
|
/**
|
|
2345
|
-
*
|
|
2346
|
-
*
|
|
2347
|
-
* @return
|
|
2286
|
+
* True if this table represents a user Input Table (created by InputTable.newInputTable). When true, you may call
|
|
2287
|
+
* .inputTable() to add or remove data from the underlying table.
|
|
2288
|
+
* @return boolean
|
|
2348
2289
|
*/
|
|
2349
|
-
get
|
|
2350
|
-
get isSortable():boolean;
|
|
2290
|
+
get hasInputTable():boolean;
|
|
2351
2291
|
/**
|
|
2352
|
-
*
|
|
2353
|
-
*
|
|
2292
|
+
* The columns that are present on this table. This is always all possible columns. If you specify fewer columns in
|
|
2293
|
+
* .setViewport(), you will get only those columns in your ViewportData. <b>Number size</b> The total count of rows
|
|
2294
|
+
* in the table. The size can and will change; see the <b>sizechanged</b> event for details. Size will be negative
|
|
2295
|
+
* in exceptional cases (eg. the table is uncoalesced, see the <b>isUncoalesced</b> property for details).
|
|
2296
|
+
* @return {@link dh.Column} array
|
|
2354
2297
|
*/
|
|
2355
|
-
get
|
|
2298
|
+
get columns():Array<Column>;
|
|
2356
2299
|
/**
|
|
2357
|
-
*
|
|
2358
|
-
*
|
|
2359
|
-
* @param expression -
|
|
2360
|
-
* @return {@link dh.CustomColumn}
|
|
2300
|
+
* The default configuration to be used when building a <b>TotalsTable</b> for this table.
|
|
2301
|
+
* @return dh.TotalsTableConfig
|
|
2361
2302
|
*/
|
|
2362
|
-
|
|
2303
|
+
get totalsTableConfig():TotalsTableConfig;
|
|
2363
2304
|
/**
|
|
2364
|
-
*
|
|
2365
|
-
*
|
|
2366
|
-
*
|
|
2367
|
-
* @return {@link dh.
|
|
2305
|
+
* An ordered list of Sorts to apply to the table. To update, call <b>applySort()</b>. Note that this getter will
|
|
2306
|
+
* return the new value immediately, even though it may take a little time to update on the server. You may listen
|
|
2307
|
+
* for the <b>sortchanged</b> event to know when to update the UI.
|
|
2308
|
+
* @return {@link dh.Sort} array
|
|
2368
2309
|
*/
|
|
2369
|
-
|
|
2370
|
-
}
|
|
2371
|
-
|
|
2372
|
-
/**
|
|
2373
|
-
* Describes how a Totals Table will be generated from its parent table. Each table has a default (which may be null)
|
|
2374
|
-
* indicating how that table was configured when it was declared, and each Totals Table has a similar property
|
|
2375
|
-
* describing how it was created. Both the <b>Table.getTotalsTable</b> and <b>Table.getGrandTotalsTable</b> methods take
|
|
2376
|
-
* this config as an optional parameter - without it, the table's default will be used, or if null, a default instance
|
|
2377
|
-
* of <b>TotalsTableConfig</b> will be supplied.
|
|
2378
|
-
*
|
|
2379
|
-
* This class has a no-arg constructor, allowing an instance to be made with the default values provided. However, any
|
|
2380
|
-
* JS object can be passed in to the methods which accept instances of this type, provided their values adhere to the
|
|
2381
|
-
* expected formats.
|
|
2382
|
-
*/
|
|
2383
|
-
export class TotalsTableConfig {
|
|
2310
|
+
get sort():Array<Sort>;
|
|
2384
2311
|
/**
|
|
2385
|
-
*
|
|
2312
|
+
* An ordered list of custom column formulas to add to the table, either adding new columns or replacing existing
|
|
2313
|
+
* ones. To update, call <b>applyCustomColumns()</b>.
|
|
2314
|
+
* @return {@link dh.CustomColumn} array
|
|
2386
2315
|
*/
|
|
2387
|
-
|
|
2316
|
+
get customColumns():Array<CustomColumn>;
|
|
2388
2317
|
/**
|
|
2389
|
-
*
|
|
2318
|
+
* True if this table may receive updates from the server, including size changed events, updated events after
|
|
2319
|
+
* initial snapshot.
|
|
2320
|
+
* @return boolean
|
|
2390
2321
|
*/
|
|
2391
|
-
|
|
2322
|
+
get isRefreshing():boolean;
|
|
2392
2323
|
/**
|
|
2393
|
-
*
|
|
2324
|
+
* An ordered list of Filters to apply to the table. To update, call applyFilter(). Note that this getter will
|
|
2325
|
+
* return the new value immediately, even though it may take a little time to update on the server. You may listen
|
|
2326
|
+
* for the <b>filterchanged</b> event to know when to update the UI.
|
|
2327
|
+
* @return {@link dh.FilterCondition} array
|
|
2394
2328
|
*/
|
|
2395
|
-
|
|
2329
|
+
get filter():Array<FilterCondition>;
|
|
2396
2330
|
/**
|
|
2397
|
-
* @
|
|
2331
|
+
* The total count of the rows in the table, excluding any filters. Unlike {@link Table.size}, changes to this value
|
|
2332
|
+
* will not result in any event. If the table is unfiltered, this will return the same size as {@link Table.size}.
|
|
2333
|
+
* If this table was uncoalesced before it was filtered, this will return {@link dh.Table.SIZE_UNCOALESCED}.
|
|
2334
|
+
* @return the size of the table before filters, or {@link dh.Table.SIZE_UNCOALESCED}
|
|
2398
2335
|
*/
|
|
2399
|
-
|
|
2336
|
+
get totalSize():number;
|
|
2400
2337
|
/**
|
|
2401
|
-
*
|
|
2338
|
+
* The total count of rows in the table. If there is a viewport subscription active, this size will be updated when
|
|
2339
|
+
* the subscription updates. If not, and {@link Table.uncoalesced} is true, the size will be
|
|
2340
|
+
* {@link dh.Table.SIZE_UNCOALESCED}. Otherwise, the size will be updated when the server's update graph processes changes.
|
|
2341
|
+
* <p>
|
|
2342
|
+
* When the size changes, the {@link dh.Table.EVENT_SIZECHANGED} event will be fired.
|
|
2343
|
+
* @return the size of the table, or {@link dh.Table.SIZE_UNCOALESCED} if there is no subscription and the table is
|
|
2344
|
+
* uncoalesced.
|
|
2402
2345
|
*/
|
|
2403
|
-
|
|
2346
|
+
get size():number;
|
|
2404
2347
|
/**
|
|
2405
|
-
*
|
|
2348
|
+
* True if this table has been closed.
|
|
2349
|
+
* @return boolean
|
|
2406
2350
|
*/
|
|
2407
|
-
|
|
2351
|
+
get isClosed():boolean;
|
|
2408
2352
|
/**
|
|
2409
|
-
*
|
|
2353
|
+
* Read-only. True if this table is uncoalesced, indicating that work must be done before the table can be used.
|
|
2354
|
+
* <p>
|
|
2355
|
+
* Uncoalesced tables are expensive to operate on - filter to a single partition or range of partitions before
|
|
2356
|
+
* subscribing to access only the desired data efficiently. A subscription can be specified without a filter, but
|
|
2357
|
+
* this can be very expensive. To see which partitions are available, check each column on the table to see which
|
|
2358
|
+
* have {@link Column.isPartitionColumn} as `true`, and filter those columns. To read the possible values
|
|
2359
|
+
* for those columns, use {@link Table.selectDistinct}.
|
|
2360
|
+
* @return True if the table is uncoaleced and should be filtered before operating on it, otherwise false.
|
|
2410
2361
|
*/
|
|
2411
|
-
|
|
2362
|
+
get isUncoalesced():boolean;
|
|
2412
2363
|
/**
|
|
2413
|
-
*
|
|
2364
|
+
* Listen for events on this object.
|
|
2365
|
+
* @param name - the name of the event to listen for
|
|
2366
|
+
* @param callback - a function to call when the event occurs
|
|
2367
|
+
* @return Returns a cleanup function.
|
|
2368
|
+
* @typeParam T - the type of the data that the event will provide
|
|
2414
2369
|
*/
|
|
2415
|
-
|
|
2370
|
+
addEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):()=>void;
|
|
2371
|
+
nextEvent<T>(eventName:string, timeoutInMillis?:number):Promise<Event<T>>;
|
|
2372
|
+
hasListeners(name:string):boolean;
|
|
2416
2373
|
/**
|
|
2417
|
-
*
|
|
2374
|
+
* Removes an event listener added to this table.
|
|
2375
|
+
* @param name -
|
|
2376
|
+
* @param callback -
|
|
2377
|
+
* @return
|
|
2378
|
+
* @typeParam T -
|
|
2418
2379
|
*/
|
|
2419
|
-
|
|
2380
|
+
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
2420
2381
|
/**
|
|
2421
|
-
*
|
|
2382
|
+
* a Sort than can be used to reverse a table. This can be passed into n array in applySort. Note that Tree Tables
|
|
2383
|
+
* do not support reverse.
|
|
2384
|
+
* @return {@link dh.Sort}
|
|
2422
2385
|
*/
|
|
2423
|
-
static
|
|
2386
|
+
static reverse():Sort;
|
|
2387
|
+
}
|
|
2388
|
+
|
|
2389
|
+
export class IdeSession implements HasEventHandling {
|
|
2390
|
+
static readonly EVENT_COMMANDSTARTED:string;
|
|
2391
|
+
static readonly EVENT_REQUEST_FAILED:string;
|
|
2392
|
+
|
|
2393
|
+
protected constructor();
|
|
2394
|
+
|
|
2424
2395
|
/**
|
|
2425
|
-
*
|
|
2396
|
+
* Load the named table, with columns and size information already fully populated.
|
|
2397
|
+
* @param name -
|
|
2398
|
+
* @param applyPreviewColumns - optional boolean
|
|
2399
|
+
* @return {@link Promise} of {@link dh.Table}
|
|
2426
2400
|
*/
|
|
2427
|
-
|
|
2401
|
+
getTable(name:string, applyPreviewColumns?:boolean):Promise<Table>;
|
|
2428
2402
|
/**
|
|
2429
|
-
*
|
|
2403
|
+
* Load the named Figure, including its tables and tablemaps as needed.
|
|
2404
|
+
* @param name -
|
|
2405
|
+
* @return promise of dh.plot.Figure
|
|
2430
2406
|
*/
|
|
2431
|
-
|
|
2407
|
+
getFigure(name:string):Promise<dh.plot.Figure>;
|
|
2432
2408
|
/**
|
|
2433
|
-
*
|
|
2409
|
+
* Loads the named tree table or roll-up table, with column data populated. All nodes are collapsed by default, and
|
|
2410
|
+
* size is presently not available until the viewport is first set.
|
|
2411
|
+
* @param name -
|
|
2412
|
+
* @return {@link Promise} of {@link dh.TreeTable}
|
|
2434
2413
|
*/
|
|
2435
|
-
|
|
2414
|
+
getTreeTable(name:string):Promise<TreeTable>;
|
|
2415
|
+
getHierarchicalTable(name:string):Promise<TreeTable>;
|
|
2416
|
+
getPartitionedTable(name:string):Promise<PartitionedTable>;
|
|
2417
|
+
getObject(definitionObject:dh.ide.VariableDescriptor):Promise<any>;
|
|
2418
|
+
newTable(columnNames:string[], types:string[], data:string[][], userTimeZone:string):Promise<Table>;
|
|
2436
2419
|
/**
|
|
2437
|
-
*
|
|
2420
|
+
* Merges the given tables into a single table. Assumes all tables have the same structure.
|
|
2421
|
+
* @param tables -
|
|
2422
|
+
* @return {@link Promise} of {@link dh.Table}
|
|
2438
2423
|
*/
|
|
2439
|
-
|
|
2424
|
+
mergeTables(tables:Table[]):Promise<Table>;
|
|
2425
|
+
bindTableToVariable(table:Table, name:string):Promise<void>;
|
|
2426
|
+
subscribeToFieldUpdates(callback:(arg0:dh.ide.VariableChanges)=>void):()=>void;
|
|
2427
|
+
close():void;
|
|
2428
|
+
runCode(code:string):Promise<dh.ide.CommandResult>;
|
|
2429
|
+
onLogMessage(callback:(arg0:dh.ide.LogItem)=>void):()=>void;
|
|
2430
|
+
openDocument(params:object):void;
|
|
2431
|
+
changeDocument(params:object):void;
|
|
2432
|
+
getCompletionItems(params:object):Promise<Array<dh.lsp.CompletionItem>>;
|
|
2433
|
+
getSignatureHelp(params:object):Promise<Array<dh.lsp.SignatureInformation>>;
|
|
2434
|
+
getHover(params:object):Promise<dh.lsp.Hover>;
|
|
2435
|
+
closeDocument(params:object):void;
|
|
2440
2436
|
/**
|
|
2441
|
-
*
|
|
2442
|
-
*
|
|
2437
|
+
* Creates an empty table with the specified number of rows. Optionally columns and types may be specified, but all
|
|
2438
|
+
* values will be null.
|
|
2439
|
+
* @param size -
|
|
2440
|
+
* @return {@link Promise} of {@link dh.Table}
|
|
2443
2441
|
*/
|
|
2444
|
-
|
|
2442
|
+
emptyTable(size:number):Promise<Table>;
|
|
2445
2443
|
/**
|
|
2446
|
-
*
|
|
2447
|
-
*
|
|
2444
|
+
* Creates a new table that ticks automatically every "periodNanos" nanoseconds. A start time may be provided; if so
|
|
2445
|
+
* the table will be populated with the interval from the specified date until now.
|
|
2446
|
+
* @param periodNanos -
|
|
2447
|
+
* @param startTime -
|
|
2448
|
+
* @return {@link Promise} of {@link dh.Table}
|
|
2448
2449
|
*/
|
|
2449
|
-
|
|
2450
|
+
timeTable(periodNanos:number, startTime?:DateWrapper):Promise<Table>;
|
|
2451
|
+
addEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):()=>void;
|
|
2452
|
+
nextEvent<T>(eventName:string, timeoutInMillis?:number):Promise<Event<T>>;
|
|
2453
|
+
hasListeners(name:string):boolean;
|
|
2454
|
+
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
2455
|
+
}
|
|
2450
2456
|
|
|
2451
|
-
|
|
2457
|
+
/**
|
|
2458
|
+
* Wrap BigDecimal values for use in JS. Provides text formatting for display and access to the underlying value.
|
|
2459
|
+
*/
|
|
2460
|
+
export class BigDecimalWrapper {
|
|
2461
|
+
protected constructor();
|
|
2452
2462
|
|
|
2463
|
+
static ofString(value:string):BigDecimalWrapper;
|
|
2464
|
+
asNumber():number;
|
|
2465
|
+
valueOf():string;
|
|
2453
2466
|
toString():string;
|
|
2454
2467
|
}
|
|
2455
2468
|
|
|
@@ -2464,20 +2477,11 @@ export namespace dh {
|
|
|
2464
2477
|
static readonly BOOLEAN:ValueTypeType;
|
|
2465
2478
|
}
|
|
2466
2479
|
|
|
2467
|
-
|
|
2468
|
-
|
|
2469
|
-
|
|
2470
|
-
|
|
2471
|
-
|
|
2472
|
-
static readonly TABLE:VariableTypeType;
|
|
2473
|
-
static readonly TREETABLE:VariableTypeType;
|
|
2474
|
-
static readonly HIERARCHICALTABLE:VariableTypeType;
|
|
2475
|
-
static readonly TABLEMAP:VariableTypeType;
|
|
2476
|
-
static readonly PARTITIONEDTABLE:VariableTypeType;
|
|
2477
|
-
static readonly FIGURE:VariableTypeType;
|
|
2478
|
-
static readonly OTHERWIDGET:VariableTypeType;
|
|
2479
|
-
static readonly PANDAS:VariableTypeType;
|
|
2480
|
-
static readonly TREEMAP:VariableTypeType;
|
|
2480
|
+
type SearchDisplayModeType = string;
|
|
2481
|
+
export class SearchDisplayMode {
|
|
2482
|
+
static readonly SEARCH_DISPLAY_DEFAULT:SearchDisplayModeType;
|
|
2483
|
+
static readonly SEARCH_DISPLAY_HIDE:SearchDisplayModeType;
|
|
2484
|
+
static readonly SEARCH_DISPLAY_SHOW:SearchDisplayModeType;
|
|
2481
2485
|
}
|
|
2482
2486
|
|
|
2483
2487
|
/**
|
|
@@ -2501,129 +2505,249 @@ export namespace dh {
|
|
|
2501
2505
|
static readonly SKIP:AggregationOperationType;
|
|
2502
2506
|
}
|
|
2503
2507
|
|
|
2504
|
-
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
|
|
2508
|
+
/**
|
|
2509
|
+
* A set of string constants that can be used to describe the different objects the JS API can export.
|
|
2510
|
+
*/
|
|
2511
|
+
type VariableTypeType = string;
|
|
2512
|
+
export class VariableType {
|
|
2513
|
+
static readonly TABLE:VariableTypeType;
|
|
2514
|
+
static readonly TREETABLE:VariableTypeType;
|
|
2515
|
+
static readonly HIERARCHICALTABLE:VariableTypeType;
|
|
2516
|
+
static readonly TABLEMAP:VariableTypeType;
|
|
2517
|
+
static readonly PARTITIONEDTABLE:VariableTypeType;
|
|
2518
|
+
static readonly FIGURE:VariableTypeType;
|
|
2519
|
+
static readonly OTHERWIDGET:VariableTypeType;
|
|
2520
|
+
static readonly PANDAS:VariableTypeType;
|
|
2521
|
+
static readonly TREEMAP:VariableTypeType;
|
|
2509
2522
|
}
|
|
2510
2523
|
|
|
2511
2524
|
}
|
|
2512
2525
|
|
|
2513
2526
|
export namespace dh.ide {
|
|
2514
2527
|
|
|
2528
|
+
/**
|
|
2529
|
+
* Represents a serialized fishlib LogRecord, suitable for display on javascript clients. A log entry sent from the
|
|
2530
|
+
* server.
|
|
2531
|
+
*/
|
|
2532
|
+
export interface LogItem {
|
|
2533
|
+
/**
|
|
2534
|
+
* The level of the log message, enabling the client to ignore messages.
|
|
2535
|
+
* @return String
|
|
2536
|
+
*/
|
|
2537
|
+
get logLevel():string;
|
|
2538
|
+
/**
|
|
2539
|
+
* Timestamp of the message in microseconds since Jan 1, 1970 UTC.
|
|
2540
|
+
* @return double
|
|
2541
|
+
*/
|
|
2542
|
+
get micros():number;
|
|
2543
|
+
/**
|
|
2544
|
+
* The log message written on the server.
|
|
2545
|
+
* @return String
|
|
2546
|
+
*/
|
|
2547
|
+
get message():string;
|
|
2548
|
+
}
|
|
2515
2549
|
/**
|
|
2516
2550
|
* Indicates the result of code run on the server.
|
|
2517
2551
|
*/
|
|
2518
|
-
export interface CommandResult {
|
|
2519
|
-
/**
|
|
2520
|
-
* Describes changes made in the course of this command.
|
|
2521
|
-
* @return {@link dh.ide.VariableChanges}.
|
|
2522
|
-
*/
|
|
2523
|
-
get changes():VariableChanges;
|
|
2552
|
+
export interface CommandResult {
|
|
2553
|
+
/**
|
|
2554
|
+
* Describes changes made in the course of this command.
|
|
2555
|
+
* @return {@link dh.ide.VariableChanges}.
|
|
2556
|
+
*/
|
|
2557
|
+
get changes():VariableChanges;
|
|
2558
|
+
/**
|
|
2559
|
+
* If the command failed, the error message will be provided here.
|
|
2560
|
+
* @return String
|
|
2561
|
+
*/
|
|
2562
|
+
get error():string;
|
|
2563
|
+
}
|
|
2564
|
+
/**
|
|
2565
|
+
* Describes changes in the current set of variables in the script session. Note that variables that changed value
|
|
2566
|
+
* without changing type will be included as <b>updated</b>, but if a new value with one type replaces an old value with
|
|
2567
|
+
* a different type, this will be included as an entry in both <b>removed</b> and <b>created</b> to indicate the old and
|
|
2568
|
+
* new types.
|
|
2569
|
+
*/
|
|
2570
|
+
export interface VariableChanges {
|
|
2571
|
+
/**
|
|
2572
|
+
*
|
|
2573
|
+
* @return The variables that no longer exist after this operation, or were replaced by some variable with a
|
|
2574
|
+
* different type.
|
|
2575
|
+
*/
|
|
2576
|
+
get removed():Array<VariableDefinition>;
|
|
2577
|
+
/**
|
|
2578
|
+
*
|
|
2579
|
+
* @return The variables that were created by this operation, or have a new type.
|
|
2580
|
+
*/
|
|
2581
|
+
get created():Array<VariableDefinition>;
|
|
2582
|
+
/**
|
|
2583
|
+
*
|
|
2584
|
+
* @return The variables that changed value during this operation.
|
|
2585
|
+
*/
|
|
2586
|
+
get updated():Array<VariableDefinition>;
|
|
2587
|
+
}
|
|
2588
|
+
/**
|
|
2589
|
+
* Specifies a type and either id or name (but not both).
|
|
2590
|
+
*/
|
|
2591
|
+
export interface VariableDescriptor {
|
|
2592
|
+
type:string;
|
|
2593
|
+
id?:string|null;
|
|
2594
|
+
name?:string|null;
|
|
2595
|
+
}
|
|
2596
|
+
/**
|
|
2597
|
+
* A format to describe a variable available to be read from the server. Application fields are optional, and only
|
|
2598
|
+
* populated when a variable is provided by application mode.
|
|
2599
|
+
* <p>
|
|
2600
|
+
* APIs which take a VariableDefinition must at least be provided an object with a <b>type</b> and <b>id</b> field.
|
|
2601
|
+
*/
|
|
2602
|
+
export interface VariableDefinition {
|
|
2603
|
+
get name():string;
|
|
2604
|
+
/**
|
|
2605
|
+
* Optional description for the variable's contents, typically used to provide more detail that wouldn't be
|
|
2606
|
+
* reasonable to put in the title
|
|
2607
|
+
* @return String
|
|
2608
|
+
*/
|
|
2609
|
+
get description():string;
|
|
2610
|
+
/**
|
|
2611
|
+
* An opaque identifier for this variable
|
|
2612
|
+
* @return String
|
|
2613
|
+
*/
|
|
2614
|
+
get id():string;
|
|
2615
|
+
/**
|
|
2616
|
+
* The type of the variable, one of <b>dh.VariableType</b>
|
|
2617
|
+
* @return dh.VariableType.
|
|
2618
|
+
*/
|
|
2619
|
+
get type():dh.VariableTypeType;
|
|
2620
|
+
/**
|
|
2621
|
+
* The name of the variable, to be used when rendering it to a user
|
|
2622
|
+
* @return String
|
|
2623
|
+
*/
|
|
2624
|
+
get title():string;
|
|
2625
|
+
/**
|
|
2626
|
+
* Optional description for the variable's contents, typically used to provide more detail that wouldn't be
|
|
2627
|
+
* reasonable to put in the title
|
|
2628
|
+
* @return String
|
|
2629
|
+
*/
|
|
2630
|
+
get applicationId():string;
|
|
2631
|
+
/**
|
|
2632
|
+
* The name of the application which provided this variable
|
|
2633
|
+
* @return String
|
|
2634
|
+
*/
|
|
2635
|
+
get applicationName():string;
|
|
2636
|
+
}
|
|
2637
|
+
}
|
|
2638
|
+
|
|
2639
|
+
export namespace dh.i18n {
|
|
2640
|
+
|
|
2641
|
+
/**
|
|
2642
|
+
* Represents the timezones supported by Deephaven. Can be used to format dates, taking into account the offset changing
|
|
2643
|
+
* throughout the year (potentially changing each year). These instances mostly are useful at this time to pass to the
|
|
2644
|
+
* <b>DateTimeFormat.format()</b> methods, though also support a few properties at this time to see details about each
|
|
2645
|
+
* instance.
|
|
2646
|
+
*
|
|
2647
|
+
*
|
|
2648
|
+
* The following timezone codes are supported when getting a timezone object - instances appearing in the same line will
|
|
2649
|
+
* return the same details:
|
|
2650
|
+
*
|
|
2651
|
+
* <ul>
|
|
2652
|
+
* <li>GMT/UTC</li>
|
|
2653
|
+
* <li>Asia/Tokyo</li>
|
|
2654
|
+
* <li>Asia/Seoul</li>
|
|
2655
|
+
* <li>Asia/Hong_Kong</li>
|
|
2656
|
+
* <li>Asia/Singapore</li>
|
|
2657
|
+
* <li>Asia/Calcutta/Asia/Kolkata</li>
|
|
2658
|
+
* <li>Europe/Berlin</li>
|
|
2659
|
+
* <li>Europe/London</li>
|
|
2660
|
+
* <li>America/Sao_Paulo</li>
|
|
2661
|
+
* <li>America/St_Johns</li>
|
|
2662
|
+
* <li>America/Halifax</li>
|
|
2663
|
+
* <li>America/New_York</li>
|
|
2664
|
+
* <li>America/Chicago</li>
|
|
2665
|
+
* <li>America/Denver</li>
|
|
2666
|
+
* <li>America/Los_Angeles</li>
|
|
2667
|
+
* <li>America/Anchorage</li>
|
|
2668
|
+
* <li>Pacific/Honolulu</li>
|
|
2669
|
+
* </ul>
|
|
2670
|
+
*
|
|
2671
|
+
* A Timezone object can also be created from an abbreviation. The following abbreviations are supported:
|
|
2672
|
+
*
|
|
2673
|
+
* <ul>
|
|
2674
|
+
* <li>UTC</li>
|
|
2675
|
+
* <li>GMT</li>
|
|
2676
|
+
* <li>Z</li>
|
|
2677
|
+
* <li>NY</li>
|
|
2678
|
+
* <li>ET</li>
|
|
2679
|
+
* <li>EST</li>
|
|
2680
|
+
* <li>EDT</li>
|
|
2681
|
+
* <li>MN</li>
|
|
2682
|
+
* <li>CT</li>
|
|
2683
|
+
* <li>CST</li>
|
|
2684
|
+
* <li>CDT</li>
|
|
2685
|
+
* <li>MT</li>
|
|
2686
|
+
* <li>MST</li>
|
|
2687
|
+
* <li>MDT</li>
|
|
2688
|
+
* <li>PT</li>
|
|
2689
|
+
* <li>PST</li>
|
|
2690
|
+
* <li>PDT</li>
|
|
2691
|
+
* <li>HI</li>
|
|
2692
|
+
* <li>HST</li>
|
|
2693
|
+
* <li>HDT</li>
|
|
2694
|
+
* <li>BT</li>
|
|
2695
|
+
* <li>BRST</li>
|
|
2696
|
+
* <li>BRT</li>
|
|
2697
|
+
* <li>KR</li>
|
|
2698
|
+
* <li>KST</li>
|
|
2699
|
+
* <li>HK</li>
|
|
2700
|
+
* <li>HKT</li>
|
|
2701
|
+
* <li>JP</li>
|
|
2702
|
+
* <li>JST</li>
|
|
2703
|
+
* <li>AT</li>
|
|
2704
|
+
* <li>AST</li>
|
|
2705
|
+
* <li>ADT</li>
|
|
2706
|
+
* <li>NF</li>
|
|
2707
|
+
* <li>NST</li>
|
|
2708
|
+
* <li>NDT</li>
|
|
2709
|
+
* <li>AL</li>
|
|
2710
|
+
* <li>AKST</li>
|
|
2711
|
+
* <li>AKDT</li>
|
|
2712
|
+
* <li>IN</li>
|
|
2713
|
+
* <li>IST</li>
|
|
2714
|
+
* <li>CE</li>
|
|
2715
|
+
* <li>CET</li>
|
|
2716
|
+
* <li>CEST</li>
|
|
2717
|
+
* <li>SG</li>
|
|
2718
|
+
* <li>SGT</li>
|
|
2719
|
+
* <li>LON</li>
|
|
2720
|
+
* <li>BST</li>
|
|
2721
|
+
* <li>MOS</li>
|
|
2722
|
+
* <li>SHG</li>
|
|
2723
|
+
* <li>CH</li>
|
|
2724
|
+
* <li>NL</li>
|
|
2725
|
+
* <li>TW</li>
|
|
2726
|
+
* <li>SYD</li>
|
|
2727
|
+
* <li>AEST</li>
|
|
2728
|
+
* <li>AEDT</li>
|
|
2729
|
+
* </ul>
|
|
2730
|
+
*/
|
|
2731
|
+
export class TimeZone {
|
|
2732
|
+
protected constructor();
|
|
2733
|
+
|
|
2524
2734
|
/**
|
|
2525
|
-
*
|
|
2526
|
-
* @
|
|
2735
|
+
* Factory method which creates timezone instances from one of the supported keys.
|
|
2736
|
+
* @param tzCode -
|
|
2737
|
+
* @return dh.i18n.TimeZone
|
|
2527
2738
|
*/
|
|
2528
|
-
|
|
2529
|
-
}
|
|
2530
|
-
/**
|
|
2531
|
-
* A format to describe a variable available to be read from the server. Application fields are optional, and only
|
|
2532
|
-
* populated when a variable is provided by application mode.
|
|
2533
|
-
* <p>
|
|
2534
|
-
* APIs which take a VariableDefinition must at least be provided an object with a <b>type</b> and <b>id</b> field.
|
|
2535
|
-
*/
|
|
2536
|
-
export interface VariableDefinition {
|
|
2537
|
-
get name():string;
|
|
2739
|
+
static getTimeZone(tzCode:string):TimeZone;
|
|
2538
2740
|
/**
|
|
2539
|
-
*
|
|
2540
|
-
*
|
|
2541
|
-
* @return String
|
|
2741
|
+
* the standard offset of this timezone, in minutes
|
|
2742
|
+
* @return int
|
|
2542
2743
|
*/
|
|
2543
|
-
get
|
|
2744
|
+
get standardOffset():number;
|
|
2544
2745
|
/**
|
|
2545
|
-
*
|
|
2746
|
+
* the timezone code that represents this `TimeZone`, usually the same key as was use to create this instance
|
|
2546
2747
|
* @return String
|
|
2547
2748
|
*/
|
|
2548
2749
|
get id():string;
|
|
2549
|
-
/**
|
|
2550
|
-
* The type of the variable, one of <b>dh.VariableType</b>
|
|
2551
|
-
* @return dh.VariableType.
|
|
2552
|
-
*/
|
|
2553
|
-
get type():dh.VariableTypeType;
|
|
2554
|
-
/**
|
|
2555
|
-
* The name of the variable, to be used when rendering it to a user
|
|
2556
|
-
* @return String
|
|
2557
|
-
*/
|
|
2558
|
-
get title():string;
|
|
2559
|
-
/**
|
|
2560
|
-
* Optional description for the variable's contents, typically used to provide more detail that wouldn't be
|
|
2561
|
-
* reasonable to put in the title
|
|
2562
|
-
* @return String
|
|
2563
|
-
*/
|
|
2564
|
-
get applicationId():string;
|
|
2565
|
-
/**
|
|
2566
|
-
* The name of the application which provided this variable
|
|
2567
|
-
* @return String
|
|
2568
|
-
*/
|
|
2569
|
-
get applicationName():string;
|
|
2570
|
-
}
|
|
2571
|
-
/**
|
|
2572
|
-
* Represents a serialized fishlib LogRecord, suitable for display on javascript clients. A log entry sent from the
|
|
2573
|
-
* server.
|
|
2574
|
-
*/
|
|
2575
|
-
export interface LogItem {
|
|
2576
|
-
/**
|
|
2577
|
-
* The level of the log message, enabling the client to ignore messages.
|
|
2578
|
-
* @return String
|
|
2579
|
-
*/
|
|
2580
|
-
get logLevel():string;
|
|
2581
|
-
/**
|
|
2582
|
-
* Timestamp of the message in microseconds since Jan 1, 1970 UTC.
|
|
2583
|
-
* @return double
|
|
2584
|
-
*/
|
|
2585
|
-
get micros():number;
|
|
2586
|
-
/**
|
|
2587
|
-
* The log message written on the server.
|
|
2588
|
-
* @return String
|
|
2589
|
-
*/
|
|
2590
|
-
get message():string;
|
|
2591
|
-
}
|
|
2592
|
-
/**
|
|
2593
|
-
* Specifies a type and either id or name (but not both).
|
|
2594
|
-
*/
|
|
2595
|
-
export interface VariableDescriptor {
|
|
2596
|
-
type:string;
|
|
2597
|
-
id?:string|null;
|
|
2598
|
-
name?:string|null;
|
|
2599
|
-
}
|
|
2600
|
-
/**
|
|
2601
|
-
* Describes changes in the current set of variables in the script session. Note that variables that changed value
|
|
2602
|
-
* without changing type will be included as <b>updated</b>, but if a new value with one type replaces an old value with
|
|
2603
|
-
* a different type, this will be included as an entry in both <b>removed</b> and <b>created</b> to indicate the old and
|
|
2604
|
-
* new types.
|
|
2605
|
-
*/
|
|
2606
|
-
export interface VariableChanges {
|
|
2607
|
-
/**
|
|
2608
|
-
*
|
|
2609
|
-
* @return The variables that no longer exist after this operation, or were replaced by some variable with a
|
|
2610
|
-
* different type.
|
|
2611
|
-
*/
|
|
2612
|
-
get removed():Array<VariableDefinition>;
|
|
2613
|
-
/**
|
|
2614
|
-
*
|
|
2615
|
-
* @return The variables that were created by this operation, or have a new type.
|
|
2616
|
-
*/
|
|
2617
|
-
get created():Array<VariableDefinition>;
|
|
2618
|
-
/**
|
|
2619
|
-
*
|
|
2620
|
-
* @return The variables that changed value during this operation.
|
|
2621
|
-
*/
|
|
2622
|
-
get updated():Array<VariableDefinition>;
|
|
2623
2750
|
}
|
|
2624
|
-
}
|
|
2625
|
-
|
|
2626
|
-
export namespace dh.i18n {
|
|
2627
2751
|
|
|
2628
2752
|
/**
|
|
2629
2753
|
* Exported wrapper of the GWT NumberFormat, plus LongWrapper support
|
|
@@ -2732,166 +2856,146 @@ export namespace dh.i18n {
|
|
|
2732
2856
|
* @param timeZone -
|
|
2733
2857
|
* @return
|
|
2734
2858
|
*/
|
|
2735
|
-
static format(pattern:string, date:any, timeZone?:TimeZone):string;
|
|
2736
|
-
/**
|
|
2737
|
-
* Parses the given input string using the provided pattern, and returns a JS `Date` object in milliseconds.
|
|
2738
|
-
* @param pattern -
|
|
2739
|
-
* @param text -
|
|
2740
|
-
* @return
|
|
2741
|
-
*/
|
|
2742
|
-
static parseAsDate(pattern:string, text:string):Date;
|
|
2743
|
-
/**
|
|
2744
|
-
* Parses the given input string using the provided pattern, and returns a wrapped Java `long` value in nanoseconds.
|
|
2745
|
-
* A `TimeZone` object can optionally be provided to parse to a desired timezone.
|
|
2746
|
-
* @param pattern -
|
|
2747
|
-
* @param text -
|
|
2748
|
-
* @param tz -
|
|
2749
|
-
* @return
|
|
2750
|
-
*/
|
|
2751
|
-
static parse(pattern:string, text:string, tz?:TimeZone):dh.DateWrapper;
|
|
2752
|
-
/**
|
|
2753
|
-
* Takes a variety of objects to interpret as a date, and formats them using this instance's pattern. Inputs can
|
|
2754
|
-
* include a <b>String</b> value of a number expressed in nanoseconds, a <b>Number</b> value expressed in
|
|
2755
|
-
* nanoseconds, a JS <b>Date</b> object (necessarily in milliseconds), or a wrapped Java <b>long</b> value,
|
|
2756
|
-
* expressed in nanoseconds. A <b>TimeZone</b> object can optionally be provided to format this date as the current
|
|
2757
|
-
* date/time in that timezone.
|
|
2758
|
-
* @param date -
|
|
2759
|
-
* @param timeZone -
|
|
2760
|
-
* @return String
|
|
2761
|
-
*/
|
|
2762
|
-
format(date:any, timeZone?:TimeZone):string;
|
|
2763
|
-
/**
|
|
2764
|
-
* Parses the given string using this instance's pattern, and returns a wrapped Java <b>long</b> value in
|
|
2765
|
-
* nanoseconds. A <b>TimeZone</b> object can optionally be provided to parse to a desired timezone.
|
|
2766
|
-
* @param text -
|
|
2767
|
-
* @param tz -
|
|
2768
|
-
* @return
|
|
2769
|
-
*/
|
|
2770
|
-
parse(text:string, tz?:TimeZone):dh.DateWrapper;
|
|
2771
|
-
/**
|
|
2772
|
-
* Parses the given string using this instance's pattern, and returns a JS <b>Date</b> object in milliseconds.
|
|
2773
|
-
* @param text -
|
|
2774
|
-
* @return
|
|
2775
|
-
*/
|
|
2776
|
-
parseAsDate(text:string):Date;
|
|
2777
|
-
toString():string;
|
|
2778
|
-
}
|
|
2779
|
-
|
|
2780
|
-
/**
|
|
2781
|
-
* Represents the timezones supported by Deephaven. Can be used to format dates, taking into account the offset changing
|
|
2782
|
-
* throughout the year (potentially changing each year). These instances mostly are useful at this time to pass to the
|
|
2783
|
-
* <b>DateTimeFormat.format()</b> methods, though also support a few properties at this time to see details about each
|
|
2784
|
-
* instance.
|
|
2785
|
-
*
|
|
2786
|
-
*
|
|
2787
|
-
* The following timezone codes are supported when getting a timezone object - instances appearing in the same line will
|
|
2788
|
-
* return the same details:
|
|
2789
|
-
*
|
|
2790
|
-
* <ul>
|
|
2791
|
-
* <li>GMT/UTC</li>
|
|
2792
|
-
* <li>Asia/Tokyo</li>
|
|
2793
|
-
* <li>Asia/Seoul</li>
|
|
2794
|
-
* <li>Asia/Hong_Kong</li>
|
|
2795
|
-
* <li>Asia/Singapore</li>
|
|
2796
|
-
* <li>Asia/Calcutta/Asia/Kolkata</li>
|
|
2797
|
-
* <li>Europe/Berlin</li>
|
|
2798
|
-
* <li>Europe/London</li>
|
|
2799
|
-
* <li>America/Sao_Paulo</li>
|
|
2800
|
-
* <li>America/St_Johns</li>
|
|
2801
|
-
* <li>America/Halifax</li>
|
|
2802
|
-
* <li>America/New_York</li>
|
|
2803
|
-
* <li>America/Chicago</li>
|
|
2804
|
-
* <li>America/Denver</li>
|
|
2805
|
-
* <li>America/Los_Angeles</li>
|
|
2806
|
-
* <li>America/Anchorage</li>
|
|
2807
|
-
* <li>Pacific/Honolulu</li>
|
|
2808
|
-
* </ul>
|
|
2809
|
-
*
|
|
2810
|
-
* A Timezone object can also be created from an abbreviation. The following abbreviations are supported:
|
|
2811
|
-
*
|
|
2812
|
-
* <ul>
|
|
2813
|
-
* <li>UTC</li>
|
|
2814
|
-
* <li>GMT</li>
|
|
2815
|
-
* <li>Z</li>
|
|
2816
|
-
* <li>NY</li>
|
|
2817
|
-
* <li>ET</li>
|
|
2818
|
-
* <li>EST</li>
|
|
2819
|
-
* <li>EDT</li>
|
|
2820
|
-
* <li>MN</li>
|
|
2821
|
-
* <li>CT</li>
|
|
2822
|
-
* <li>CST</li>
|
|
2823
|
-
* <li>CDT</li>
|
|
2824
|
-
* <li>MT</li>
|
|
2825
|
-
* <li>MST</li>
|
|
2826
|
-
* <li>MDT</li>
|
|
2827
|
-
* <li>PT</li>
|
|
2828
|
-
* <li>PST</li>
|
|
2829
|
-
* <li>PDT</li>
|
|
2830
|
-
* <li>HI</li>
|
|
2831
|
-
* <li>HST</li>
|
|
2832
|
-
* <li>HDT</li>
|
|
2833
|
-
* <li>BT</li>
|
|
2834
|
-
* <li>BRST</li>
|
|
2835
|
-
* <li>BRT</li>
|
|
2836
|
-
* <li>KR</li>
|
|
2837
|
-
* <li>KST</li>
|
|
2838
|
-
* <li>HK</li>
|
|
2839
|
-
* <li>HKT</li>
|
|
2840
|
-
* <li>JP</li>
|
|
2841
|
-
* <li>JST</li>
|
|
2842
|
-
* <li>AT</li>
|
|
2843
|
-
* <li>AST</li>
|
|
2844
|
-
* <li>ADT</li>
|
|
2845
|
-
* <li>NF</li>
|
|
2846
|
-
* <li>NST</li>
|
|
2847
|
-
* <li>NDT</li>
|
|
2848
|
-
* <li>AL</li>
|
|
2849
|
-
* <li>AKST</li>
|
|
2850
|
-
* <li>AKDT</li>
|
|
2851
|
-
* <li>IN</li>
|
|
2852
|
-
* <li>IST</li>
|
|
2853
|
-
* <li>CE</li>
|
|
2854
|
-
* <li>CET</li>
|
|
2855
|
-
* <li>CEST</li>
|
|
2856
|
-
* <li>SG</li>
|
|
2857
|
-
* <li>SGT</li>
|
|
2858
|
-
* <li>LON</li>
|
|
2859
|
-
* <li>BST</li>
|
|
2860
|
-
* <li>MOS</li>
|
|
2861
|
-
* <li>SHG</li>
|
|
2862
|
-
* <li>CH</li>
|
|
2863
|
-
* <li>NL</li>
|
|
2864
|
-
* <li>TW</li>
|
|
2865
|
-
* <li>SYD</li>
|
|
2866
|
-
* <li>AEST</li>
|
|
2867
|
-
* <li>AEDT</li>
|
|
2868
|
-
* </ul>
|
|
2869
|
-
*/
|
|
2870
|
-
export class TimeZone {
|
|
2871
|
-
protected constructor();
|
|
2872
|
-
|
|
2859
|
+
static format(pattern:string, date:any, timeZone?:TimeZone):string;
|
|
2873
2860
|
/**
|
|
2874
|
-
*
|
|
2875
|
-
* @param
|
|
2876
|
-
* @
|
|
2861
|
+
* Parses the given input string using the provided pattern, and returns a JS `Date` object in milliseconds.
|
|
2862
|
+
* @param pattern -
|
|
2863
|
+
* @param text -
|
|
2864
|
+
* @return
|
|
2877
2865
|
*/
|
|
2878
|
-
static
|
|
2866
|
+
static parseAsDate(pattern:string, text:string):Date;
|
|
2879
2867
|
/**
|
|
2880
|
-
* the
|
|
2881
|
-
*
|
|
2868
|
+
* Parses the given input string using the provided pattern, and returns a wrapped Java `long` value in nanoseconds.
|
|
2869
|
+
* A `TimeZone` object can optionally be provided to parse to a desired timezone.
|
|
2870
|
+
* @param pattern -
|
|
2871
|
+
* @param text -
|
|
2872
|
+
* @param tz -
|
|
2873
|
+
* @return
|
|
2882
2874
|
*/
|
|
2883
|
-
|
|
2875
|
+
static parse(pattern:string, text:string, tz?:TimeZone):dh.DateWrapper;
|
|
2884
2876
|
/**
|
|
2885
|
-
*
|
|
2877
|
+
* Takes a variety of objects to interpret as a date, and formats them using this instance's pattern. Inputs can
|
|
2878
|
+
* include a <b>String</b> value of a number expressed in nanoseconds, a <b>Number</b> value expressed in
|
|
2879
|
+
* nanoseconds, a JS <b>Date</b> object (necessarily in milliseconds), or a wrapped Java <b>long</b> value,
|
|
2880
|
+
* expressed in nanoseconds. A <b>TimeZone</b> object can optionally be provided to format this date as the current
|
|
2881
|
+
* date/time in that timezone.
|
|
2882
|
+
* @param date -
|
|
2883
|
+
* @param timeZone -
|
|
2886
2884
|
* @return String
|
|
2887
2885
|
*/
|
|
2888
|
-
|
|
2886
|
+
format(date:any, timeZone?:TimeZone):string;
|
|
2887
|
+
/**
|
|
2888
|
+
* Parses the given string using this instance's pattern, and returns a wrapped Java <b>long</b> value in
|
|
2889
|
+
* nanoseconds. A <b>TimeZone</b> object can optionally be provided to parse to a desired timezone.
|
|
2890
|
+
* @param text -
|
|
2891
|
+
* @param tz -
|
|
2892
|
+
* @return
|
|
2893
|
+
*/
|
|
2894
|
+
parse(text:string, tz?:TimeZone):dh.DateWrapper;
|
|
2895
|
+
/**
|
|
2896
|
+
* Parses the given string using this instance's pattern, and returns a JS <b>Date</b> object in milliseconds.
|
|
2897
|
+
* @param text -
|
|
2898
|
+
* @return
|
|
2899
|
+
*/
|
|
2900
|
+
parseAsDate(text:string):Date;
|
|
2901
|
+
toString():string;
|
|
2889
2902
|
}
|
|
2890
2903
|
|
|
2891
2904
|
}
|
|
2892
2905
|
|
|
2906
|
+
export namespace dh.grpc {
|
|
2907
|
+
|
|
2908
|
+
/**
|
|
2909
|
+
* gRPC transport implementation.
|
|
2910
|
+
*/
|
|
2911
|
+
export interface GrpcTransport {
|
|
2912
|
+
/**
|
|
2913
|
+
* Starts the stream, sending metadata to the server.
|
|
2914
|
+
* @param metadata - the headers to send the server when opening the connection
|
|
2915
|
+
*/
|
|
2916
|
+
start(metadata:{ [key: string]: string|Array<string>; }):void;
|
|
2917
|
+
/**
|
|
2918
|
+
* Sends a message to the server.
|
|
2919
|
+
* @param msgBytes - bytes to send to the server
|
|
2920
|
+
*/
|
|
2921
|
+
sendMessage(msgBytes:Uint8Array):void;
|
|
2922
|
+
/**
|
|
2923
|
+
* "Half close" the stream, signaling to the server that no more messages will be sent, but that the client is still
|
|
2924
|
+
* open to receiving messages.
|
|
2925
|
+
*/
|
|
2926
|
+
finishSend():void;
|
|
2927
|
+
/**
|
|
2928
|
+
* End the stream, both notifying the server that no more messages will be sent nor received, and preventing the
|
|
2929
|
+
* client from receiving any more events.
|
|
2930
|
+
*/
|
|
2931
|
+
cancel():void;
|
|
2932
|
+
}
|
|
2933
|
+
/**
|
|
2934
|
+
* Options for creating a gRPC stream transport instance.
|
|
2935
|
+
*/
|
|
2936
|
+
export interface GrpcTransportOptions {
|
|
2937
|
+
/**
|
|
2938
|
+
* The gRPC method URL.
|
|
2939
|
+
*/
|
|
2940
|
+
url:URL;
|
|
2941
|
+
/**
|
|
2942
|
+
* True to enable debug logging for this stream.
|
|
2943
|
+
*/
|
|
2944
|
+
debug:boolean;
|
|
2945
|
+
/**
|
|
2946
|
+
* Callback for when headers and status are received. The headers are a map of header names to values, and the
|
|
2947
|
+
* status is the HTTP status code. If the connection could not be made, the status should be 0.
|
|
2948
|
+
*/
|
|
2949
|
+
onHeaders:(headers:{ [key: string]: string|Array<string>; },status:number)=>void;
|
|
2950
|
+
/**
|
|
2951
|
+
* Callback for when a chunk of data is received.
|
|
2952
|
+
*/
|
|
2953
|
+
onChunk:(chunk:Uint8Array)=>void;
|
|
2954
|
+
/**
|
|
2955
|
+
* Callback for when the stream ends, with an error instance if it can be provided. Note that the present
|
|
2956
|
+
* implementation does not consume errors, even if provided.
|
|
2957
|
+
*/
|
|
2958
|
+
onEnd:(error?:Error|undefined|null)=>void;
|
|
2959
|
+
}
|
|
2960
|
+
}
|
|
2961
|
+
|
|
2893
2962
|
export namespace dh.plot {
|
|
2894
2963
|
|
|
2964
|
+
/**
|
|
2965
|
+
* Describes a template that will be used to make new series instances when a new table added to a plotBy.
|
|
2966
|
+
*/
|
|
2967
|
+
export interface MultiSeries {
|
|
2968
|
+
/**
|
|
2969
|
+
* The name for this multi-series.
|
|
2970
|
+
* @return String
|
|
2971
|
+
*/
|
|
2972
|
+
get name():string;
|
|
2973
|
+
/**
|
|
2974
|
+
* The plotting style to use for the series that will be created. See <b>SeriesPlotStyle</b> enum for more details.
|
|
2975
|
+
* @return int
|
|
2976
|
+
*/
|
|
2977
|
+
get plotStyle():SeriesPlotStyleType;
|
|
2978
|
+
}
|
|
2979
|
+
/**
|
|
2980
|
+
* Describes how to access and display data required within a series.
|
|
2981
|
+
*/
|
|
2982
|
+
export interface SeriesDataSource {
|
|
2983
|
+
/**
|
|
2984
|
+
* the type of data stored in the underlying table's Column.
|
|
2985
|
+
* @return String
|
|
2986
|
+
*/
|
|
2987
|
+
get columnType():string;
|
|
2988
|
+
/**
|
|
2989
|
+
* the axis that this source should be drawn on.
|
|
2990
|
+
* @return dh.plot.Axis
|
|
2991
|
+
*/
|
|
2992
|
+
get axis():Axis;
|
|
2993
|
+
/**
|
|
2994
|
+
* the feature of this series represented by this source. See the <b>SourceType</b> enum for more details.
|
|
2995
|
+
* @return int
|
|
2996
|
+
*/
|
|
2997
|
+
get type():SourceTypeType;
|
|
2998
|
+
}
|
|
2895
2999
|
export interface OneClick {
|
|
2896
3000
|
setValueForColumn(columnName:string, value:any):void;
|
|
2897
3001
|
getValueForColumn(columName:string):any;
|
|
@@ -3014,41 +3118,6 @@ export namespace dh.plot {
|
|
|
3014
3118
|
get multiSeries():MultiSeries;
|
|
3015
3119
|
get shapeLabel():string;
|
|
3016
3120
|
}
|
|
3017
|
-
/**
|
|
3018
|
-
* Describes a template that will be used to make new series instances when a new table added to a plotBy.
|
|
3019
|
-
*/
|
|
3020
|
-
export interface MultiSeries {
|
|
3021
|
-
/**
|
|
3022
|
-
* The name for this multi-series.
|
|
3023
|
-
* @return String
|
|
3024
|
-
*/
|
|
3025
|
-
get name():string;
|
|
3026
|
-
/**
|
|
3027
|
-
* The plotting style to use for the series that will be created. See <b>SeriesPlotStyle</b> enum for more details.
|
|
3028
|
-
* @return int
|
|
3029
|
-
*/
|
|
3030
|
-
get plotStyle():SeriesPlotStyleType;
|
|
3031
|
-
}
|
|
3032
|
-
/**
|
|
3033
|
-
* Describes how to access and display data required within a series.
|
|
3034
|
-
*/
|
|
3035
|
-
export interface SeriesDataSource {
|
|
3036
|
-
/**
|
|
3037
|
-
* the type of data stored in the underlying table's Column.
|
|
3038
|
-
* @return String
|
|
3039
|
-
*/
|
|
3040
|
-
get columnType():string;
|
|
3041
|
-
/**
|
|
3042
|
-
* the axis that this source should be drawn on.
|
|
3043
|
-
* @return dh.plot.Axis
|
|
3044
|
-
*/
|
|
3045
|
-
get axis():Axis;
|
|
3046
|
-
/**
|
|
3047
|
-
* the feature of this series represented by this source. See the <b>SourceType</b> enum for more details.
|
|
3048
|
-
* @return int
|
|
3049
|
-
*/
|
|
3050
|
-
get type():SourceTypeType;
|
|
3051
|
-
}
|
|
3052
3121
|
|
|
3053
3122
|
export class Figure implements dh.HasEventHandling {
|
|
3054
3123
|
/**
|
|
@@ -3134,23 +3203,6 @@ export namespace dh.plot {
|
|
|
3134
3203
|
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
3135
3204
|
}
|
|
3136
3205
|
|
|
3137
|
-
/**
|
|
3138
|
-
* A descriptor used with JsFigureFactory.create to create a figure from JS.
|
|
3139
|
-
*/
|
|
3140
|
-
export class FigureDescriptor {
|
|
3141
|
-
title?:string|null;
|
|
3142
|
-
titleFont?:string|null;
|
|
3143
|
-
titleColor?:string|null;
|
|
3144
|
-
isResizable?:boolean|null;
|
|
3145
|
-
isDefaultTheme?:boolean|null;
|
|
3146
|
-
updateInterval?:number|null;
|
|
3147
|
-
cols?:number|null;
|
|
3148
|
-
rows?:number|null;
|
|
3149
|
-
charts:Array<ChartDescriptor>;
|
|
3150
|
-
|
|
3151
|
-
constructor();
|
|
3152
|
-
}
|
|
3153
|
-
|
|
3154
3206
|
export class ChartDescriptor {
|
|
3155
3207
|
colspan?:number|null;
|
|
3156
3208
|
rowspan?:number|null;
|
|
@@ -3168,97 +3220,23 @@ export namespace dh.plot {
|
|
|
3168
3220
|
constructor();
|
|
3169
3221
|
}
|
|
3170
3222
|
|
|
3171
|
-
export class FigureFetchError {
|
|
3172
|
-
error:object;
|
|
3173
|
-
errors:Array<string>;
|
|
3174
|
-
|
|
3175
|
-
protected constructor();
|
|
3176
|
-
}
|
|
3177
|
-
|
|
3178
3223
|
/**
|
|
3179
|
-
*
|
|
3224
|
+
* A descriptor used with JsFigureFactory.create to create a figure from JS.
|
|
3180
3225
|
*/
|
|
3181
|
-
export class
|
|
3182
|
-
|
|
3183
|
-
|
|
3184
|
-
|
|
3185
|
-
|
|
3186
|
-
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
|
|
3191
|
-
|
|
3192
|
-
protected constructor();
|
|
3193
|
-
|
|
3194
|
-
addEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):()=>void;
|
|
3195
|
-
nextEvent<T>(eventName:string, timeoutInMillis?:number):Promise<dh.Event<T>>;
|
|
3196
|
-
hasListeners(name:string):boolean;
|
|
3197
|
-
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
3198
|
-
get column():number;
|
|
3199
|
-
get showLegend():boolean;
|
|
3200
|
-
/**
|
|
3201
|
-
* The axes used in this chart.
|
|
3202
|
-
* @return dh.plot.Axis
|
|
3203
|
-
*/
|
|
3204
|
-
get axes():Axis[];
|
|
3205
|
-
get is3d():boolean;
|
|
3206
|
-
get titleFont():string;
|
|
3207
|
-
get colspan():number;
|
|
3208
|
-
get titleColor():string;
|
|
3209
|
-
get series():Series[];
|
|
3210
|
-
get rowspan():number;
|
|
3211
|
-
/**
|
|
3212
|
-
* The type of this chart, see <b>ChartType</b> enum for more details.
|
|
3213
|
-
* @return int
|
|
3214
|
-
*/
|
|
3215
|
-
get chartType():ChartTypeType;
|
|
3216
|
-
get row():number;
|
|
3217
|
-
get legendColor():string;
|
|
3218
|
-
get legendFont():string;
|
|
3219
|
-
get multiSeries():MultiSeries[];
|
|
3220
|
-
}
|
|
3221
|
-
|
|
3222
|
-
export class AxisDescriptor {
|
|
3223
|
-
formatType:string;
|
|
3224
|
-
type:string;
|
|
3225
|
-
position:string;
|
|
3226
|
-
log?:boolean|null;
|
|
3227
|
-
label?:string|null;
|
|
3228
|
-
labelFont?:string|null;
|
|
3229
|
-
ticksFont?:string|null;
|
|
3230
|
-
formatPattern?:string|null;
|
|
3231
|
-
color?:string|null;
|
|
3232
|
-
minRange?:number|null;
|
|
3233
|
-
maxRange?:number|null;
|
|
3234
|
-
minorTicksVisible?:boolean|null;
|
|
3235
|
-
majorTicksVisible?:boolean|null;
|
|
3236
|
-
minorTickCount?:number|null;
|
|
3237
|
-
gapBetweenMajorTicks?:number|null;
|
|
3238
|
-
majorTickLocations?:Array<number>|null;
|
|
3239
|
-
tickLabelAngle?:number|null;
|
|
3240
|
-
invert?:boolean|null;
|
|
3241
|
-
isTimeAxis?:boolean|null;
|
|
3242
|
-
|
|
3243
|
-
constructor();
|
|
3244
|
-
}
|
|
3245
|
-
|
|
3246
|
-
export class SourceDescriptor {
|
|
3247
|
-
axis:AxisDescriptor;
|
|
3248
|
-
table:dh.Table;
|
|
3249
|
-
columnName:string;
|
|
3250
|
-
type:string;
|
|
3226
|
+
export class FigureDescriptor {
|
|
3227
|
+
title?:string|null;
|
|
3228
|
+
titleFont?:string|null;
|
|
3229
|
+
titleColor?:string|null;
|
|
3230
|
+
isResizable?:boolean|null;
|
|
3231
|
+
isDefaultTheme?:boolean|null;
|
|
3232
|
+
updateInterval?:number|null;
|
|
3233
|
+
cols?:number|null;
|
|
3234
|
+
rows?:number|null;
|
|
3235
|
+
charts:Array<ChartDescriptor>;
|
|
3251
3236
|
|
|
3252
3237
|
constructor();
|
|
3253
3238
|
}
|
|
3254
3239
|
|
|
3255
|
-
export class SeriesDataSourceException {
|
|
3256
|
-
protected constructor();
|
|
3257
|
-
|
|
3258
|
-
get source():SeriesDataSource;
|
|
3259
|
-
get message():string;
|
|
3260
|
-
}
|
|
3261
|
-
|
|
3262
3240
|
export class SeriesDescriptor {
|
|
3263
3241
|
plotStyle:string;
|
|
3264
3242
|
name?:string|null;
|
|
@@ -3278,11 +3256,13 @@ export namespace dh.plot {
|
|
|
3278
3256
|
constructor();
|
|
3279
3257
|
}
|
|
3280
3258
|
|
|
3281
|
-
export class
|
|
3259
|
+
export class SourceDescriptor {
|
|
3260
|
+
axis:AxisDescriptor;
|
|
3282
3261
|
table:dh.Table;
|
|
3283
|
-
|
|
3262
|
+
columnName:string;
|
|
3263
|
+
type:string;
|
|
3284
3264
|
|
|
3285
|
-
|
|
3265
|
+
constructor();
|
|
3286
3266
|
}
|
|
3287
3267
|
|
|
3288
3268
|
export class DownsampleOptions {
|
|
@@ -3328,6 +3308,50 @@ export namespace dh.plot {
|
|
|
3328
3308
|
removeColumn(columnName:string, mappingFunc:(arg0:any)=>any):void;
|
|
3329
3309
|
}
|
|
3330
3310
|
|
|
3311
|
+
/**
|
|
3312
|
+
* Provide the details for a chart.
|
|
3313
|
+
*/
|
|
3314
|
+
export class Chart implements dh.HasEventHandling {
|
|
3315
|
+
/**
|
|
3316
|
+
* a new series was added to this chart as part of a multi-series. The series instance is the detail for this event.
|
|
3317
|
+
*/
|
|
3318
|
+
static readonly EVENT_SERIES_ADDED:string;
|
|
3319
|
+
/**
|
|
3320
|
+
* The title of the chart.
|
|
3321
|
+
* @return String
|
|
3322
|
+
*/
|
|
3323
|
+
readonly title?:string|null;
|
|
3324
|
+
|
|
3325
|
+
protected constructor();
|
|
3326
|
+
|
|
3327
|
+
addEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):()=>void;
|
|
3328
|
+
nextEvent<T>(eventName:string, timeoutInMillis?:number):Promise<dh.Event<T>>;
|
|
3329
|
+
hasListeners(name:string):boolean;
|
|
3330
|
+
removeEventListener<T>(name:string, callback:(e:dh.Event<T>)=>void):boolean;
|
|
3331
|
+
get column():number;
|
|
3332
|
+
get showLegend():boolean;
|
|
3333
|
+
/**
|
|
3334
|
+
* The axes used in this chart.
|
|
3335
|
+
* @return dh.plot.Axis
|
|
3336
|
+
*/
|
|
3337
|
+
get axes():Axis[];
|
|
3338
|
+
get is3d():boolean;
|
|
3339
|
+
get titleFont():string;
|
|
3340
|
+
get colspan():number;
|
|
3341
|
+
get titleColor():string;
|
|
3342
|
+
get series():Series[];
|
|
3343
|
+
get rowspan():number;
|
|
3344
|
+
/**
|
|
3345
|
+
* The type of this chart, see <b>ChartType</b> enum for more details.
|
|
3346
|
+
* @return int
|
|
3347
|
+
*/
|
|
3348
|
+
get chartType():ChartTypeType;
|
|
3349
|
+
get row():number;
|
|
3350
|
+
get legendColor():string;
|
|
3351
|
+
get legendFont():string;
|
|
3352
|
+
get multiSeries():MultiSeries[];
|
|
3353
|
+
}
|
|
3354
|
+
|
|
3331
3355
|
/**
|
|
3332
3356
|
* Helper class for plot downsampling methods.
|
|
3333
3357
|
*/
|
|
@@ -3347,23 +3371,52 @@ export namespace dh.plot {
|
|
|
3347
3371
|
static runChartDownsample(table:dh.Table, xCol:string, yCols:string[], width:number, xRange?:dh.LongWrapper[]|undefined|null):Promise<dh.Table>;
|
|
3348
3372
|
}
|
|
3349
3373
|
|
|
3374
|
+
export class AxisDescriptor {
|
|
3375
|
+
formatType:string;
|
|
3376
|
+
type:string;
|
|
3377
|
+
position:string;
|
|
3378
|
+
log?:boolean|null;
|
|
3379
|
+
label?:string|null;
|
|
3380
|
+
labelFont?:string|null;
|
|
3381
|
+
ticksFont?:string|null;
|
|
3382
|
+
formatPattern?:string|null;
|
|
3383
|
+
color?:string|null;
|
|
3384
|
+
minRange?:number|null;
|
|
3385
|
+
maxRange?:number|null;
|
|
3386
|
+
minorTicksVisible?:boolean|null;
|
|
3387
|
+
majorTicksVisible?:boolean|null;
|
|
3388
|
+
minorTickCount?:number|null;
|
|
3389
|
+
gapBetweenMajorTicks?:number|null;
|
|
3390
|
+
majorTickLocations?:Array<number>|null;
|
|
3391
|
+
tickLabelAngle?:number|null;
|
|
3392
|
+
invert?:boolean|null;
|
|
3393
|
+
isTimeAxis?:boolean|null;
|
|
3394
|
+
|
|
3395
|
+
constructor();
|
|
3396
|
+
}
|
|
3397
|
+
|
|
3398
|
+
export class FigureFetchError {
|
|
3399
|
+
error:object;
|
|
3400
|
+
errors:Array<string>;
|
|
3350
3401
|
|
|
3351
|
-
|
|
3352
|
-
|
|
3353
|
-
|
|
3354
|
-
|
|
3355
|
-
|
|
3356
|
-
|
|
3357
|
-
|
|
3358
|
-
|
|
3359
|
-
|
|
3360
|
-
|
|
3361
|
-
|
|
3362
|
-
|
|
3363
|
-
|
|
3364
|
-
|
|
3402
|
+
protected constructor();
|
|
3403
|
+
}
|
|
3404
|
+
|
|
3405
|
+
export class SeriesDataSourceException {
|
|
3406
|
+
protected constructor();
|
|
3407
|
+
|
|
3408
|
+
get source():SeriesDataSource;
|
|
3409
|
+
get message():string;
|
|
3410
|
+
}
|
|
3411
|
+
|
|
3412
|
+
export class FigureSourceException {
|
|
3413
|
+
table:dh.Table;
|
|
3414
|
+
source:SeriesDataSource;
|
|
3415
|
+
|
|
3416
|
+
protected constructor();
|
|
3365
3417
|
}
|
|
3366
3418
|
|
|
3419
|
+
|
|
3367
3420
|
/**
|
|
3368
3421
|
* This enum describes the source it is in, and how this aspect of the data in the series should be used to render the
|
|
3369
3422
|
* item. For example, a point in a error-bar plot might have a X value, three Y values (Y, Y_LOW, Y_HIGH), and some
|
|
@@ -3393,10 +3446,19 @@ export namespace dh.plot {
|
|
|
3393
3446
|
static readonly HOVER_TEXT:SourceTypeType;
|
|
3394
3447
|
}
|
|
3395
3448
|
|
|
3396
|
-
|
|
3397
|
-
|
|
3398
|
-
|
|
3399
|
-
|
|
3449
|
+
/**
|
|
3450
|
+
* This enum describes what kind of chart is being drawn. This may limit what kinds of series can be found on it, or how
|
|
3451
|
+
* those series should be rendered.
|
|
3452
|
+
*/
|
|
3453
|
+
type ChartTypeType = number;
|
|
3454
|
+
export class ChartType {
|
|
3455
|
+
static readonly XY:ChartTypeType;
|
|
3456
|
+
static readonly PIE:ChartTypeType;
|
|
3457
|
+
static readonly OHLC:ChartTypeType;
|
|
3458
|
+
static readonly CATEGORY:ChartTypeType;
|
|
3459
|
+
static readonly XYZ:ChartTypeType;
|
|
3460
|
+
static readonly CATEGORY_3D:ChartTypeType;
|
|
3461
|
+
static readonly TREEMAP:ChartTypeType;
|
|
3400
3462
|
}
|
|
3401
3463
|
|
|
3402
3464
|
type AxisTypeType = number;
|
|
@@ -3409,6 +3471,22 @@ export namespace dh.plot {
|
|
|
3409
3471
|
static readonly COLOR:AxisTypeType;
|
|
3410
3472
|
}
|
|
3411
3473
|
|
|
3474
|
+
type SeriesPlotStyleType = number;
|
|
3475
|
+
export class SeriesPlotStyle {
|
|
3476
|
+
static readonly BAR:SeriesPlotStyleType;
|
|
3477
|
+
static readonly STACKED_BAR:SeriesPlotStyleType;
|
|
3478
|
+
static readonly LINE:SeriesPlotStyleType;
|
|
3479
|
+
static readonly AREA:SeriesPlotStyleType;
|
|
3480
|
+
static readonly STACKED_AREA:SeriesPlotStyleType;
|
|
3481
|
+
static readonly PIE:SeriesPlotStyleType;
|
|
3482
|
+
static readonly HISTOGRAM:SeriesPlotStyleType;
|
|
3483
|
+
static readonly OHLC:SeriesPlotStyleType;
|
|
3484
|
+
static readonly SCATTER:SeriesPlotStyleType;
|
|
3485
|
+
static readonly STEP:SeriesPlotStyleType;
|
|
3486
|
+
static readonly ERROR_BAR:SeriesPlotStyleType;
|
|
3487
|
+
static readonly TREEMAP:SeriesPlotStyleType;
|
|
3488
|
+
}
|
|
3489
|
+
|
|
3412
3490
|
type AxisPositionType = number;
|
|
3413
3491
|
export class AxisPosition {
|
|
3414
3492
|
static readonly TOP:AxisPositionType;
|
|
@@ -3418,33 +3496,16 @@ export namespace dh.plot {
|
|
|
3418
3496
|
static readonly NONE:AxisPositionType;
|
|
3419
3497
|
}
|
|
3420
3498
|
|
|
3421
|
-
|
|
3422
|
-
|
|
3423
|
-
|
|
3424
|
-
|
|
3425
|
-
type ChartTypeType = number;
|
|
3426
|
-
export class ChartType {
|
|
3427
|
-
static readonly XY:ChartTypeType;
|
|
3428
|
-
static readonly PIE:ChartTypeType;
|
|
3429
|
-
static readonly OHLC:ChartTypeType;
|
|
3430
|
-
static readonly CATEGORY:ChartTypeType;
|
|
3431
|
-
static readonly XYZ:ChartTypeType;
|
|
3432
|
-
static readonly CATEGORY_3D:ChartTypeType;
|
|
3433
|
-
static readonly TREEMAP:ChartTypeType;
|
|
3499
|
+
type AxisFormatTypeType = number;
|
|
3500
|
+
export class AxisFormatType {
|
|
3501
|
+
static readonly CATEGORY:AxisFormatTypeType;
|
|
3502
|
+
static readonly NUMBER:AxisFormatTypeType;
|
|
3434
3503
|
}
|
|
3435
3504
|
|
|
3436
3505
|
}
|
|
3437
3506
|
|
|
3438
3507
|
export namespace dh.lsp {
|
|
3439
3508
|
|
|
3440
|
-
export class TextDocumentContentChangeEvent {
|
|
3441
|
-
range:Range;
|
|
3442
|
-
rangeLength:number;
|
|
3443
|
-
text:string;
|
|
3444
|
-
|
|
3445
|
-
constructor();
|
|
3446
|
-
}
|
|
3447
|
-
|
|
3448
3509
|
export class MarkupContent {
|
|
3449
3510
|
kind:string;
|
|
3450
3511
|
value:string;
|
|
@@ -3452,33 +3513,27 @@ export namespace dh.lsp {
|
|
|
3452
3513
|
constructor();
|
|
3453
3514
|
}
|
|
3454
3515
|
|
|
3455
|
-
export class
|
|
3456
|
-
|
|
3457
|
-
|
|
3516
|
+
export class SignatureInformation {
|
|
3517
|
+
label:string;
|
|
3518
|
+
documentation:MarkupContent;
|
|
3519
|
+
parameters:Array<ParameterInformation>;
|
|
3520
|
+
activeParameter:number;
|
|
3458
3521
|
|
|
3459
3522
|
constructor();
|
|
3460
3523
|
}
|
|
3461
3524
|
|
|
3462
|
-
export class
|
|
3463
|
-
|
|
3464
|
-
|
|
3525
|
+
export class Range {
|
|
3526
|
+
start:Position;
|
|
3527
|
+
end:Position;
|
|
3465
3528
|
|
|
3466
3529
|
constructor();
|
|
3530
|
+
|
|
3531
|
+
isInside(innerStart:Position, innerEnd:Position):boolean;
|
|
3467
3532
|
}
|
|
3468
3533
|
|
|
3469
|
-
export class
|
|
3470
|
-
|
|
3471
|
-
|
|
3472
|
-
detail:string;
|
|
3473
|
-
documentation:MarkupContent;
|
|
3474
|
-
deprecated:boolean;
|
|
3475
|
-
preselect:boolean;
|
|
3476
|
-
textEdit:TextEdit;
|
|
3477
|
-
sortText:string;
|
|
3478
|
-
filterText:string;
|
|
3479
|
-
insertTextFormat:number;
|
|
3480
|
-
additionalTextEdits:Array<TextEdit>;
|
|
3481
|
-
commitCharacters:Array<string>;
|
|
3534
|
+
export class Hover {
|
|
3535
|
+
contents:MarkupContent;
|
|
3536
|
+
range:Range;
|
|
3482
3537
|
|
|
3483
3538
|
constructor();
|
|
3484
3539
|
}
|
|
@@ -3496,27 +3551,41 @@ export namespace dh.lsp {
|
|
|
3496
3551
|
copy():Position;
|
|
3497
3552
|
}
|
|
3498
3553
|
|
|
3499
|
-
export class
|
|
3554
|
+
export class TextDocumentContentChangeEvent {
|
|
3500
3555
|
range:Range;
|
|
3556
|
+
rangeLength:number;
|
|
3501
3557
|
text:string;
|
|
3502
3558
|
|
|
3503
3559
|
constructor();
|
|
3504
3560
|
}
|
|
3505
3561
|
|
|
3506
|
-
export class
|
|
3507
|
-
|
|
3508
|
-
|
|
3562
|
+
export class TextEdit {
|
|
3563
|
+
range:Range;
|
|
3564
|
+
text:string;
|
|
3509
3565
|
|
|
3510
3566
|
constructor();
|
|
3567
|
+
}
|
|
3511
3568
|
|
|
3512
|
-
|
|
3569
|
+
export class ParameterInformation {
|
|
3570
|
+
label:string;
|
|
3571
|
+
documentation:MarkupContent;
|
|
3572
|
+
|
|
3573
|
+
constructor();
|
|
3513
3574
|
}
|
|
3514
3575
|
|
|
3515
|
-
export class
|
|
3576
|
+
export class CompletionItem {
|
|
3516
3577
|
label:string;
|
|
3578
|
+
kind:number;
|
|
3579
|
+
detail:string;
|
|
3517
3580
|
documentation:MarkupContent;
|
|
3518
|
-
|
|
3519
|
-
|
|
3581
|
+
deprecated:boolean;
|
|
3582
|
+
preselect:boolean;
|
|
3583
|
+
textEdit:TextEdit;
|
|
3584
|
+
sortText:string;
|
|
3585
|
+
filterText:string;
|
|
3586
|
+
insertTextFormat:number;
|
|
3587
|
+
additionalTextEdits:Array<TextEdit>;
|
|
3588
|
+
commitCharacters:Array<string>;
|
|
3520
3589
|
|
|
3521
3590
|
constructor();
|
|
3522
3591
|
}
|
|
@@ -3525,17 +3594,9 @@ export namespace dh.lsp {
|
|
|
3525
3594
|
|
|
3526
3595
|
export namespace dh.calendar {
|
|
3527
3596
|
|
|
3528
|
-
export interface
|
|
3529
|
-
|
|
3530
|
-
|
|
3531
|
-
* @return {@link dh.LocalDateWrapper}
|
|
3532
|
-
*/
|
|
3533
|
-
get date():dh.LocalDateWrapper;
|
|
3534
|
-
/**
|
|
3535
|
-
* The business periods that are open on the holiday.
|
|
3536
|
-
* @return dh.calendar.BusinessPeriod
|
|
3537
|
-
*/
|
|
3538
|
-
get businessPeriods():Array<BusinessPeriod>;
|
|
3597
|
+
export interface BusinessPeriod {
|
|
3598
|
+
get close():string;
|
|
3599
|
+
get open():string;
|
|
3539
3600
|
}
|
|
3540
3601
|
/**
|
|
3541
3602
|
* Defines a calendar with business hours and holidays.
|
|
@@ -3567,9 +3628,17 @@ export namespace dh.calendar {
|
|
|
3567
3628
|
*/
|
|
3568
3629
|
get businessPeriods():Array<BusinessPeriod>;
|
|
3569
3630
|
}
|
|
3570
|
-
export interface
|
|
3571
|
-
|
|
3572
|
-
|
|
3631
|
+
export interface Holiday {
|
|
3632
|
+
/**
|
|
3633
|
+
* The date of the Holiday.
|
|
3634
|
+
* @return {@link dh.LocalDateWrapper}
|
|
3635
|
+
*/
|
|
3636
|
+
get date():dh.LocalDateWrapper;
|
|
3637
|
+
/**
|
|
3638
|
+
* The business periods that are open on the holiday.
|
|
3639
|
+
* @return dh.calendar.BusinessPeriod
|
|
3640
|
+
*/
|
|
3641
|
+
get businessPeriods():Array<BusinessPeriod>;
|
|
3573
3642
|
}
|
|
3574
3643
|
|
|
3575
3644
|
type DayOfWeekType = string;
|