@opensankey/sigma
v0.1.0
Published
Sigma Computing plugin for OpenSankey. Renders interactive Sankey charts inside Sigma workbooks.
Downloads
61
Readme
@opensankey/sigma
Sigma Computing plugin for OpenSankey. Renders interactive Sankey charts inside Sigma workbooks.
Setup
- Build the plugin:
pnpm buildHost the built
dist/index.global.jsin an HTML page accessible via URL.In Sigma, add a Plugin element to your workbook and point it to your hosted URL.
Configure the plugin in the Sigma editor panel:
- Data Source: Select the Sigma table/element to pull data from
- Source Column: The dimension for source nodes
- Target Column: The dimension for target nodes
- Value Column: The numeric measure for flow weight
- Highlight Mode: Hover highlight direction (both, forward, backward, none)
How It Works
The plugin uses the @sigmacomputing/plugin client API to:
- Register configuration options via
configureEditorPanel - Subscribe to element data via
subscribeToElementData - Subscribe to column metadata via
subscribeToElementColumns - React to config changes via
config.subscribe
Data flows from Sigma to the plugin as column arrays, which are converted to tabular rows and passed to @opensankey/core.
License
MIT
