Merge pull request #8 from apache/dev

doc: update doc
tree: cf127edd4a17ac0665206dae61f6f63b74137a2a
  1. custom-series/
  2. scripts/
  3. .asf.yaml
  4. .gitignore
  5. .prettierignore
  6. .prettierrc.json
  7. LICENSE
  8. package-lock.json
  9. package.json
  10. README.md
README.md

echarts-custom-series

This repo provides some custom series for Apache ECharts. The minial supported version is Apache ECharts v6, which is not released yet.

List of Custom Series

@echarts-x/custom-violin
doc npm
violin
@echarts-x/custom-contour
doc npm
contour
@echarts-x/custom-stage
doc npm
stage
@echarts-x/custom-segmented-doughnut
doc npm
segmentedDoughnut
@echarts-x/custom-bar-range
doc npm
barRange
@echarts-x/custom-line-range
doc npm
lineRange

See the README in the above links about how to install and use.

Develop

npm install

Create A New Custom Series

npm run generate <series-name>

The generated files are in custom-series/<series-name>. Note that if there are multiple words in the series name, they should be in camel case like npm run generate barRange.

Build

Each of the directories in custom-series/ is a custom series.

Build All

npm run build

Build One

npm run build <series-name>

For example, to build custom-series/violin, run:

npm run build violin

Generate Thumbnails

npm run thumbnail
# or
npm run thumbnail <series-name>