@thoughtspot/visual-embed-sdk 1.27.8 → 1.28.0-alpha.1

package/dist/src/utils/graphql/answerService/answerService.d.ts

@@ -11,7 +11,7 @@ export declare enum OperationType {
     GetChartWithData = "GetChartWithData",
     GetTableWithHeadlineData = "GetTableWithHeadlineData"
 }
-interface UnderlyingDataPoint {
+export interface UnderlyingDataPoint {
     columnId: string;
     dataValue: any;
 }
@@ -38,24 +38,67 @@ export declare class AnswerService {
     private answer;
     private thoughtSpotHost;
     private selectedPoints?;
+    /**
+     * Should not need to be called directly.
+     *
+     * @param session
+     * @param answer
+     * @param thoughtSpotHost
+     * @param selectedPoints
+     */
     constructor(session: SessionInterface, answer: any, thoughtSpotHost: string, selectedPoints?: VizPoint[]);
+    /**
+     * Get the details about the source used in the answer.
+     * This can be used to get the list of all columns in the data source for example.
+     */
     getSourceDetail(): Promise<any>;
+    /**
+     * Remove columnIds and return updated answer session.
+     *
+     * @param columnIds
+     * @returns
+     */
     removeColumns(columnIds: string[]): Promise<any>;
+    /**
+     * Add columnIds and return updated answer session.
+     *
+     * @param columnIds
+     * @returns
+     */
     addColumns(columnIds: string[]): Promise<any>;
+    /**
+     * Fetch data from the answer.
+     *
+     * @param offset
+     * @param size
+     * @returns
+     */
     fetchData(offset?: number, size?: number): Promise<{
         columns: any;
         data: any;
     }>;
     /**
+     * Fetch the data for the answer as a CSV blob. This might be
+     * quicker for larger data.
      *
      * @param userLocale
      * @param includeInfo Include the CSV header in the output
      * @returns Response
      */
     fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise<Response>;
+    /**
+     * Just get the internal URL for this answer's data
+     * as a CSV blob.
+     *
+     * @param userLocale
+     * @param includeInfo
+     * @returns
+     */
     getFetchCSVBlobUrl(userLocale?: string, includeInfo?: boolean): string;
     /**
      * Get underlying data given a point and the output column names.
+     * In case of a context menu action, the selectedPoints are
+     * automatically passed.
      *
      * @param outputColumnNames
      * @param selectedPoints
@@ -71,8 +114,19 @@ export declare class AnswerService {
      * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
      */
     getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
+    /**
+     * Execute a custom graphql query in the context of the answer.
+     *
+     * @param query graphql query
+     * @param variables graphql variables
+     * @returns
+     */
     executeQuery(query: string, variables: any): Promise<any>;
+    /**
+     * Get the internal session details for the answer.
+     *
+     * @returns
+     */
     getSession(): SessionInterface;
 }
-export {};
 //# sourceMappingURL=answerService.d.ts.map

package/dist/src/utils/graphql/answerService/answerService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"answerService.d.ts","sourceRoot":"","sources":["answerService.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAe,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAM5D,MAAM,WAAW,gBAAgB;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CACnD;AAGD,oBAAY,aAAa;IACrB,gBAAgB,qBAAqB;IACrC,wBAAwB,6BAA6B;CACxD;AAED,UAAU,mBAAmB;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,GAAG,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,aAAa;IAElB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,cAAc,CAAC;gBAHf,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,GAAG,EACX,eAAe,EAAE,MAAM,EACvB,cAAc,CAAC,EAAE,QAAQ,EAAE;IAK1B,eAAe;IAQf,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE;IASjC,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE;IAS9B,SAAS,CAAC,MAAM,SAAI,EAAE,IAAI,SAAO;;;;IAqB9C;;;;;OAKG;IACU,YAAY,CAAC,UAAU,SAAU,EAAE,WAAW,UAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAOhF,kBAAkB,CAAC,UAAU,SAAU,EAAE,WAAW,UAAQ,GAAG,MAAM;IAI5E;;;;;;;;;;;;;;;OAeG;IACU,yBAAyB,CAClC,iBAAiB,EAAE,MAAM,EAAE,EAC3B,cAAc,CAAC,EAAE,mBAAmB,EAAE,GACvC,OAAO,CAAC,aAAa,CAAC;IA8CZ,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAe/D,UAAU;CAGpB"}
+{"version":3,"file":"answerService.d.ts","sourceRoot":"","sources":["answerService.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAe,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAM5D,MAAM,WAAW,gBAAgB;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CACnD;AAGD,oBAAY,aAAa;IACrB,gBAAgB,qBAAqB;IACrC,wBAAwB,6BAA6B;CACxD;AAED,MAAM,WAAW,mBAAmB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,GAAG,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,aAAa;IAUlB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,cAAc,CAAC;IAZ3B;;;;;;;OAOG;gBAES,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,GAAG,EACX,eAAe,EAAE,MAAM,EACvB,cAAc,CAAC,EAAE,QAAQ,EAAE;IAKvC;;;OAGG;IACU,eAAe;IAQ5B;;;;;OAKG;IACU,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE;IAS9C;;;;;OAKG;IACU,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE;IAS3C;;;;;;OAMG;IACU,SAAS,CAAC,MAAM,SAAI,EAAE,IAAI,SAAO;;;;IAqB9C;;;;;;;OAOG;IACU,YAAY,CAAC,UAAU,SAAU,EAAE,WAAW,UAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAOvF;;;;;;;OAOG;IACI,kBAAkB,CAAC,UAAU,SAAU,EAAE,WAAW,UAAQ,GAAG,MAAM;IAI5E;;;;;;;;;;;;;;;;;OAiBG;IACU,yBAAyB,CAClC,iBAAiB,EAAE,MAAM,EAAE,EAC3B,cAAc,CAAC,EAAE,mBAAmB,EAAE,GACvC,OAAO,CAAC,aAAa,CAAC;IA8CzB;;;;;;OAMG;IACU,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAetE;;;;OAIG;IACI,UAAU;CAGpB"}