lines-svg
v0.4.21
Published
LinesSvg is a financial chart library. Support formats are lineal, candlestick, sma & ema charts.
Downloads
46
Maintainers
Readme
Lines SVG chart Library
About the project
LinesSvg is a financial chart library based on snapsvg. You can use it to create HTML5 forex/stock charts. The library support standart time based graphics(linear, sma, ema ...), toolset for end users to draw(hints, notes, signals) and create snapshots in PNG or Canvas format.
Supported charts:
- Linear
- Japan candlestick
- Simple Moving Average(SMA)
- Exponential Moving Average(EMA)
Drawing feature:
- Rectangle
- Circle
- Line
- Text
- Pointer
Installation
Npm
npm install lines-svg
From repo
$ git clone
$ cd project_folder
$ npm install
$ npm run build
Demo and initialize snippet
const chartData = [
[1.1, 1.1, 1.3, 1.2, 1588368812844]
...
]; // ohlc Data with timestamp
const l = new Lines(elementID);
l.data(chartData);
l.draw();
Running Tests
Install development dependencies:
$ npm install
Then:
$ npm run test
DESCRIPTION
Interface and functions signature are :
- Constructor Lines("elementID"), expect argument to be existing DOM svg element with elementID.
- Instance.data(dataSet) method expect dataSet to be Array with particular structure ['open', 'high', 'low', 'close', 'timestamp'].
- Instance.draw(type) method, expect/support: all, line, candle, sma, ema type of charts. Default value is all.
- Library support also end user draw of lines, arrows, tunels.
todo
- Transfer library to typescript & use the option to modulize it. Export some of the properties to different file.
npm run build:watch
npm start
IP : 5000 / example/build.html
- https://github.com/andyhaskell/webpack-mocha-tutorial
- https://github.com/vyasriday/webpack-js-library
https://medium.com/@binyamin/creating-a-node-express-webpack-app-with-dev-and-prod-builds-a4962ce51334