AnswerService

AnswerService

Class representing the answer service provided with the custom action payload. This service could be used to run graphql queries in the context of the answer on which the custom action was triggered.

Version : SDK: 1.25.0| ThoughtSpot: 9.10.0.cl

 embed.on(EmbedEvent.CustomAction, e => {
    const underlying = await e.answerService.getUnderlyingDataForPoint([
      'col name 1'
    ]);
    const data = await underlying.fetchData(0, 100);
 })

Constructors🔗

new AnswerService(session: SessionInterface , answer: any , thoughtSpotHost: string , selectedPoints?: VizPoint[] ) : AnswerService

Function Parameters

session
  • session: SessionInterface

answer
  • answer: any

thoughtSpotHost
  • thoughtSpotHost: string

selectedPoints

Optional

  • selectedPoints: VizPoint[]

Returns

Methods🔗

addColumns🔗

addColumns(columnIds: string[] ) : Promise< any >

Function Parameters

columnIds
  • columnIds: string[]

Returns

Promise< any >

executeQuery🔗

executeQuery(query: string , variables: any ) : Promise< any >

Function Parameters

query
  • query: string

variables
  • variables: any

Returns

Promise< any >

fetchCSVBlob🔗

fetchCSVBlob(userLocale?: string = 'en-us', includeInfo?: boolean = false) : Promise< Response >

Function Parameters

userLocale
  • userLocale: string = 'en-us'

includeInfo
  • includeInfo: boolean = false

Include the CSV header in the output

Returns

Promise< Response >

fetchData🔗

fetchData(offset?: number = 0, size?: number = 1000) : Promise< {columns: any , data: any } >

Function Parameters

offset
  • offset: number = 0

size
  • size: number = 1000

Returns

Promise< {columns: any , data: any } >

getFetchCSVBlobUrl🔗

getFetchCSVBlobUrl(userLocale?: string = 'en-us', includeInfo?: boolean = false) : string

Function Parameters

userLocale
  • userLocale: string = 'en-us'

includeInfo
  • includeInfo: boolean = false

Returns

string

getSession🔗

getSession() : SessionInterface

Returns

SessionInterface

getSourceDetail🔗

getSourceDetail() : Promise< any >

Returns

Promise< any >

getUnderlyingDataForPoint🔗

getUnderlyingDataForPoint(outputColumnNames: string[] , selectedPoints?: UnderlyingDataPoint[] ) : Promise< AnswerService >

Get underlying data given a point and the output column names.

Function Parameters

outputColumnNames
  • outputColumnNames: string[]

selectedPoints

Optional

  • selectedPoints: UnderlyingDataPoint[]

Returns

Promise< AnswerService >

Version : SDK: 1.25.0| ThoughtSpot: 9.10.0.cl

 embed.on(EmbedEvent.CustomAction, e => {
    const underlying = await e.answerService.getUnderlyingDataForPoint([
      'col name 1' // The column should exist in the data source.
    ]);
    const data = await underlying.fetchData(0, 100);
 })

removeColumns🔗

removeColumns(columnIds: string[] ) : Promise< any >

Function Parameters

columnIds
  • columnIds: string[]

Returns

Promise< any >