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>

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>

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