Class IdeSession

Static Readonly EVENT_COMMANDSTARTED

Static Readonly EVENT_REQUEST_FAILED

addEventListener

• addEventListener<T>(name, callback): (() => void)

• Listen for events on this object.

  Type Parameters

  • T

    the type of the data that the event will provide

  Parameters

  • name: string

    the name of the event to listen for

  • callback: ((e) => void)

    a function to call when the event occurs

    • • (e): void

      • Parameters

        • e: Event<T>

        Returns void

  Returns (() => void)

  Returns a cleanup function.

  • • (): void

    • Returns void

bindTableToVariable

• bindTableToVariable(table, name): Promise<void>

• Parameters

  • table: Table

  • name: string

  Returns Promise<void>

changeDocument

• changeDocument(params): void

• Parameters

  • params: object

  Returns void

close

• close(): void

• Returns void

closeDocument

• closeDocument(params): void

• Parameters

  • params: object

  Returns void

emptyTable

• emptyTable(size): Promise<Table>

• Creates an empty table with the specified number of rows. Optionally columns and types may be specified, but all values will be null.

  Parameters

  • size: number

  Returns Promise<Table>

  Promise of Table

getCompletionItems

• getCompletionItems(params): Promise<CompletionItem[]>

• Parameters

  • params: object

  Returns Promise<CompletionItem[]>

getFigure

• getFigure(name): Promise<Figure>

• Load the named Figure, including its tables and tablemaps as needed.

  Parameters

  • name: string

  Returns Promise<Figure>

  promise of dh.plot.Figure

getHierarchicalTable

• getHierarchicalTable(name): Promise<TreeTable>

• Parameters

  • name: string

  Returns Promise<TreeTable>

getHover

• getHover(params): Promise<Hover>

• Parameters

  • params: object

  Returns Promise<Hover>

getObject

• getObject(definitionObject): Promise<any>

• Parameters

  • definitionObject: VariableDescriptor

  Returns Promise<any>

getPartitionedTable

• getPartitionedTable(name): Promise<PartitionedTable>

• Parameters

  • name: string

  Returns Promise<PartitionedTable>

getSharedObject

• getSharedObject(sharedTicketBytes, type): Promise<any>

• Reads an object shared by another client to this server with the sharedTicketBytes. Until the other client releases this object (or their session ends), the object will be available on the server.

  The type of the object must be passed so that the object can be read from the server correct - the other client should provide this information.

  Parameters

  • sharedTicketBytes: string | Uint8Array

    the value provided by another client/user to obtain the object. It may be a unicode string (will be encoded as utf8 bytes), or a Uint8Array value.

  • type: string

    The type of the object, so it can be correctly read from the server

  Returns Promise<any>

  A promise that will resolve to the shared object, or will reject with an error if it cannot be read.

getSignatureHelp

• getSignatureHelp(params): Promise<SignatureInformation[]>

• Parameters

  • params: object

  Returns Promise<SignatureInformation[]>

getTable

• getTable(name, applyPreviewColumns?): Promise<Table>

• Load the named table, with columns and size information already fully populated.

  Parameters

  • name: string

  • Optional applyPreviewColumns: boolean

    optional boolean

  Returns Promise<Table>

  Promise of Table

getTreeTable

• getTreeTable(name): Promise<TreeTable>

• Loads the named tree table or roll-up table, with column data populated. All nodes are collapsed by default, and size is presently not available until the viewport is first set.

  Parameters

  • name: string

  Returns Promise<TreeTable>

  Promise of TreeTable

hasListeners

• hasListeners(name): boolean

• Parameters

  • name: string

  Returns boolean

mergeTables

• mergeTables(tables): Promise<Table>

• Merges the given tables into a single table. Assumes all tables have the same structure.

  Parameters

  • tables: Table[]

  Returns Promise<Table>

  Promise of Table

newTable

• newTable(columnNames, types, data, userTimeZone): Promise<Table>

• Parameters

  • columnNames: string[]

  • types: string[]

  • data: string[][]

  • userTimeZone: string

  Returns Promise<Table>

nextEvent

• nextEvent<T>(eventName, timeoutInMillis?): Promise<Event<T>>

• Type Parameters

  • T

  Parameters

  • eventName: string

  • Optional timeoutInMillis: number

  Returns Promise<Event<T>>

onLogMessage

• onLogMessage(callback): (() => void)

• Parameters

  • callback: ((arg0) => void)

    • • (arg0): void

      • Parameters

        • arg0: LogItem

        Returns void

  Returns (() => void)

  • • (): void

    • Returns void

openDocument

• openDocument(params): void

• Parameters

  • params: object

  Returns void

removeEventListener

• removeEventListener<T>(name, callback): boolean

• Removes an event listener added to this table.

  Type Parameters

  • T

  Parameters

  • name: string

  • callback: ((e) => void)

    • • (e): void

      • Parameters

        • e: Event<T>

        Returns void

  Returns boolean

runCode

• runCode(code): Promise<CommandResult>

• Parameters

  • code: string

  Returns Promise<CommandResult>

shareObject

• shareObject(object, sharedTicketBytes): Promise<string | Uint8Array>

• Makes the object available to another user or another client on this same server which knows the value of the sharedTicketBytes. Use that sharedTicketBytes value like a one-time use password - any other client which knows this value can read the same object.

  Shared objects will remain available using the sharedTicketBytes until the client that first shared them releases/closes their copy of the object. Whatever side-channel is used to share the bytes, be sure to wait until the remote end has signaled that it has successfully fetched the object before releasing it from this client.

  Be sure to use an unpredictable value for the shared ticket bytes, like a UUID or other large, random value to prevent access by unauthorized clients.

  Parameters

  • object: WidgetExportedObject | Widget | TotalsTable | Table | PartitionedTable | TreeTable

    the object to share with another client/user

  • sharedTicketBytes: string | Uint8Array

    the value which another client/user must know to obtain the object. It may be a unicode string (will be encoded as utf8 bytes), or a Uint8Array value.

  Returns Promise<string | Uint8Array>

  A promise that will resolve to the value passed as sharedTicketBytes when the object is ready to be read by another client, or will reject if an error occurs.

subscribeToFieldUpdates

• subscribeToFieldUpdates(callback): (() => void)

• Parameters

  • callback: ((arg0) => void)

    • • (arg0): void

      • Parameters

        • arg0: VariableChanges

        Returns void

  Returns (() => void)

  • • (): void

    • Returns void

timeTable

• timeTable(periodNanos, startTime?): Promise<Table>

• Creates a new table that ticks automatically every "periodNanos" nanoseconds. A start time may be provided; if so the table will be populated with the interval from the specified date until now.

  Parameters

  • periodNanos: number

  • Optional startTime: DateWrapper

  Returns Promise<Table>

  Promise of Table