superset/superset-frontend/temporary_superset_ui/superset-ui/README.md
2021-11-26 11:46:04 +08:00

19 KiB

@superset-ui

Codecov branch Build Status David

Collection of packages that power the Apache Superset UI, and can be used to craft custom data applications that leverage a Superset backend 📈

Demo

Most recent release: https://apache-superset.github.io/superset-ui/

Current master: https://superset-ui.now.sh/

Packages

Core packages

Package Version
@superset-ui/superset-ui Version
@superset-ui/chart Version
@superset-ui/chart-composition Version
@superset-ui/color Version
@superset-ui/connection Version
@superset-ui/core Version
@superset-ui/dimension Version
@superset-ui/generator-superset Version
@superset-ui/number-format Version
@superset-ui/query Version
@superset-ui/style Version
@superset-ui/time-format Version
@superset-ui/translation Version

Chart plugin packages

@superset-ui/legacy-* packages are extracted from the classic Apache Superset and converted into plugins. These packages are extracted with minimal changes (almost as-is). They also depend on legacy API (viz.py) to function.

Package Version
@superset-ui/legacy-preset-chart-big-number Version
@superset-ui/legacy-preset-chart-nvd3 Version
@superset-ui/legacy-plugin-chart-calendar Version
@superset-ui/legacy-plugin-chart-chord Version
@superset-ui/legacy-plugin-chart-country-map Version
@superset-ui/legacy-plugin-chart-event-flow Version
@superset-ui/legacy-plugin-chart-force-directed Version
@superset-ui/legacy-plugin-chart-heatmap Version
@superset-ui/legacy-plugin-chart-histogram Version
@superset-ui/legacy-plugin-chart-horizon Version
@superset-ui/legacy-plugin-chart-iframe Version
@superset-ui/legacy-plugin-chart-markup Version
@superset-ui/legacy-plugin-chart-map-box Version
@superset-ui/legacy-plugin-chart-paired-t-test Version
@superset-ui/legacy-plugin-chart-parallel-coordinates Version
@superset-ui/legacy-plugin-chart-partition Version
@superset-ui/legacy-plugin-chart-pivot-table Version
@superset-ui/legacy-plugin-chart-rose Version
@superset-ui/legacy-plugin-chart-sankey Version
@superset-ui/legacy-plugin-chart-sankey-loop Version
@superset-ui/legacy-plugin-chart-sunburst Version
@superset-ui/legacy-plugin-chart-table Version
@superset-ui/legacy-plugin-chart-treemap Version
@superset-ui/legacy-plugin-chart-word-cloud Version
@superset-ui/legacy-plugin-chart-world-map Version

@superset-ui/plugin-* packages are newer and higher quality in general. A key difference that they do not depend on viz.py (which contain visualization-specific python code) and interface with /api/v1/query/, a new generic endpoint instead meant to serve all visualizations, instead. Also should be written in Typescript.

Package Version Note
@superset-ui/plugin-chart-word-cloud Version
@superset-ui/plugin-chart-table Version
@superset-ui/preset-chart-xy Version

Contribution and development guide

Please read the contributing guidelines which include development environment setup and other things you should know about coding in this repo.

To build only selected plugins,

node scripts/build.js "*legacy-plugin-chart-table"

License

Apache-2.0