mirror of
https://github.com/seigler/neat-charts
synced 2025-07-27 01:16:09 +00:00
114 lines
3.1 KiB
Markdown
114 lines
3.1 KiB
Markdown
# seigler/neat-charts [](https://github.com/seigler/neat-charts/stargazers) [](https://packagist.org/packages/seigler/neat-charts) [](https://github.com/seigler/neat-charts/blob/master/LICENSE.txt)
|
|
|
|
PHP project to generate clean-looking SVG price charts
|
|
|
|
|
|
30 days of Dash price in Bitcoin from Poloniex.com
|
|
|
|
Ethereum 7-day price in BTC from Poloniex 
|
|
|
|
More examples at [cryptohistory.org](http://cryptohistory.org/).
|
|
|
|
## Requirements
|
|
|
|
* PHP >=5.3.0
|
|
|
|
## Installation
|
|
### Using Composer
|
|
|
|
To install using Composer, you will have to install Composer first.
|
|
|
|
`curl -s https://getcomposer.org/installer | php`
|
|
|
|
Create a composer.json file in your project root. Then run this command in your project folder:
|
|
|
|
`composer require seigler/neat-charts`
|
|
|
|
Tell Composer to install the required dependencies.
|
|
|
|
`php composer.phar install`
|
|
|
|
If you want to use the autoloading provided by Composer, add the following line to your application file.
|
|
|
|
`require 'vendor/autoload.php';`
|
|
|
|
You are now ready to use NeatCharts.
|
|
|
|
### Install NeatCharts manually
|
|
|
|
Download the folder `NeatCharts` (in `src`) and place it alongside your php file. Add the following at the top of your PHP file:
|
|
|
|
```php
|
|
spl_autoload_extensions(".php");
|
|
spl_autoload_register();
|
|
```
|
|
This will automatically require the correct files when they are referenced, since the namespace and class names match the folder structure.
|
|
|
|
## Usage
|
|
```php
|
|
Header('Content-type: image/svg+xml; charset=utf-8');
|
|
|
|
$chart = new NeatCharts/LineChart($chartData, [ // all parameters optional
|
|
'width'=>800,
|
|
'height'=>250,
|
|
'lineColor'=>"#1C75BC",
|
|
'labelColor'=>"#777",
|
|
'smoothed'=>false
|
|
]);
|
|
print '<?xml version="1.0" standalone="no"?>';
|
|
print $chart->render();
|
|
```
|
|
|
|
In your HTML:
|
|
`<img src="path to the PHP file">`
|
|
|
|
There are more demos available in `demo.php` and `demo-as-image.php`.
|
|
|
|
## Available Options
|
|
|
|
### LineChart
|
|
| Option | Default |
|
|
| --- | --- |
|
|
| width | 800 |
|
|
| height | 250 |
|
|
| lineColor | '#000' |
|
|
| markerColor | '#000' |
|
|
| labelColor | '#000' |
|
|
| smoothed | false |
|
|
| fontSize | 15 |
|
|
| yAxisEnabled | true |
|
|
| xAxisEnabled | false |
|
|
| yAxisZero | false |
|
|
| filled | false |
|
|
|
|
### BarChart
|
|
| Option | Default |
|
|
| --- | --- |
|
|
| width | 600 |
|
|
| height | 300 |
|
|
| barColor | '#000' |
|
|
| markerColor | '#000' |
|
|
| labelColor | '#000' |
|
|
| fontSize | 15 |
|
|
| yAxisEnabled | true |
|
|
| xAxisEnabled | false |
|
|
| yAxisZero | true |
|
|
|
|
### CandlestickChart
|
|
| Option | Default |
|
|
| --- | --- |
|
|
| width | 1200 |
|
|
| height | 300 |
|
|
| barColor | '#000' |
|
|
| risingFillColor | '#0D0' |
|
|
| fallingFillColor | '#D00' |
|
|
| markerColor | '#000' |
|
|
| labelColor | '#000' |
|
|
| fontSize | 15 |
|
|
| yAxisEnabled | true |
|
|
| xAxisEnabled | false |
|
|
| yAxisZero | false |
|
|
|
|
## Credits
|
|
|
|
* Chart appearance based on advice found at http://vis4.net/blog/posts/doing-the-line-charts-right/
|