Node.js

Class: ExportManager

ExportManager is the most essential module in order to access actions related to FusionExport like, change the export file quality, set up the file format, etc.

Constructor: new ExportManager(config)

The constructor of ExportManager takes a config object that can contain host and port values. These values will be used when connecting to FusionExport Server.

Parameters

Example

new ExportManager({
  host: "api.fusionexport.com",
  port: 1337
});COPY

Method: export(exportConfig[, outputDirPath, unzipFlag])

This is the most important method from ExportManager module. Based on the configuration provided, this method exports your charts and dashboards to the given format.

It returns a promise that resolves to the array filenames of the exported files or gets rejected by an error.

Parameters

Returns

• Promise: It returns a promise that resolves to the array of filenames of the exported files or gets rejected by an error.

Example

exportManager
  .export(exportConfig, ".", true)
  .then(exportedFiles => {
    exportedFiles.forEach(file => console.log(file));
  })
  .catch(err => {
    console.log(err);
  });COPY

Method: exportAsStream(ExportConfig exportConfig)

You can get exported output as a stream and can work with it. Based on the configuration provided, this method exports your charts and dashboards as a stream.

Parameters

Returns

• Promise: It returns a promise that resolves to the array of filenames of the exported files or gets rejected by an error.

Example

const path = require("path");
// Require FusionExport
const { ExportManager, ExportConfig } = require("fusionexport-node-client");

// Instantiate ExportManager and ExportConfig
const exportManager = new ExportManager();
const exportConfig = new ExportConfig();

// add the required configurations
exportConfig.set(
  "chartConfig",
  path.join(__dirname, "resources", "single.json")
);
exportConfig.set("quality", "best");

exportManager
  .exportAsStream(exportConfig)
  .then(exportedFiles => {
    Object.keys(exportedFiles).forEach(key => {
      console.log(key, exportedFiles[key]);
    });
  })
  .catch(err => {
    console.log(err);
  });COPY

Class: ExportConfig

ExportConfig class is used to set up all the configs for a single export weather it is a dashboard export, single export or a batch export.

Constructor: new ExportConfig()

This constructor does not take any argument.

Example

new ExportConfig();COPY

Method: set()

Takes two argument first one as the key second one as the value. You can find more about the options later on in this guide.

Parameters

Returns

• ExportConfig: The instance of the exportConfig for method chaining.

Example

exportConfig.set(
  "chartConfig",
  path.join(__dirname, "resources", "single.json")
);COPY

Method: get()

Takes one argument as the key and returns the value.

Parameters

Returns

• String, Number or Boolean: The value of the specified config.

Example

exportConfig.get("chartConfig");COPY

Method: has()

Takes one argument as the key and returns a boolean if it is set or not.

Parameters

Returns

• Boolean: Return a boolean depending on wheather the key is set or not.

Example

exportConfig.has("chartConfig");COPY

Method: remove()

Takes one argument as the key and removes that value if it was set.

Parameters

Returns

• ExportConfig: The instance of the exportConfig for method chaining.

Example

exportConfig.remove("chartConfig");COPY

Method: clear()

Clears all the values that were set earlier.

Returns

• ExportConfig: The instance of the exportConfig for method chaining.

Example

exportConfig.clear();COPY

ExportConfig Options

There are plenty of options which you can configure in ExportConfig. These options essentially help you set quality of the image to define how your chart is going to look like.

chartConfig

Sets the configuration of a single chart or multiple charts in an array. This configuration should follow FusionCharts JSON structure. It accepts, file path of the JSON where chart configurations have been stored.

• Type: String

Example

exportConfig.set("chartConfig", "resources/chart-config-file.json");COPY

inputSVG

This option is useful to export your SVG files to the file formats supported by FusionExport. It accepts file path of the SVG in string format.

• Type: String

Example

exportConfig.set("inputSVG", "resources/vector.svg");COPY

template

Accepts only the template string. Throws an exception if data provided by the user is not a string.

• Type: String

Example

exportConfig.set("template", "<html>...</html>");COPY

templateWidth

Sets the width of the viewport in which it will get rendered. Throws an exception when the data provided by the user is not a string or when the parse value of the string is NaN.

• Type: String/Number

Example

// With a number
exportConfig.set("templateWidth", 1200);

// With a string
exportConfig.set("templateWidth", "1200");COPY

templateHeight

Sets the height of the viewport in which it will get rendered. Throws an exception when the data provided by the user is not a string or when the parsed value of the string is NaN.

• Type: String/Number

Example

// With a number
exportConfig.set("templateHeight", 3000);

// With a string
exportConfig.set("templateHeight", "3000");COPY

templateFormat

Sets the format of the PDF pages during a PDF export. This option takes priority over templateWidth and templateHeight. Throws an exception when the data provided by the user is not a string or when the format is not in the supported set.

• Type: String

The available options are:

• Letter: 8.5in x 11in
• Legal: 8.5in x 14in
• Tabloid: 11in x 17in
• Ledger: 17in x 11in
• A0: 33.1in x 46.8in
• A1: 23.4in x 33.1in
• A2: 16.5in x 23.4in
• A3: 11.7in x 16.5in
• A4: 8.27in x 11.7in
• A5: 5.83in x 8.27in

Example

exportConfig.set("templateFormat", "A4");COPY

templateFilePath

Sets the path of the HTML template used for dashboard export

• Type: String

Example

exportConfig.set("templateFilePath", "resources/template.html");COPY

resourceFilePath

JSON file having the dependencies of the template when templateFilePath is provided. basePath denotes the base path of the project no local resource should be present outside this directory. include takes one or more glob to specify which files to send to the server. exclude take sone or more glob to specify which files should be excluded.

• Type: String

Example

exportConfig.set("resourceFilePath", "resources/resource.json");COPY

The resource.json looks like as shown below:

{
    "basePath": "../src/",
    "include": [
        '**/*.js'
    ],
    "exlcude": [
        '.env'
    ]
}COPY

callbackFilePath

Sets the path for a Javascript file that would be injected at the bottom of the page for each export

• Type: String

Example

exportConfig.set("callbackFilePath", "resources/callback.js");COPY

asyncCapture

Sets if the export process will wait for CAPTURE_EXIT event

• Type: Boolean

Example

exportConfig.set("asyncCapture", true);COPY

maxWaitForCaptureExit

Sets the maximum time FusionExport would wait for the CAPTURE_EXIT event to be triggered

• Type: Integer

Example

exportConfig.set("maxWaitForCaptureExit", 8000);COPY

dashboardLogo

Sets the path to the logo file

• Type: String

Example

exportConfig.set("dashboardLogo", "resources/logo.jpg");COPY

dashboardHeading

Sets the title of the dashboard

• Type: String

Example

exportConfig.set("dashboardHeading", "FusionCharts");COPY

dashboardSubheading

Sets the sub-title of the dashboard

• Type: String

Example

exportConfig.set(
  "dashboardSubheading",
  "The best charting library in the world"
);COPY

type

Sets the format of the output file

• Type: String

Example

exportConfig.set("type", "pdf");COPY

quality

Sets the quality of the output file. Provide either good, better or best

• Type: String

Example

exportConfig.set("quality", "best");COPY

outputFile

Sets the output filename template, along with the path. You can write ejs style template for output file names. By default two functions are provided. number(start, end, interval) will resolve to a number respective to the position of the chart config in the chart config array in case of multiple file export. timestamp() will resolve to the current timestamp in unix format.

• Type: String

Example

exportConfig.set("outputFile", "path/to/export--<%= number(2) %>");COPY

outputFileDefinition

JS file defining functions or array to resolve output file names. You can write functions which will be called with the current chartConfig, index and the whole chartConfig list and will be called when resolving each filename. If it's an array then the values will be used sequentially. You have to call this functions or array in the outputFile template.

• Type: String

Example

exportConfig.set("outputFileDefinition", "resources/outputFileDefinition.js");COPY