Type alias CustomChartContextProps

CustomChartContextProps: {
    chartConfigEditorDefinition?: ChartConfigEditorDefinition[];
    getDefaultChartConfig: ((chartModel) => ChartConfig[]);
    getQueriesFromChartConfig: ((chartConfig) => Query[]);
    renderChart: ((ctx) => Promise<void>);
    validateConfig?: ((updatedConfig, chartModel) => ValidationResponse);
    validateVisualProps?: ((updatedVisualProps, chartModel) => ValidationResponse);
    visualPropEditorDefinition?: VisualPropEditorDefinition;
}

Type declaration

  • Optional chartConfigEditorDefinition?: ChartConfigEditorDefinition[]

    Definition to help edit/customize the chart config from chart config editor on the TS app. If not provided, chart queries will not be configurable in editor

    Version

    SDK: 0.1 | ThoughtSpot:

  • getDefaultChartConfig: ((chartModel) => ChartConfig[])
      • (chartModel): ChartConfig[]

      • Generate the default axis configuration for rendering the chart on first load.

        Returns

        []

        Version

        SDK: 0.1 | ThoughtSpot:

        Parameters

        Returns ChartConfig[]

  • getQueriesFromChartConfig: ((chartConfig) => Query[])
      • (chartConfig): Query[]

      • Generate query in the form of array of chart columns to fetch the data.

        Returns

        Array

        Version

        SDK: 0.1 | ThoughtSpot:

        Parameters

        Returns Query[]

  • renderChart: ((ctx) => Promise<void>)
      • (ctx): Promise<void>

      • Main Render function that will render the chart based on the chart context provided

        Version

        SDK: 0.1 | ThoughtSpot:

        Returns

        Promise Promise object to resolve once the chart is rendered

        Parameters

        Returns Promise<void>

  • Optional validateConfig?: ((updatedConfig, chartModel) => ValidationResponse)
  • Optional validateVisualProps?: ((updatedVisualProps, chartModel) => ValidationResponse)
  • Optional visualPropEditorDefinition?: VisualPropEditorDefinition

    Definition to help edit/customize the visual properties from chart settings editor on the TS app. If not provided, visual properties will not be configurable in editor

    Version

    SDK: 0.1 | ThoughtSpot:

Settings

Member Visibility

Theme