Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Mavrin committed Aug 14, 2018
1 parent 9d874ab commit 85b43e7
Show file tree
Hide file tree
Showing 161 changed files with 9,235 additions and 52,813 deletions.
4 changes: 2 additions & 2 deletions license.txt → LICENSE
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Copyright 2015 Taucraft Limited
Copyright 2017 Targetprocess, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0
https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
143 changes: 79 additions & 64 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,22 @@
Taucharts [![Build Status](https://travis-ci.org/TargetProcess/tauCharts.png?branch=master)](https://travis-ci.org/TargetProcess/tauCharts) [![Coverage Status](https://img.shields.io/coveralls/TargetProcess/tauCharts.svg)](https://coveralls.io/r/TargetProcess/tauCharts) [![Code Climate](https://codeclimate.com/github/TargetProcess/tauCharts/badges/gpa.svg)](https://codeclimate.com/github/TargetProcess/tauCharts)
[![Slack Status](http://slack.taucharts.com/badge.svg)](http://slack.taucharts.com/)
[![Slack Status](https://slack.taucharts.com/badge.svg)](https://slack.taucharts.com/)
======

![NPM downloads](https://nodei.co/npm-dl/taucharts.png?months=6)
Taucharts is a [data-focused JavaScript charting library](https://blog.taucharts.com/taucharts-data-focused-charting-library/) based on D3 and designed with passion.


Taucharts is a [data-focused JavaScript charting library](http://blog.taucharts.com/taucharts-data-focused-charting-library/) based on D3 and designed with passion.

##### Official website: [www.taucharts.com](http://www.taucharts.com)
##### Documentation: [api.taucharts.com](http://api.taucharts.com)
##### Project blog: [blog.taucharts.com](http://blog.taucharts.com)
##### Official website: [www.taucharts.com](https://www.taucharts.com)
##### Documentation: [api.taucharts.com](https://api.taucharts.com)
##### Project blog: [blog.taucharts.com](https://blog.taucharts.com)

## Why use Taucharts?
#### Simplicity
Data plays a key role in Taucharts. The library provides a declarative interface for fast mapping of data fields to visual properties.
#### Flexibility
The library's architecture allows you to build [facets](http://api.taucharts.com/basic/facet.html) and extend chart behaviour with reusable plugins.
The library's architecture allows you to build [facets](https://api.taucharts.com/basic/facet.html) and extend chart behaviour with reusable plugins.
#### Design
The Taucharts team is passionate about beautiful design.
#### ...
Dive into the high-level [Taucharts concepts](http://blog.taucharts.com/taucharts-data-focused-charting-library/) and [usage reviews](#taucharts-examples--usage-reviews).
Dive into the high-level [Taucharts concepts](https://blog.taucharts.com/taucharts-data-focused-charting-library/) and [usage reviews](#taucharts-examples--usage-reviews).
If you want to contribute - see [how to run the project locally](#how-to-run-the-project-locally)

## How to use Taucharts
Expand All @@ -30,15 +27,17 @@ Load JavaScript dependencies

```html
<script src="//cdn.jsdelivr.net/d3js/latest/d3.min.js" charset="utf-8"></script>
<script src="//cdn.jsdelivr.net/taucharts/latest/tauCharts.min.js" type="text/javascript"></script>
<script src="//cdn.jsdelivr.net/npm/taucharts@2/dist/taucharts.min.js" type="text/javascript"></script>
```

Include a CSS file, as well

```html
<link rel="stylesheet" type="text/css" href="//cdn.jsdelivr.net/taucharts/latest/tauCharts.min.css">
<link rel="stylesheet" type="text/css" href=//cdn.jsdelivr.net/npm/taucharts@2/dist/taucharts.min.css">
```
NOTE: taucharts@2 is compatible with D3 v4 only. Use taucharts@1 if you work with obsolete D3 versions.
#### Downloading Taucharts using Bower
```bash
Expand All @@ -57,110 +56,110 @@ Below are some popular usage scenarios. For more examples, see our experimental
#### Scatter plot
```javascript
var chart = new tauCharts.Chart({
'type' : 'scatterplot',
'x' : 'Cycle Time',
'y' : 'SUM(Bugs Count)',
'color': 'Team',
'size' : 'Sum(User Stories Count)',
'data' : [{'Cycle Time': 186, 'SUM(Bugs Count)': 34, 'Team': 'HDP'...}, ...],
'plugins': [
tauCharts.api.plugins.get('legend'),
tauCharts.api.plugins.get('tooltip')
var chart = new Taucharts.Chart({
type : 'scatterplot',
x : 'Cycle Time',
y : 'SUM(Bugs Count)',
color : 'Team',
size : 'Sum(User Stories Count)',
data : [{'Cycle Time': 186, 'SUM(Bugs Count)': 34, 'Team': 'HDP'...}, ...],
plugins: [
Taucharts.api.plugins.get('legend'),
Taucharts.api.plugins.get('tooltip')
]
});
```
[![Scatterplot](examples/screenshots/Taucharts_Scatterplot.png)](http://api.taucharts.com/basic/scatterplot.html)
[![Scatterplot](examples/screenshots/Taucharts_Scatterplot.png)](https://api.taucharts.com/basic/scatterplot.html)
See [scatter plot documentation](http://api.taucharts.com/basic/scatterplot.html)
See [scatter plot documentation](https://api.taucharts.com/basic/scatterplot.html)
___
#### Line chart
```javascript
var chart = new tauCharts.Chart({
'type' : 'line',
'y' : 'Y Scale',
'x' : 'X Scale',
'color': 'Team',
'size' : 'Effort',
'label': 'Effort',
'data' : [{'Team': 'Alpha', 'Effort': 40, 'Y Scale': 23, 'X Scale': 72 }, ...]
var chart = new Taucharts.Chart({
type : 'line',
y : 'Y Scale',
x : 'X Scale',
color: 'Team',
size : 'Effort',
label: 'Effort',
data : [{'Team': 'Alpha', 'Effort': 40, 'Y Scale': 23, 'X Scale': 72 }, ...]
});
```
[![Line Chart](examples/screenshots/Taucharts_Line.png)](http://api.taucharts.com/basic/line.html)
[![Line Chart](examples/screenshots/Taucharts_Line.png)](https://api.taucharts.com/basic/line.html)
See [line chart documentation](http://api.taucharts.com/basic/line.html)
See [line chart documentation](https://api.taucharts.com/basic/line.html)
___
#### Bar chart
```javascript
var chart = new tauCharts.Chart({
var chart = new Taucharts.Chart({
type : 'bar',
x : 'team',
y : 'effort',
color: 'priority',
data : [{'team': 'd', 'effort': 1, 'count': 1, 'priority': 'low'}, ...]
});
```
[![Bar Chart](examples/screenshots/Taucharts_Bar.png)](http://api.taucharts.com/basic/bar.html)
[![Bar Chart](examples/screenshots/Taucharts_Bar.png)](https://api.taucharts.com/basic/bar.html)
See [bar chart documentation](http://api.taucharts.com/basic/bar.html)
See [bar chart documentation](https://api.taucharts.com/basic/bar.html)
___
#### Horizontal bar chart
```javascript
var chart = new tauCharts.Chart({
var chart = new Taucharts.Chart({
type : 'horizontal-bar',
x : 'count',
y : 'team',
color: 'priority',
data : [{'team': 'alpha', 'effort': 8, 'priority': 'major'}, ...]
});
```
[![Horizontal Bar Chart](examples/screenshots/Taucharts_Horizontal-bar.png)](http://api.taucharts.com/basic/horizontal-bar.html)
[![Horizontal Bar Chart](examples/screenshots/Taucharts_Horizontal-bar.png)](https://api.taucharts.com/basic/horizontal-bar.html)
See [horizontal bar chart documentation](http://api.taucharts.com/basic/horizontal-bar.html)
See [horizontal bar chart documentation](https://api.taucharts.com/basic/horizontal-bar.html)
___
#### Stacked bar chart
```javascript
var chart = new tauCharts.Chart({
var chart = new Taucharts.Chart({
type : 'stacked-bar',
x : 'age',
y : ['count', 'sport'],
color: 'country',
data : [{country: 'Canada', sport: 'Biathlon', medals: 20, age: 22}, ...]
});
```
[![Stacked Bar Chart](examples/screenshots/Taucharts_Stacked-bar.png)](http://api.taucharts.com/basic/stacked-bar.html)
[![Stacked Bar Chart](examples/screenshots/Taucharts_Stacked-bar.png)](https://api.taucharts.com/basic/stacked-bar.html)
See [stacked bar chart documentation](http://api.taucharts.com/basic/stacked-bar.html)
See [stacked bar chart documentation](https://api.taucharts.com/basic/stacked-bar.html)
___
#### Horizontal stacked bar chart
```javascript
var chart = new tauCharts.Chart({
var chart = new Taucharts.Chart({
type : 'horizontal-stacked-bar',
y : 'process',
x : 'count',
color: 'stage',
data : [{process: 'sales', stage: 'visit', count: 100}, ...]
});
```
[![Horizontal Stacked Bar Chart](examples/screenshots/Taucharts_Horizontal-stacked-bar.png)](http://api.taucharts.com/basic/horizontal-stacked-bar.html)
[![Horizontal Stacked Bar Chart](examples/screenshots/Taucharts_Horizontal-stacked-bar.png)](https://api.taucharts.com/basic/horizontal-stacked-bar.html)
See [horizontal stacked bar chart documentation](http://api.taucharts.com/basic/horizontal-stacked-bar.html)
See [horizontal stacked bar chart documentation](https://api.taucharts.com/basic/horizontal-stacked-bar.html)
___
#### Stacked area chart
```javascript
var chart = new tauCharts.Chart({
var chart = new Taucharts.Chart({
type : 'stacked-area',
y : 'effort',
x : 'date',
Expand All @@ -171,31 +170,31 @@ var chart = new tauCharts.Chart({
data : [{date: '2015-07-15', effort: 400, team: 'Alpha'}, ...]
});
```
[![Horizontal Stacked Bar Chart](examples/screenshots/Taucharts_Stacked-area.png)](http://api.taucharts.com/basic/stacked-area.html)
[![Horizontal Stacked Bar Chart](examples/screenshots/Taucharts_Stacked-area.png)](https://api.taucharts.com/basic/stacked-area.html)
See [stacked area chart documentation](http://api.taucharts.com/basic/stacked-area.html)
See [stacked area chart documentation](https://api.taucharts.com/basic/stacked-area.html)
___
#### Facet chart
```javascript
var chart1 = new tauCharts.Chart({
var chart1 = new Taucharts.Chart({
type : 'scatterplot',
x : ['milespergallon'],
y : ['class', 'price'],
color: 'class',
data : [{class: "C", milespergallon: 41.26, price: 24509.74, vehicle: "Prius1"}, ...]
});
```
[![Facet scatterplot chart](examples/screenshots/Taucharts_Facet.png)](http://api.taucharts.com/basic/facet.html)
[![Facet scatterplot chart](examples/screenshots/Taucharts_Facet.png)](https://api.taucharts.com/basic/facet.html)
See [facet charts documentation](http://api.taucharts.com/basic/facet.html)
See [facet charts documentation](https://api.taucharts.com/basic/facet.html)
___
#### Data Streaming
```javascript
var chart1 = new tauCharts.Chart({
var chart1 = new Taucharts.Chart({
type : 'line',
x : 'x',
y : 'y',
Expand All @@ -212,17 +211,27 @@ See [streaming sample online](//jsfiddle.net/taucharts/qdn76nab/)
___
#### Complex Composable charts
[![Composable Chart](examples/screenshots/Taucharts_Composable.png)](http://jsfiddle.net/6LzefLo4/4/)
[![Composable Chart](examples/screenshots/Taucharts_Composable.png)](https://jsfiddle.net/6LzefLo4/4/)
See [composable chart sample online](http://jsfiddle.net/6LzefLo4/4/)
See [composable chart sample online](https://jsfiddle.net/6LzefLo4/4/)
___
## Migrating from Taucharts v1 to v2
- D3 v4 is now dependency.
- `Taucharts` global object name (was `tauCharts`).
- `.tau-chart__` CSS class prefix (was`.graphical-report__`).
- `export-to` plugin alias changed (was `exportTo`).
- Distributive files paths changed. `dist/taucharts.min.js` and `dist/taucharts.min.css` contain the core and all the plugins minified together. `dist/taucharts.js` and `dist/taucharts.css` contain unfinified core, JS and CSS for plugins can be found in `dist/plugins/` folder (e.g. to import a plugin you should do something like `import tooltip from 'taucharts/dist/plugins/tooltip';`).
___
## How to run the project locally
Clone (forked) repository:
```
git clone https://github.com/TargetProcess/tauCharts.git
git clone https://github.com/TargetProcess/taucharts.git
```
Initialize dependencies:
Expand All @@ -232,12 +241,12 @@ npm install
Run local webpack dev server (with hot reload):
```
npm run devserver
npm start
```
Local server will be started on port 9000 and live taucharts assembly will be exposed by url:
```
http://localhost:9000/tauCharts.js
http://localhost:9000/dist/taucharts.js
```
Now you can see some taucharts examples:
Expand All @@ -254,26 +263,32 @@ To build a static assembly:
```
npm run build
```
This command creates development and production assemblies in a *[./build]* folder.
This command creates development and production assemblies in a *[./dist]* folder.
See the [Developer Guide](DEVELOPER-GUIDE.md) for more info.
## Taucharts examples / usage reviews
[R Wrapper](http://www.buildingwidgets.com/blog/2015/8/5/week-31-taucharts)
[R Wrapper](https://www.buildingwidgets.com/blog/2015/8/5/week-31-taucharts)
[SqlPad Project](http://rickbergfalk.github.io/sqlpad/chart-tutorials/)
[SqlPad Project](https://rickbergfalk.github.io/sqlpad/)
[Targetprocess Graphical Reports](https://www.targetprocess.com/blog/2015/09/prototype-for-new-custom-graphical-reports-editor/)
[Vizydrop project](http://vizydrop.com/)
[Vizydrop project](https://vizydrop.com/)
[Taucharts Twitter channel](https://twitter.com/search?q=taucharts)
[Taucharts demo page](https://demo.taucharts.com/)
[GeoTremor mobile app](http://geotremor.tangentapps.com)
[GeoTremor mobile app](https://geotremor.tangentapps.com)
[Dex](https://dexvis.net/)
[Dex integration video](https://youtu.be/mxD4aQmC4sg)
## License
Licensing: [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
Licensing: [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
Have questions? [Contact us](mailto:[email protected])
31 changes: 0 additions & 31 deletions bower.json

This file was deleted.

Loading

0 comments on commit 85b43e7

Please sign in to comment.