🌜
🌞
techan

techan

v0.8.0

A visual, technical analysis and charting (Candlestick, OHLC, indicators) library built on D3.

npm install techan

README

TechanJS Build Status

Technical Chart Analysis

A visual, technical analysis and charting library built on D3. Build interactive financial charts for modern and mobile browsers.

Examples Gallery

TechanJS utilises D3's reusable chart API pattern and currently supports a range of static and interactive plots.

Static Plots

Interactive & Dynamic Plots

Algorithms

Getting Started

Manual Download

Download the latest release https://github.com/andredumas/techan.js/releases/latest

npm

npm install --save techan

Bower Dependency

bower install --save techan

Build From Source

Cloning and building the base project:

git clone https://github.com/andredumas/techan.js.git
cd techan.js
npm install

# Then to build
npm test
# OR
grunt

Build From Source With Examples

Cloning the project with all examples and usage:

git clone --recursive https://github.com/andredumas/techan.js.git
cd techan.js
npm install
npm start

Once running browse to http://localhost:8000/examples/ to see examples using the remote (development stable) techanjs and d3. Alternatively browse to http://localhost:8000/build/examples/ for the same examples using the locally built techanjs and bower obtained d3 but be aware that the examples are built to work with the latest, development stable version of techanjs located at http://techanjs.org/techan.min.js. Expect that HEAD of master will contain unstable features under development. They may not always be compatible with all the examples. I will attempt to keep the release tags functional together with correctly referenced examples.

Docker

Run techan.js in a consistent environment using Docker. To see the examples, all submodules are required (recursive clone or update, init) locally.

NOTE: On build the project is copied into the docker image and as such any changes made will not be refreshed into a running container.

git clone --recursive https://github.com/andredumas/techan.js.git
cd techan.js
docker build -t andredumas/techan.js .
docker run --rm -it -p 8000:8000 andredumas/techan.js

As above, browse to http://localhost:8000/examples/ to see the examples.

Release Notes

0.8.0
By André Dumas • Published on October 1, 2016

This release only contains D3 V4 compatibility update. Refer to Milestone 0.8.0.

Important Release Notes

  • Use of techan.js with D3 V3 will no longer work and is no longer supported. Refer to techan examples commit log on upgrade process. This should not require change to techan interface calls (apart from two items below). D3 chart setup changes are probably required. Refer to Changes in D3 4.0.
  • Review the notes in #141 for potentially breaking change to axisannotation and financetime.zoomable().
0.7.0
By André Dumas • Published on September 27, 2016

Refer to Milestone 0.7.0 for complete list of changes.

Important Release Notes: API Changes

  • #146: Cross hair passes Object { x: <scale value> y: <scale value> } to move event
0.6.1
By André Dumas • Published on September 7, 2016

Version bump for npm publish.

0.6.0
By André Dumas • Published on September 7, 2016

Stable development release. API may change until version 1.0.0.

Refer to milestone 0.6.0 for changelog

General

License
MIT
Typescript Types
None found
Tree-shakeable
No

Popularity

GitHub Stargazers
2,328
Community Interest
2,911
Number of Forks
535

Maintenance

Commits
11/2110/2201
Last Commit
Oct 10, 2016
Open Issues
96
Closed Issues
139
Open Pull Requests
7
Closed Pull Requests
3

Versions

Versions Released
11/2110/2201
Latest Version Released
Oct 1, 2016
Current Tags
latest0.8.0

Contributors

andredumas
andredumas
Commits: 227
thomashan
thomashan
Commits: 12
sf-wind
sf-wind
Commits: 2
priikone
priikone
Commits: 2
briancappello
briancappello
Commits: 1
fojt
fojt
Commits: 1
tomas-rampas
tomas-rampas
Commits: 1