@datawrapper/chart-core

Svelte component to render charts. Used by frontend app and Node API.

Showing:

Popularity

Downloads/wk

563

GitHub Stars

9

Maintenance

Last Commit

5mos ago

Contributors

8

Package

Dependencies

11

License

Type Definitions

Not Found

Tree-Shakeable

No?

Categories

Svelte Chart

Readme

chart-core

@datawrapper/chart-core is a collection of useful functions and components that are required to render Datawrapper charts.

Installation

> npm i @datawrapper/chart-core

Structure

├── main.mjs
│     - Entry point for rollup to bundle `Visualization.svelte`
│     - (used by datawrapper/api)
│
├── lib
│     - Directory of source files like `Visualization.svelte`
│     - (used by datawrapper/frontend)
│
├── dist
│     - Files with global dependencies needed for chart rendering
│     - (used by datawrapper/{api,frontend})
│
└── vendor
      - Source vendor files that are copied into dist when package is published

Above are the interesting files and directories to render charts. Only lib/ and dist/ get packaged and published with npm.

API reference

Development

When changing core functionality it is advised to link a local copy of @datawrapper/chart-core in the datawrapper/api or datawrapper/frontend repositories. Follow these steps to link the package:

~/code/chart-core
❯  npm link

~/code/frontend
❯ npm link @datawrapper/chart-core

Everytime npm install is called after that, the link is removed. Usually it is enough to run the second step again.

Publishing

To publish this package run npm version {major|minor|patch} and npm publish. To publish you have to be part of the Datawrapper organization on npm.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Tutorials

No tutorials found
Add a tutorial