Download the PHP package ianw/quickchart without Composer
On this page you can find all versions of the php package ianw/quickchart. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ianw/quickchart
More information about ianw/quickchart
Files in ianw/quickchart
Package quickchart
Short Description QuickChart chart API
License MIT
Homepage http://github.com/typpo/quickchart-php
Rated 5.00 based on 1 reviews
Informations about the package quickchart
quickchart-php
A PHP client for the quickchart.io chart image API.
Installation
Use the QuickChart.php
library in this project, or install from packagist.
Usage
This library provides a QuickChart
class. Import and instantiate it. Then set properties on it and specify a Chart.js config:
Use getUrl()
on your QuickChart object to get the encoded URL that renders your chart:
If you have a long or complicated chart, use getShortUrl()
to get a fixed-length URL using the quickchart.io web service (note that these URLs only persist for a short time unless you have a subscription):
The URLs will render an image of a chart:
Creating the chart object
The QuickChart
class constructor accepts an array containing the following keys. All are optional and can be set after object creation:
config: array or string
The actual Chart.js chart configuration.
width: int
Width of the chart image in pixels. Defaults to 500
height: int
Height of the chart image in pixels. Defaults to 300
format: string
Format of the chart. Defaults to png.
backgroundColor: string
The background color of the chart. Any valid HTML color works. Defaults to #ffffff (white). Also takes rgb, rgba, and hsl values.
devicePixelRatio: float
The device pixel ratio of the chart. This will multiply the number of pixels by the value. This is usually used for retina displays. Defaults to 1.0.
version: string
The Chart.js version to use. See documentation for supported versions.
apiKey: string
Your QuickChart API key, if you have one.
Setting properties
Each option above has an associated function call that you can invoke on your QuickChart
object:
setConfig($config)
setWidth($width)
setHeight($height)
setFormat($format)
setBackgroundColor($backgroundColor)
setDevicePixelRatio($devicePixelRatio)
setVersion($version)
setApiKey($apiKey)
Getting URLs
There are two ways to get a URL for your chart object.
getUrl: string
Returns a URL that will display the chart image when loaded.
getShortUrl: string
Uses the quickchart.io web service to create a fixed-length chart URL that displays the chart image. Returns a URL such as https://quickchart.io/chart/render/f-a1d3e804-dfea-442c-88b0-9801b9808401
.
Note that short URLs expire after a few days for users of the free service. You can subscribe to keep them around longer.
Other outputs
toBinary: binary string
Returns a binary string representing the chart image
toFile($path: string)
Write the image to a file
For example:
More examples
Checkout the examples
directory to see other usage.
Troubleshooting
PHP5 users: This package requires curl and json modules.
sslv3 handshake alert failure: You are using an outdated version of curl
. Please upgrade curl on your machine.