Skip to content

Generate charts as images using API. Embed dynamic charts as images in Github Markdown.

License

Notifications You must be signed in to change notification settings

kevincobain2000/instachart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

c2p

Chart as Image - service using go-chart and go-charts.

coverage

go-binary-size unit-test-run-time build-time go-mod-dependencies go-sec-issues

Quick Setup: Easy setup. Add charts as images in markdown, emails etc.

Hassle Free: Create charts as images with single URL.

Supports: Choose from Line, bar, donut, pie, scatter, bubble, stacked bar, etc.

Lightweight: Written in Go. No external dependencies. Download and self-host binary.

API Documentation Restful API with image/png response.

API

URL https://instachart.coveritup.app

Common Queries Required Description Default
data JSON
title string
subtitle string
theme string light or dark
metric string
height int 400
width int 600

GET /line

Query Required Description Default
fill boolean false
data Required Description
x []Array (string)
y []Array (int)
names Array
https://instachart.coveritup.app/line?title=Line+Chart+Simple&subtitle=Sleeping+Hours&data={
    "x": [["Mon","Tue","Wed"]],
    "y": [[4,8,7], [10,20,24]],
    "names": ["Sleeping", "Awake"]
}

line chart

https://instachart.coveritup.app/line?title=Line+Chart+Simple&subtitle=Sleeping+Hours&data={
    "x": [["Mon","Tue","Wed"]],
    "y": [[4,8,7], [10,20,24]],
    "names": ["Sleeping", "Awake"]
}

line area chart

GET /bar

Query Required Description Default
horizontal boolean false
data Required Description
x Array (string)
y []Array (int)
https://instachart.coveritup.app/bar?title=Bar+Chart&subtitle=Sleeping+hours&data={
    "x": ["Monday", "Friday", "Sunday"],
    "y": [[8,2,14]]
}

bar chart

GET /donut

data Required Description
names Array (string)
values Array (int)
https://instachart.coveritup.app/donut?title=Donut+Chart&data={
    "names": ["Monday", "Friday", "Saturday", "Sunday"],
    "values": [4, 6 ,7, 9]
}

donut chart

GET /pie

data Required Description
names Array (string)
values Array (int)
https://instachart.coveritup.app/pie?title=Pie+Chart&subtitle=Sleeping+Hours&data={
    "names": ["Monday", "Friday", "Saturday", "Sunday"],
    "values": [4, 6 ,7, 9]
}

pie chart

GET /radar

data Required Description Validation
names Array (string) >=3
values []Array (int) count(names) == count(values[0])
labels Array (string)
https://instachart.coveritup.app/radar?title=Radar+Chart&data={
    "names": ["Mon","Tue", "Wed", "Fri"],
    "labels": ["Work", "Relax", "Travel"],
    "values": [[1,2,3,4], [15,7,8,9], [15,17,5,7]]
}

radar chart

GET /funnel

data Required Description
names Array (string)
values Array (int)
https://instachart.coveritup.app/funnel?title=Radar+Chart&data={
    "names": ["Mon","Tue", "Wed", "Sat"],
    "values": [2,1,4,6]
}

radar chart

GET /table

data Required Description
names Array (string) aka header
values []Array (string) aka rows
https://instachart.coveritup.app/table?title=Table+Chart&data={
    "names": ["Branch","Code Coverage", "Quality"],
    "values": [["master","80","90"], ["develop","70","79"]]
}

radar chart

CHANGE LOG

  • v1.0.0 - Initial release with line, bar, donut, pie, radar.
  • v1.0.1 - Bug fixes and code refactor.
  • v1.0.2 - funnel charts and table as image.