Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
benmccann committed Oct 9, 2019
1 parent 9a7f262 commit 9bf4ed7
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Chart.js module for Candlestick and OHLC charts

## Usage and Roadmap
## Roadmap

This module has not yet had its initial release and is not yet available on npm. This library depends on Chart.js and we are currently adding support for some of the necessary features there

Expand All @@ -20,17 +20,27 @@ Chart.js 2.9.0 will add [support for floating bars](https://github.com/chartjs/C

We would like to add [improved autoskipping](https://github.com/chartjs/Chart.js/pull/6274) and sharper drawing before having an initial release. The current work is centered around providing this infrastructure in the core Chart.js library. While there is not much activity in this repo, there is ongoing active development towards improved financial charting!

As we near an initial release we will add documentation. For now, please see the docs directory.

## Comparison

We are aiming to make Chart.js the only popular JavaScript library that is both performant and has good timescale handling.

Most chart libraries don't have great handling of timescale axes. Chart.js 2.9.0 will be the best library available in this regard by utilizing the concept of major ticks. E.g. it will make sure that the first day of each month is plotted before plotting days in between.

One of the best libraries we've found for financial charts is [react-stockcharts](https://github.com/rrag/react-stockcharts). However, it ties the user to utilizing React. Currently this library and react-stock charts are the same speed. However, we expect this library should be much faster after Chart.js 2.9.0 is released.

Because Chart.js utilizes canvas it is more performant than the majority of JavaScript charting libraries. [ZingChart](https://www.zingchart.com/docs/chart-types/stock-charts/) and [Highcharts](https://www.highcharts.com/stock/demo/candlestick) with the [boost module](https://www.highcharts.com/blog/news/175-highcharts-performance-boost/) are two options that also offer canvas rendering and may be performant.

Most chart libraries don't have great handling of timescale axes. [AmCharts](https://www.amcharts.com/stock-chart/) is one exception to this.
## Documentation

We are aiming to make Chart.js the only popular JavaScript library that is both performant and has good timescale handling.
As we near an initial release we will add additional documentation. For now, please see the docs directory.

### Examples

Examples are available here: https://chartjs.github.io/chartjs-chart-financial/

### Date Libraries & IE Support

Chart.js requires that you supply a date library. The examples utilize [chartjs-adapter-luxon](https://github.com/chartjs/chartjs-adapter-luxon), which has the best support for i18n and time zones. However, in order to use [Luxon](http://moment.github.io/luxon/) with IE you need to supply polyfills. If you require IE support you may find it easier to use another date library like [Moment](https://momentjs.com/) or [date-fns](https://date-fns.org/). Please see the Chart.js documentation for more details on date adapters.

## Related Plugins

Expand All @@ -48,7 +58,3 @@ The plugins below may be particularly interesting to use with financial charts.
npm install
gulp build
```

## Examples

Out of the box examples are available here: https://chartjs.github.io/chartjs-chart-financial/

0 comments on commit 9bf4ed7

Please sign in to comment.