Skip to content

Latest commit

 

History

History
68 lines (55 loc) · 2.32 KB

README.md

File metadata and controls

68 lines (55 loc) · 2.32 KB
Raw

turns svg graph into sketchy

Sketchify

Sketchify is a js tool that turns svg graph into sketchy visualization. It is based on Rough.js

Build

npm install
npm run build

Usage

To turn an existing graph that composed by svg into sketch mode.

Add dependencies to your html:

<script src="https://cdnjs.cloudflare.com/ajax/libs/rough.js/3.1.0/rough.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
<script src="https://cdn.jsdelivr.net/gh/gangtao/sketchify/dist/sketchify.min.js"></script>

Run following js code:

const option = {
    fillStyle: 'hachure',
    roughness: 1,
    bowing: 1,
    chartType: 'highcharts',
};
// container is the root dom element that contains related graph svg
const handler = Sketchifier(container, option);
handler.handify();

// call restore will turn the graph back to original one
handler.restore();

Refer to roughjs api document for options of fillStyle, roughness and bowing.

demo

There are 5 demo charts types:

After npm run build-dev, open related html file in demo folder will show you the demo.

Or you can refer to following codepen pages:

new chart type support

Sketchify is high generalized, now I have tried to support most chart types in highcharts and xCharts, the customization is to filter some svg element that does not need to sketchify. Adding a blacklist of related element class. In case you want to do something similar, refer to highcharts.js