Skip to main content

Quick Start

Ts-chart-sdk is a npm package. ThoughtSpot Custom Charts is an umbrella term for the ability to add custom chart in TS and integrate TS capability to your charts. Chart Customization includes adding Custom charts,managing Chart Configurator Customizing Visual Prop settings, Integrating TS ability such as drilldown, Conditional Foramtting, Number Formatting, Action Menu, Legends and many other feature.

Requirements​

  1. Vite Latest Version:

    • Install the latest version of Vite globally or initialize it directly within your project using npm, Yarn, or pnpm.

    Run the following commands to create a new project using Vite:

    # Create a new Vite project
npm create vite@latest my-project

# Navigate into the project directory
cd my-project

# Install dependencies
npm install

  2. Any Charting library

    • Install the latest version of any Charting library (HighCharts, Muze, Chart.js) globally or initialize it directly within your project using npm, Yarn, or pnpm.

    Run the following commands inside vite project directory:

    npm install <charting_library_package>

  3. Installing ts-chart-sdk

    • To install latest version of ts-chart-sdk run the following command 
      npm install --save @thoughtspot/ts-chart-sdk
    • To install specified version of ts-chart-sdk run the following command 
      npm install --save ts-chart-sdk@<version_number>

Updating your ts-chart-sdk version​

There are many ways to update your ts-chart-sdk version. One guaranteed way is to manually change the version number in package.json to the desired version:

package.json Example:​

{
  "dependencies": {
    "ts-chart-sdk": "<desired-version>"
    // ... other dependencies
  }
}

After updating the version in package.json, run the following command to install the updated version:

npm install

Ts-chart-sdk Playground​

Playgrounds allow you to run ts-chart-sdk in your browser, without adding chart URL in TS cluster and running your chart with localhost!

They are mostly useful for:

  • Testing
  • Reporting bugs

Visit the ts-chart-sdk playground to render your chart.

For more info on playground please have look to Playground section in documentation.