DevelopPlugin development

Plugin examples

View as Markdown

The Sigma development team has created a set of example plugins. Source code for each example is in the sample plugin repository on GitHub.

Hosted production URLs for these examples are not available. To try an example, run it locally.

Example plugins

  • Recharts bar chart
    A basic bar chart built with the Recharts library. Source code
  • D3 candlestick
    A candlestick visualization built with D3. Source code
  • D3 graph
    Demonstrates usage of multiple data sources and in-memory joins. Source code
  • D3 sunburst
    A sunburst visualization built with D3. Source code
  • Frappe heatmap
    A basic Frappe visualization example. Source code

Run an example locally

  1. Open your terminal, and navigate to the directory you want to save the example in.

  2. Clone the sample plugin repository.

    git clone https://github.com/sigmacomputing/sigma-sample-plugins.git

  3. Navigate to the plugin you want to try.

    cd sigma-sample-plugins/<plugin-name>

  4. Run the plugin.

    yarn && yarn start

For additional instructions, visit the README file located in the main directory of any given example plugin.