Official Image Charts API client.
Generate URLs of static image charts.
Embed them everywhere in emails, pdf reports, chat bots...!
Getting started
1. Install Image-Charts npm Package
npm install image-charts --save
2. Import Image-Charts library
CommonJS
const ImageCharts = require('image-charts');
ES6
import ImageCharts from 'image-charts';
3. Generate a chart image
const pie = ImageCharts().cht('p').chd('a:2.5,5,8.3').chs('100x100');
pie.toURL();
pie.toFile('/path/to/chart.png');
pie.toDataURI();
pie.toBuffer();
Table of Contents
Constructor
Create an instance, the argument within [ ] is optional. See usage
ImageCharts( [ Object opt ] )
new ImageCharts( [ Object opt ] )
Options
Default options are listed below.
opt = {
timeout: 5000,
secret: null,
host: 'image-charts.com',
protocol: 'https',
port: 443,
pathname: '/chart'
}
Methods
toURL()
: String
Get the full Image-Charts API url (signed and encoded if necessary)
Usage
import ImageCharts from 'image-charts';
const chart_url = ImageCharts()
.cht('bvg')
.chs('300x300')
.chd('a:60,40')
.toURL();
console.log(chart_url);
toFile(file)
: Promise<()>
Creates a file containing generated chart image and yield a promise.
When file
is a filename, asynchronously writes data to the file, replacing the file if it already exists.
When file
is a file descriptor, the behavior is similar to calling fs.write() directly (which is recommended).
Usage
import ImageCharts from 'image-charts';
const chart_path = '/tmp/chart.png';
ImageCharts()
.cht('bvg')
.chs('300x300')
.chd('a:60,40')
.toFile(chart_path)
.then(() => console.log('Image chart written at %s', chart_path))
Do a request to Image-Charts API with current configuration and yield a promise of a NodeJS buffer
Usage
import ImageCharts from 'image-charts';
const chart_url = ImageCharts()
.cht('bvg')
.chs('300x300')
.chd('a:60,40')
.toBuffer();
console.log(chart_url);
toDataURI()
: String
Do a request to Image-Charts API with current configuration and yield a promise of a base64 encoded data URI
Usage
import ImageCharts from 'image-charts';
const chart_url = ImageCharts()
.cht('bvg')
.chs('300x300')
.chd('a:60,40')
.toDataURI();
console.log(chart_url);
Enterprise Support
Image-Charts Enterprise and Enterprise+ subscriptions remove the watermark and enable advanced features like custom-domain, high-resolution charts, custom fonts, multiple axis and mixed charts.
Usage
Once subscribed to a plan you will receive an ACCOUNT_ID
and a SECRET_KEY
.
These two parameters are mandatory to sign your request and remove the watermark.
Replace both values in the code example below:
import ImageCharts from 'image-charts';
const chart_url = ImageCharts({secret: 'SECRET_KEY'})
.icac('ACCOUNT_ID')
.cht('p3')
.chs('700x190')
.chd('t:60,40')
.chl('Hello|World')
.chf('ps0-0,lg,45,ffeb3b,0.2,f44336,1|ps0-1,lg,45,8bc34a,0.2,009688,1')
.icretina('1')
.toURL();
console.log(chart_url);
On-Premise Support
Image-Charts virtual appliance can be deployed anywhere inside a customer network.
import ImageCharts from 'image-charts';
const chart_url = ImageCharts({
secret: 'SECRET_KEY',
host: 'custom-domain.tld'
})
.icac('ACCOUNT_ID')
.cht('p3')
.chs('700x190')
.chd('t:60,40')
.chl('Hello|World')
.chf('ps0-0,lg,45,ffeb3b,0.2,f44336,1|ps0-1,lg,45,8bc34a,0.2,009688,1')
.icretina('1')
.toURL();
console.log(chart_url);
Chart type
Reference
Allowed values:
.cht("bvs")
.cht("bvg")
.cht("bhs")
.cht("bhg")
.cht("bvo")
Other allowed values are:
p | p3 | pc | pd | ls | lc | lxy | ls:nda | lc:nda | lxy:nda | pa | bb | gv | gv:dot | gv:neato | gv:circo | gv:fdp | gv:osage | gv:twopi | qr | r
chart data
Reference
Usage
.chd("a:-100,200.5,75.55,110")
.chd("t:10,20,30|15,25,35")
.chd("s:BTb19_,Mn5tzb")
.chd("e:BaPoqM2s,-A__RMD6")
data format with custom scaling
Reference
Usage
.chds("-80,140")
QRCode data encoding
Reference
Allowed values:
.choe("UTF-8")
QRCode error correction level and optional margin
Reference
Usage
.chld("L|4")
.chld("M|10")
.chld("Q|5")
.chld("H|18")
Axis data-range
Reference
Usage
.chxr("0,0,200")
.chxr("0,10,50,5")
.chxr("0,0,500|1,0,200")
Image output format
Reference
Usage
.chof(".png")
.chof(".svg")
.chof(".gif")
Chart size (<width>x<height>)
Reference
Usage
.chs("400x400")
Text for each series, to display in the legend
Reference
Usage
.chdl("NASDAQ|FTSE100|DOW")
Chart legend text and style
Reference
Usage
.chdls("9e9e9e,17")
Solid or dotted grid lines
Reference
Usage
.chg("1,1")
.chg("0,1,1,5")
.chg("1,1,FF00FF")
.chg("1,1,1,1,CECECE")
series colors
Reference
Usage
.chco("FFC48C")
.chco("FF0000,00FF00,0000FF")
chart title
Reference
Usage
.chtt("My beautiful chart")
chart title colors and font size
Reference
Usage
.chts("00FF00,17")
Display values on your axis lines or change which axes are shown
Reference
Usage
.chxt("y")
.chxt("x,y")
.chxt("x,x,y")
.chxt("x,y,t,r,t")
Custom string axis labels on any axis
Reference
Usage
.chxl("0:|Jan|July|Jan")
.chxl("0:|Jan|July|Jan|1|10|20|30")
Font size, color for axis labels, both custom labels and default label values
Reference
Usage
.chxs("1,0000DD")
.chxs("1NcUSDMil,FF0000")
.chxs("1NcEUR,FF0000")
.chxs("2,0000DD,13,0,t")
.chxs("0Npper-month,0000FF")
compound charts and line fills
Reference
Usage
line thickness and solid/dashed style
Reference
Usage
.chls("10")
.chls("3,6,3|5")
bar, pie slice, doughnut slice and polar slice chart labels
Reference
Usage
.chl("label1|label2")
.chl("multi
line
label1|label2")
Position and style of labels on data
Reference
Usage
.chlps("align,top|offset,10|color,FF00FF")
.chlps("align,top|offset,10|color,FF00FF")
chart margins
Reference
Usage
.chma("30,30,30,30")
.chma("40,20")
Position of the legend and order of the legend entries
Reference
Usage
Background Fills
Reference
Usage
.chf("b0,lg,0,f44336,0.3,03a9f4,0.8")
Bar corner radius. Display bars with rounded corner.
Reference
Usage
.chbr("5")
.chbr("10")
gif configuration
Reference
Usage
.chan("1200")
.chan("1300|easeInOutSine")
doughnut chart inside label
Reference
Usage
.chli("95K€")
.chli("45%")
image-charts enterprise account_id
Reference
Usage
.icac("accountId")
HMAC-SHA256 signature required to activate paid features
Reference
Usage
.ichm("0785cf22a0381c2e0239e27c126de4181f501d117c2c81745611e9db928b0376")
Default font family for all text from Google Fonts. Use same syntax as Google Font CSS API
Reference
Allowed values:
.icff("ABeeZee")
.icff("Abel")
.icff("Abhaya Libre")
.icff("Abril Fatface")
.icff("Aclonica")
Other allowed values are:
Acme | Actor | Adamina | Advent Pro | Aguafina Script | Akronim | Aladin | Aldrich | Alef | Alegreya | Alegreya SC | Alegreya Sans | Alegreya Sans SC | Aleo | Alex Brush | Alfa Slab One | Alice | Alike | Alike Angular | Allan | Allerta | Allerta Stencil | Allura | Almarai | Almendra | Almendra Display | Almendra SC | Amarante | Amaranth | Amatic SC | Amethysta | Amiko | Amiri | Amita | Anaheim | Andada | Andika | Angkor | Annie Use Your Telescope | Anonymous Pro | Antic | Antic Didone | Antic Slab | Anton | Arapey | Arbutus | Arbutus Slab | Architects Daughter | Archivo | Archivo Black | Archivo Narrow | Aref Ruqaa | Arima Madurai | Arimo | Arizonia | Armata | Arsenal | Artifika | Arvo | Arya | Asap | Asap Condensed | Asar | Asset | Assistant | Astloch | Asul | Athiti | Atma | Atomic Age | Aubrey | Audiowide | Autour One | Average | Average Sans | Averia Gruesa Libre | Averia Libre | Averia Sans Libre | Averia Serif Libre | B612 | B612 Mono | Bad Script | Bahiana | Bahianita | Bai Jamjuree | Baloo | Baloo Bhai | Baloo Bhaijaan | Baloo Bhaina | Baloo Chettan | Baloo Da | Baloo Paaji | Baloo Tamma | Baloo Tammudu | Baloo Thambi | Balthazar | Bangers | Barlow | Barlow Condensed | Barlow Semi Condensed | Barriecito | Barrio | Basic | Battambang | Baumans | Bayon | Be Vietnam | Belgrano | Bellefair | Belleza | BenchNine | Bentham | Berkshire Swash | Beth Ellen | Bevan | Big Shoulders Display | Big Shoulders Text | Bigelow Rules | Bigshot One | Bilbo | Bilbo Swash Caps | BioRhyme | BioRhyme Expanded | Biryani | Bitter | Black And White Picture | Black Han Sans | Black Ops One | Blinker | Bokor | Bonbon | Boogaloo | Bowlby One | Bowlby One SC | Brawler | Bree Serif | Bubblegum Sans | Bubbler One | Buda | Buenard | Bungee | Bungee Hairline | Bungee Inline | Bungee Outline | Bungee Shade | Butcherman | Butterfly Kids | Cabin | Cabin Condensed | Cabin Sketch | Caesar Dressing | Cagliostro | Cairo | Calligraffitti | Cambay | Cambo | Candal | Cantarell | Cantata One | Cantora One | Capriola | Cardo | Carme | Carrois Gothic | Carrois Gothic SC | Carter One | Catamaran | Caudex | Caveat | Caveat Brush | Cedarville Cursive | Ceviche One | Chakra Petch | Changa | Changa One | Chango | Charm | Charmonman | Chathura | Chau Philomene One | Chela One | Chelsea Market | Chenla | Cherry Cream Soda | Cherry Swash | Chewy | Chicle | Chilanka | Chivo | Chonburi | Cinzel | Cinzel Decorative | Clicker Script | Coda | Coda Caption | Codystar | Coiny | Combo | Comfortaa | Coming Soon | Concert One | Condiment | Content | Contrail One | Convergence | Cookie | Copse | Corben | Cormorant | Cormorant Garamond | Cormorant Infant | Cormorant SC | Cormorant Unicase | Cormorant Upright | Courgette | Cousine | Coustard | Covered By Your Grace | Crafty Girls | Creepster | Crete Round | Crimson Pro | Crimson Text | Croissant One | Crushed | Cuprum | Cute Font | Cutive | Cutive Mono | DM Sans | DM Serif Display | DM Serif Text | Damion | Dancing Script | Dangrek | Darker Grotesque | David Libre | Dawning of a New Day | Days One | Dekko | Delius | Delius Swash Caps | Delius Unicase | Della Respira | Denk One | Devonshire | Dhurjati | Didact Gothic | Diplomata | Diplomata SC | Do Hyeon | Dokdo | Domine | Donegal One | Doppio One | Dorsa | Dosis | Dr Sugiyama | Duru Sans | Dynalight | EB Garamond | Eagle Lake | East Sea Dokdo | Eater | Economica | Eczar | El Messiri | Electrolize | Elsie | Elsie Swash Caps | Emblema One | Emilys Candy | Encode Sans | Encode Sans Condensed | Encode Sans Expanded | Encode Sans Semi Condensed | Encode Sans Semi Expanded | Engagement | Englebert | Enriqueta | Erica One | Esteban | Euphoria Script | Ewert | Exo | Exo 2 | Expletus Sans | Fahkwang | Fanwood Text | Farro | Farsan | Fascinate | Fascinate Inline | Faster One | Fasthand | Fauna One | Faustina | Federant | Federo | Felipa | Fenix | Finger Paint | Fira Code | Fira Mono | Fira Sans | Fira Sans Condensed | Fira Sans Extra Condensed | Fjalla One | Fjord One | Flamenco | Flavors | Fondamento | Fontdiner Swanky | Forum | Francois One | Frank Ruhl Libre | Freckle Face | Fredericka the Great | Fredoka One | Freehand | Fresca | Frijole | Fruktur | Fugaz One | GFS Didot | GFS Neohellenic | Gabriela | Gaegu | Gafata | Galada | Galdeano | Galindo | Gamja Flower | Gayathri | Gentium Basic | Gentium Book Basic | Geo | Geostar | Geostar Fill | Germania One | Gidugu | Gilda Display | Give You Glory | Glass Antiqua | Glegoo | Gloria Hallelujah | Goblin One | Gochi Hand | Gorditas | Gothic A1 | Goudy Bookletter 1911 | Graduate | Grand Hotel | Gravitas One | Great Vibes | Grenze | Griffy | Gruppo | Gudea | Gugi | Gurajada | Habibi | Halant | Hammersmith One | Hanalei | Hanalei Fill | Handlee | Hanuman | Happy Monkey | Harmattan | Headland One | Heebo | Henny Penny | Hepta Slab | Herr Von Muellerhoff | Hi Melody | Hind | Hind Guntur | Hind Madurai | Hind Siliguri | Hind Vadodara | Holtwood One SC | Homemade Apple | Homenaje | IBM Plex Mono | IBM Plex Sans | IBM Plex Sans Condensed | IBM Plex Serif | IM Fell DW Pica | IM Fell DW Pica SC | IM Fell Double Pica | IM Fell Double Pica SC | IM Fell English | IM Fell English SC | IM Fell French Canon | IM Fell French Canon SC | IM Fell Great Primer | IM Fell Great Primer SC | Iceberg | Iceland | Imprima | Inconsolata | Inder | Indie Flower | Inika | Inknut Antiqua | Irish Grover | Istok Web | Italiana | Italianno | Itim | Jacques Francois | Jacques Francois Shadow | Jaldi | Jim Nightshade | Jockey One | Jolly Lodger | Jomhuria | Jomolhari | Josefin Sans | Josefin Slab | Joti One | Jua | Judson | Julee | Julius Sans One | Junge | Jura | Just Another Hand | Just Me Again Down Here | K2D | Kadwa | Kalam | Kameron | Kanit | Kantumruy | Karla | Karma | Katibeh | Kaushan Script | Kavivanar | Kavoon | Kdam Thmor | Keania One | Kelly Slab | Kenia | Khand | Khmer | Khula | Kirang Haerang | Kite One | Knewave | KoHo | Kodchasan | Kosugi | Kosugi Maru | Kotta One | Koulen | Kranky | Kreon | Kristi | Krona One | Krub | Kumar One | Kumar One Outline | Kurale | La Belle Aurore | Lacquer | Laila | Lakki Reddy | Lalezar | Lancelot | Lateef | Lato | League Script | Leckerli One | Ledger | Lekton | Lemon | Lemonada | Lexend Deca | Lexend Exa | Lexend Giga | Lexend Mega | Lexend Peta | Lexend Tera | Lexend Zetta | Libre Barcode 128 | Libre Barcode 128 Text | Libre Barcode 39 | Libre Barcode 39 Extended | Libre Barcode 39 Extended Text | Libre Barcode 39 Text | Libre Baskerville | Libre Caslon Display | Libre Caslon Text | Libre Franklin | Life Savers | Lilita One | Lily Script One | Limelight | Linden Hill | Literata | Liu Jian Mao Cao | Livvic | Lobster | Lobster Two | Londrina Outline | Londrina Shadow | Londrina Sketch | Londrina Solid | Long Cang | Lora | Love Ya Like A Sister | Loved by the King | Lovers Quarrel | Luckiest Guy | Lusitana | Lustria | M PLUS 1p | M PLUS Rounded 1c | Ma Shan Zheng | Macondo | Macondo Swash Caps | Mada | Magra | Maiden Orange | Maitree | Major Mono Display | Mako | Mali | Mallanna | Mandali | Manjari | Mansalva | Manuale | Marcellus | Marcellus SC | Marck Script | Margarine | Markazi Text | Marko One | Marmelad | Martel | Martel Sans | Marvel | Mate | Mate SC | Maven Pro | McLaren | Meddon | MedievalSharp | Medula One | Meera Inimai | Megrim | Meie Script | Merienda | Merienda One | Merriweather | Merriweather Sans | Metal | Metal Mania | Metamorphous | Metrophobic | Michroma | Milonga | Miltonian | Miltonian Tattoo | Mina | Miniver | Miriam Libre | Mirza | Miss Fajardose | Mitr | Modak | Modern Antiqua | Mogra | Molengo | Molle | Monda | Monofett | Monoton | Monsieur La Doulaise | Montaga | Montez | Montserrat | Montserrat Alternates | Montserrat Subrayada | Moul | Moulpali | Mountains of Christmas | Mouse Memoirs | Mr Bedfort | Mr Dafoe | Mr De Haviland | Mrs Saint Delafield | Mrs Sheppards | Mukta | Mukta Mahee | Mukta Malar | Mukta Vaani | Muli | Mystery Quest | NTR | Nanum Brush Script | Nanum Gothic | Nanum Gothic Coding | Nanum Myeongjo | Nanum Pen Script | Neucha | Neuton | New Rocker | News Cycle | Niconne | Niramit | Nixie One | Nobile | Nokora | Norican | Nosifer | Notable | Nothing You Could Do | Noticia Text | Noto Sans | Noto Sans HK | Noto Sans JP | Noto Sans KR | Noto Sans SC | Noto Sans TC | Noto Serif | Noto Serif JP | Noto Serif KR | Noto Serif SC | Noto Serif TC | Nova Cut | Nova Flat | Nova Mono | Nova Oval | Nova Round | Nova Script | Nova Slim | Nova Square | Numans | Nunito | Nunito Sans | Odor Mean Chey | Offside | Old Standard TT | Oldenburg | Oleo Script | Oleo Script Swash Caps | Open Sans | Open Sans Condensed | Oranienbaum | Orbitron | Oregano | Orienta | Original Surfer | Oswald | Over the Rainbow | Overlock | Overlock SC | Overpass | Overpass Mono | Ovo | Oxygen | Oxygen Mono | PT Mono | PT Sans | PT Sans Caption | PT Sans Narrow | PT Serif | PT Serif Caption | Pacifico | Padauk | Palanquin | Palanquin Dark | Pangolin | Paprika | Parisienne | Passero One | Passion One | Pathway Gothic One | Patrick Hand | Patrick Hand SC | Pattaya | Patua One | Pavanam | Paytone One | Peddana | Peralta | Permanent Marker | Petit Formal Script | Petrona | Philosopher | Piedra | Pinyon Script | Pirata One | Plaster | Play | Playball | Playfair Display | Playfair Display SC | Podkova | Poiret One | Poller One | Poly | Pompiere | Pontano Sans | Poor Story | Poppins | Port Lligat Sans | Port Lligat Slab | Pragati Narrow | Prata | Preahvihear | Press Start 2P | Pridi | Princess Sofia | Prociono | Prompt | Prosto One | Proza Libre | Puritan | Purple Purse | Quando | Quantico | Quattrocento | Quattrocento Sans | Questrial | Quicksand | Quintessential | Qwigley | Racing Sans One | Radley | Rajdhani | Rakkas | Raleway | Raleway Dots | Ramabhadra | Ramaraja | Rambla | Rammetto One | Ranchers | Rancho | Ranga | Rasa | Rationale | Ravi Prakash | Red Hat Display | Red Hat Text | Redressed | Reem Kufi | Reenie Beanie | Revalia | Rhodium Libre | Ribeye | Ribeye Marrow | Righteous | Risque | Roboto | Roboto Condensed | Roboto Mono | Roboto Slab | Rochester | Rock Salt | Rokkitt | Romanesco | Ropa Sans | Rosario | Rosarivo | Rouge Script | Rozha One | Rubik | Rubik Mono One | Ruda | Rufina | Ruge Boogie | Ruluko | Rum Raisin | Ruslan Display | Russo One | Ruthie | Rye | Sacramento | Sahitya | Sail | Saira | Saira Condensed | Saira Extra Condensed | Saira Semi Condensed | Saira Stencil One | Salsa | Sanchez | Sancreek | Sansita | Sarabun | Sarala | Sarina | Sarpanch | Satisfy | Sawarabi Gothic | Sawarabi Mincho | Scada | Scheherazade | Schoolbell | Scope One | Seaweed Script | Secular One | Sedgwick Ave | Sedgwick Ave Display | Sevillana | Seymour One | Shadows Into Light | Shadows Into Light Two | Shanti | Share | Share Tech | Share Tech Mono | Shojumaru | Short Stack | Shrikhand | Siemreap | Sigmar One | Signika | Signika Negative | Simonetta | Single Day | Sintony | Sirin Stencil | Six Caps | Skranji | Slabo 13px | Slabo 27px | Slackey | Smokum | Smythe | Sniglet | Snippet | Snowburst One | Sofadi One | Sofia | Song Myung | Sonsie One | Sorts Mill Goudy | Source Code Pro | Source Sans Pro | Source Serif Pro | Space Mono | Special Elite | Spectral | Spectral SC | Spicy Rice | Spinnaker | Spirax | Squada One | Sree Krushnadevaraya | Sriracha | Srisakdi | Staatliches | Stalemate | Stalinist One | Stardos Stencil | Stint Ultra Condensed | Stint Ultra Expanded | Stoke | Strait | Stylish | Sue Ellen Francisco | Suez One | Sumana | Sunflower | Sunshiney | Supermercado One | Sura | Suranna | Suravaram | Suwannaphum | Swanky and Moo Moo | Syncopate | Tajawal | Tangerine | Taprom | Tauri | Taviraj | Teko | Telex | Tenali Ramakrishna | Tenor Sans | Text Me One | Thasadith | The Girl Next Door | Tienne | Tillana | Timmana | Tinos | Titan One | Titillium Web | Trade Winds | Trirong | Trocchi | Trochut | Trykker | Tulpen One | Turret Road | Ubuntu | Ubuntu Condensed | Ubuntu Mono | Ultra | Uncial Antiqua | Underdog | Unica One | UnifrakturCook | UnifrakturMaguntia | Unkempt | Unlock | Unna | VT323 | Vampiro One | Varela | Varela Round | Vast Shadow | Vesper Libre | Vibes | Vibur | Vidaloka | Viga | Voces | Volkhov | Vollkorn | Vollkorn SC | Voltaire | Waiting for the Sunrise | Wallpoet | Walter Turncoat | Warnes | Wellfleet | Wendy One | Wire One | Work Sans | Yanone Kaffeesatz | Yantramanav | Yatra One | Yellowtail | Yeon Sung | Yeseva One | Yesteryear | Yrsa | ZCOOL KuaiLe | ZCOOL QingKe HuangYou | ZCOOL XiaoWei | Zeyada | Zhi Mang Xing | Zilla Slab | Zilla Slab Highlight
Default font style for all text
Reference
Allowed values:
.icfs("normal")
.icfs("italic")
localization (ISO 639-1)
Allowed values:
.iclocale("fr")
.iclocale("de")
.iclocale("en")
retina mode
Reference
Allowed values:
.icretina("0")
.icretina("1")
Background color for QR Codes
Reference
Usage
.icqrb("FFFFFF")
Foreground color for QR Codes
Reference
Usage
.icqrf("000000")