QuickChart 2.2.0

Install-Package QuickChart -Version 2.2.0
dotnet add package QuickChart --version 2.2.0
<PackageReference Include="QuickChart" Version="2.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add QuickChart --version 2.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: QuickChart, 2.2.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install QuickChart as a Cake Addin
#addin nuget:?package=QuickChart&version=2.2.0

// Install QuickChart as a Cake Tool
#tool nuget:?package=QuickChart&version=2.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

quickchart-csharp

A C# client for the quickchart.io chart API.

Installation

Use QuickChart/QuickChart.cs in this project, or install the QuickChart package from NuGet:

PM> Install-Package QuickChart -Version 2.1.0

or

dotnet add package QuickChart --version 2.1.0

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 config:

Chart qc = new Chart();

qc.Width = 500;
qc.Height = 300;
qc.Version = "2.9.4";
qc.Config = @"{
    type: 'bar',
    data: {
        labels: ['Q1', 'Q2', 'Q3', 'Q4'],
        datasets: [{
            label: 'Users',
            data: [50, 60, 70, 180]
        }]
    }
}";

Use GetUrl() on your QuickChart object to get the encoded URL that renders your chart:

Console.WriteLine(qc.GetUrl());
// https://quickchart.io/chart?c=%7B%22chart%22%3A+%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%7D&w=600&h=300&bkg=%23ffffff&devicePixelRatio=2.0&f=png

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):

Console.WriteLine(qc.GetShortUrl());
// https://quickchart.io/chart/render/f-a1d3e804-dfea-442c-88b0-9801b9808401

The URLs will render an image of a chart.


Customizing your chart

You can set the following properties:

Config: 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

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: double

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.

Format: string

The output format of the chart. Defaults to "png"

Version: string

Chart.js version (not required)

Key: string

API key (not required)


Creating chart URLs

There are a few 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 methods
ToFile(string path)

Write your chart to file.

ToByteArray(): byte[]

Returns an array of bytes representing your image.

More examples

Checkout the QuickChartExamples project to see other usage.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on QuickChart:

Package Downloads
AutoTestExtras.Core

Automation test extension for API/Web/Mobile/Performance with enabled dotnet core support and other features. This package includes the AutoTestExtras framework assembly, which is referenced by your automation tests.

Aletheia.Bot

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.2.0 154 11/7/2021
2.1.0 529 9/21/2021
2.0.0 3,034 12/24/2020
1.0.0 266 11/26/2020