ExportFusion is the FusionCharts's all purpose Export product which works across all OS and runtimes. The ExportFusion is primarily a CLI based system for easy exporting of Charts, Dashboards in many different image and data formats (PNG, JPEG, SVG, PDF, CSV, XLS and HTML). ExportFusion also comes packed with many language SDK’S (NodeJS, Python, GO, Java, iOS, Android) for easy integration and support across those technologies.
Below are the major features of the product:
- Export FusionCharts charts as PNG, JPEG, SVG, PDF, CSV, XLS and HTML files.
- Exporting of charts is done directly from backend without needing a browser.
- Multiple charts can be exported simultaneously with minimal configuration.
- Sharing, Scheduling etc. can be done as exporting is done from backend.
- Dashboards exporting using user defined template.
- Supports statistics logging of all charts exports in a private setup / central remote server.
- Saving files to FTP or S3
- Doing export from remote server
- Easy configuration management
You need to have node >= 8.0.0 and npm >= 5.0.0 installed in your system to install the CLI.
You will need to download the ExportFusion Service installer from here.
Following screen will be presented once the ExportFusion application is installed & opened.
Primary functionalities those can be performed on the screen are:
- Service Start
- Service Stop
- Service Restart
Logging of the various operation can be viewed in the below panel. Some additional information like host, port and PID of the service can be viewed.
Logs can be saved by session as well as cleared when needed.
To install the CLI in your system run the following command:
npm i -g https://s3.amazonaws.com/fusionimplementation/fc-export-cli-1.0.0-pre-alpha-1.tgz
Or,
git clone https://bitbucket.org/fusioncharts/fc-export-cli
cd fc-export-cli
npm i
npm link
After installing, you should have access to export-fusion command. xf is an alias to export-fusion
export-fusion <options>
Or,
xf <options>
| Option | Alias | Type | Description |
|---|---|---|---|
| --config | -e | file, json | A JSON file that can contain any or all of the cli options. |
| --chart-config | -c | file, json | A JSON or JS file that will contain an array of json objects or just an object which can be passed to the chart constructor for rendering the chart. If it's a JS file the object should be exported. |
| --chart-config-options | -O | json | JSON object that provides an option to override the chart configuration passed through chart-config option. In case of multiple charts all the charts will be effected. |
| --input-file | -i | file | SVG file that needs to be converted. Ignored if chart-config is provided. Path will be taken into account if provided. |
| --output-file | -o | string | Output files that need to be generated. A template can also be giving that will be resolved. For more information see below. |
| --output-file-definition | -F | file | JS or JSON file that contains methods and arrays to use in naming output files. |
| --output-as-zip | -z | bool | To export the output files as zip, or export to individual files. |
| --type | -t | ext | Output file type. |
| --width | -W | value | Chart width in which it should be rendered. |
| --height | -H | value | Chart height in which it should be rendered. |
| --callbacks | -b | file | JS file providing an option to bind custom methods to events fired by FusionCharts library. |
| --template | -T | file | HTML file to use as template for rendering the chart. |
| --resources | -r | file, json | JSON file containing all the resources which will injected into the template while rendering the charts. |
| --library-path | -L | path | Path where FusionCharts library is present. |
| --dashboard-logo | -G | file | Logo path (Only for dashboard export) |
| --dashboard-heading | -D | string | Heading of the exported dashboard. |
| --dashboard-subheading | -B | string | Subheading of the exported dashboard. |
| --log-dest | -d | path | Log destination. Also enables logging. |
| --log-file | -f | file | Log file. |
| --log-level | -l | level | Log level. 0: emerg, 1: alert, 2: crit, 3: error, 4: warning, 5: notice, 6: info, 7: debug |
| --remote-export-enabled | -R | bool | If enabled, the cli will use the export server api to export the images. |
| --export-url | -u | url | Export server url. |
column_chart_config.json contains a sample fusioncharts column chart config
column_chart_config.json
[
{
"type": "column2d",
"renderAt": "chart-container",
"width": "550",
"height": "350",
"dataFormat": "json",
"dataSource": {
"chart": {
"caption": "Number of visitors last week",
"subCaption": "Bakersfield Central vs Los Angeles Topanga"
},
"data": [
{
"label": "Mon",
"value": "15123"
},
{
"label": "Tue",
"value": "14233"
},
{
"label": "Wed",
"value": "25507"
}
]
}
}
]$ xf -c column_chart_config.jsonThis will export the Column chart in PNG format in the current working directory.
multiple_charts_config.json
[
{
"type": "pie2d",
"renderAt": "pie_chart",
"width": "500",
"height": "400",
"dataFormat": "json",
"dataSource": {
"chart": {
"caption": "Number of visitors last week",
"subCaption": "Bakersfield Central vs Los Angeles Topanga"
},
"categories": [
{
"category": [
{
"label": "Mon"
},
{
"label": "Tue"
},
{
"label": "Wed"
}
]
}
],
"dataset": [
{
"seriesname": "Los Angeles Topanga",
"data": [
{
"value": "13400"
},
{
"value": "12800"
},
{
"value": "22800"
}
]
}
]
}
},
{
"type": "mscolumn2d",
"renderAt": "column_chart",
"width": "450",
"height": "420",
"dataFormat": "json",
"dataSource": {
"chart": {
"caption": "Split of Sales by Product Category",
"subCaption": "In top 5 stores last month",
"yAxisname": "Sales (In USD)"
},
"categories": [
{
"category": [
{
"label": "Bakersfield Central"
},
{
"label": "Garden Groove harbour"
}
]
}
],
"dataset": [
{
"seriesname": "Food Products",
"data": [
{
"value": "17000"
},
{
"value": "19500"
}
]
},
{
"seriesname": "Non-Food Products",
"data": [
{
"value": "25400"
},
{
"value": "29800"
}
]
}
]
}
}
]$ xf -c multiple_charts_config.json -t pdf -o ./exported-charts/To export Dashboard using CLI, a template file has to be provided with the layout and supporting static resource (JS, CSS, Images, Fonts).
The template must contain placeholder elements (preferably divs) for the charts. The chart config array must contain the charts with the renderAt attributes that matches the id of the elements stated above.
The resources option is optional and only needed when remote-export-enabled is true. Most resources that are stated in the template in link, script or img tags are found intelligently. If any additional fonts, links present in css or dynamic links in JS is present one has to specify them in resources option.
The format of the resources option is as follows:
{
"images": [
"filename.jpg",
"img/cat.png"
],
"stylesheets": [
"",
""
],
"javascripts": [
"",
""
],
"fonts": [
"",
""
]
}template.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Chart</title>
</head>
<body>
<div id="pie_chart"></div>
<div id="column_chart"></div>
</body>
</html>multiple_charts_config.json
[
{
"type": "pie2d",
"renderAt": "pie_chart",
"width": "500",
"height": "400",
"dataFormat": "json",
"dataSource": {
"chart": {
"caption": "Number of visitors last week",
"subCaption": "Bakersfield Central vs Los Angeles Topanga"
},
"categories": [
{
"category": [
{
"label": "Mon"
},
{
"label": "Tue"
},
{
"label": "Wed"
}
]
}
],
"dataset": [
{
"seriesname": "Los Angeles Topanga",
"data": [
{
"value": "13400"
},
{
"value": "12800"
},
{
"value": "22800"
}
]
}
]
}
},
{
"type": "mscolumn2d",
"renderAt": "column_chart",
"width": "450",
"height": "420",
"dataFormat": "json",
"dataSource": {
"chart": {
"caption": "Split of Sales by Product Category",
"subCaption": "In top 5 stores last month",
"yAxisname": "Sales (In USD)"
},
"categories": [
{
"category": [
{
"label": "Bakersfield Central"
},
{
"label": "Garden Groove harbour"
}
]
}
],
"dataset": [
{
"seriesname": "Food Products",
"data": [
{
"value": "17000"
},
{
"value": "19500"
}
]
},
{
"seriesname": "Non-Food Products",
"data": [
{
"value": "25400"
},
{
"value": "29800"
}
]
}
]
}
}
]$ xf -c multiple_charts_config.json -T template.html -t PDF -o ./exported-dashboards/The output-file option can take a template which is then resolved using ejs, so that the output filenames can be generated exactly as you wanted it to be.
There are 2 inbuilt function and you can provide you own ones in another JS file and pass it in the option output-file-definition
The 2 inbuilt functions are
-
number(start, end, step): It increments a number fromstarttoendwithstepas provided.endandstepare optional. -
timestamp(): It provides the current time is millisecond.
You can provide custom functions or arrays in definition file. Example:
module.exports = {
caption: (chartConfig, index) => {
const caption = chartConfig.dataSource.chart.caption;
return `${index}__${caption}`;
},
art: ['S1', 'S2', 'S3', 'S4'],
};Functions will get 3 arguments the current chart config, the index and array of all the chart configs.
Arrays will the iterated one by one and the last one will be repeated if more is needed.
Example filenames:
path/to/export--<%= number(1, 100) %>
# path/to/export--1.png
path/to/export--<%= number(2) %>__<%= caption() %>-<%= timestamp() %>
# path/to/export--2__Some Caption-23423438788.pngOutput files can be saved in FTP and AWS S3 directly.
First you need to provide the credentials in the configuration file. FTP configs are in config/ftp.json and S3 configs are in config/s3.json.
In the output-file options, to upload through FTP specify the filename as
ftp:path/to/export--<%= number(1) %>
to upload files to S3 specify the filename as
s3:export--<%= number(1) %>
Some preconfigured test configs are present in the uat folder. You can pass those export config files to the -e or --config options to run a quick test, or take a look inside it to get an idea how options can be passed in different situations.
Some example commands for running a quick test are
xf -e uat/fusioncharts_export.json
xf -e uat/fusioncharts_export_svg.json
xf -e uat/fusioncharts_export_tmpl.json
xf -e uat/fusioncharts_export_20charts.json
xf -e uat/fusioncharts_export_50charts.json