Fortunevale/quickchart-csharp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Ian Webster 2020-11-27 15:17:42 -05:00 • committed by GitHub
parent 13fadbb937
commit 6969c66df7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -16,7 +16,7 @@ or
``` ```
dotnet add package QuickChart --version 1.0.0 dotnet add package QuickChart --version 1.0.0
``` ```
---
## Usage ## Usage
This library provides a `QuickChart` namespace containing a `Chart` class. Import and instantiate it. Then set properties on it and specify a [Chart.js](https://chartjs.org) config: This library provides a `QuickChart` namespace containing a `Chart` class. Import and instantiate it. Then set properties on it and specify a [Chart.js](https://chartjs.org) config:
@ -56,6 +56,8 @@ The URLs will render an image of a chart:
<img src="https://quickchart.io/chart?c=%7B%22type%22%3A+%22bar%22%2C+%22data%22%3A+%7B%22labels%22%3A+%5B%22Hello+world%22%2C+%22Test%22%5D%2C+%22datasets%22%3A+%5B%7B%22label%22%3A+%22Foo%22%2C+%22data%22%3A+%5B1%2C+2%5D%7D%5D%7D%7D&w=600&h=300&bkg=%23ffffff&devicePixelRatio=2.0&f=png" width="500" /> <img src="https://quickchart.io/chart?c=%7B%22type%22%3A+%22bar%22%2C+%22data%22%3A+%7B%22labels%22%3A+%5B%22Hello+world%22%2C+%22Test%22%5D%2C+%22datasets%22%3A+%5B%7B%22label%22%3A+%22Foo%22%2C+%22data%22%3A+%5B1%2C+2%5D%7D%5D%7D%7D&w=600&h=300&bkg=%23ffffff&devicePixelRatio=2.0&f=png" width="500" />
---
### Customizing your chart ### Customizing your chart
You can set the following properties: You can set the following properties:
@ -78,6 +80,8 @@ The device pixel ratio of the chart. This will multiply the number of pixels by
#### Key: string #### Key: string
API key (not required) API key (not required)
---
### Creating chart URLs ### Creating chart URLs
There are a few ways to get a URL for your chart object. There are a few ways to get a URL for your chart object.
@ -92,6 +96,8 @@ Uses the quickchart.io web service to create a fixed-length chart URL that displ
Note that short URLs expire after a few days for users of the free service. You can [subscribe](https://quickchart.io/pricing/) to keep them around longer. Note that short URLs expire after a few days for users of the free service. You can [subscribe](https://quickchart.io/pricing/) to keep them around longer.
---
#### Other methods #### Other methods
#### ToFile(string path) #### ToFile(string path)