@hediet/visualization-bundle
v0.2.5
Published
Bundles several visualizers
Downloads
69
Readme
Visualization Bundle
This package registers various visualizations. If you have an idea for a cool visualization, add it here!
Installation
You can use yarn to install this library:
yarn add @hediet/visualization-bundle
Install @hediet/visualization-core
before!
Usage
Import @hediet/visualization-bundle
to register all default visualizations to globalVisualizationFactory
of @hediet/visualization-core
:
// This registers all visualizations
import "@hediet/visualization-bundle";
Don't forget to import the styles in your scss file:
@import "~@hediet/visualization-bundle/style.scss";
You will need to configure webpack
- to compile scss files:
{ test: /\.scss$/, loader: "style-loader!css-loader!sass-loader" },
- to compile less files:
{ test: /\.less$/, loaders: ["style-loader", "css-loader", "less-loader"] }
- to register monaco workers
plugins: [
// ...
new MonacoWebpackPlugin({
languages: ["typescript", "json"],
}),
];
See docs of @hediet/visualization-core
for how to find and render visualizations!
Supported Visualizations
You can find a playground that demonstrates all visualizations here.
Source Visualizations
- Tree Visualizer
- AST Visualizer (+ Monaco Source Code View)
- Grid Visualizer
- SVG Visualizer
- Image Visualizer
- Simple Text Visualizer
Integrated Visualization Libraries
- Plotly Visualizer
- Perspective JS Visualizer
- VisJS Visualizer
- Graphviz Graph Visualizer
- Graphviz Dot Visualizer
- Vis.js Visualizer
- Monaco Editor Source Code Visualizer
Setup Local Development Copy
- Clone this repository.
- Run
yarn
in the root folder. - Run
yarn dev
in thevisualization-bundle
folder to start tsc in watch mode. - Edit ./playground/src/visualization.ts to your needs to improve webpack performance. This is highly recommended, but not required.
- Run
yarn dev
in theplayground
folder to start the playground where you can debug your visualization.
Any changes to the source are now reflected in the playground!
Implementing New Visualizations
First, setup your local development copy.
You can use the simple-text-visualizer
as starting point!
Just copy the folder, rename the ids and names, export it here and read through all the comments of the simple-text-visualizer!
Use the "open" button in the playground to debug your new visualization!