PHP

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($host, $port)`

The Constructor of ExportManager take parameters that may contains host and port values. These values will be used when connecting to FusionExport Server.

Parameters

Name	Type	Default Value	Description
host	String	127.0.0.1	The host which will be used when connecting to FusionExport server
port	Integer	1337	The port which will be used when connecting to FusionExport server

Example

new ExportManager("api.fusionexport.com", 1337);

Method: `export($exportConfig[, $outputDir, $unzip])`

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 exporter object which can resolves to the array of filenames of the exported files.

Parameters

Name	Type	Default Value	Required	Description
exportConfig	ExportConfig		Yes	Instance of the ExportConfig which will include all export configurations
outputDir	String	.	No	Directory where you want to save the exported file. By default the file will be saved in the same directory from where the script is executed. This field is optional.
unzip	Boolean	false	No	This parameter allows you to decompress your output bundle into separate files. To allow this behaviour pass true. This field is optional.

Returns

Exporter: It returns exporter object.

Example

$exportManager.export(exportConfig, ".", true);

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

Name	Type	Required	Description
exportConfig	ExportConfig	yes	Instance of the ExportConfig which will include all export configurations

Returns

Object: It returns exporter object.

Example

$files = $exportManager->exportAsStream($exportConfig);

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();

Method: `set($name, $value)`

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

Name	Type	Default Value	Required	Description
name	String	null	Yes	Name of the config
value	String, Integer or Boolean	null	Yes	Value of the config

Returns

ExportConfig: The instance of the exportConfig for method chaining.

Example

exportConfig.set("chartConfig", "resources/single.json");

Method: `get($name)`

Takes one argument as the key and returns the value.

Parameters

Name	Type	Default Value	Required	Description
name	String	null	Yes	Name of the config

Returns

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

Example

exportConfig.get("chartConfig");

Method: `has($name)`

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

Parameters

Name	Type	Default Value	Required	Description
key	String	null	Yes	Name of the config

Returns

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

Example

exportConfig.has("chartConfig");

Method: `remove($name)`

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

Parameters

Name	Type	Default Value	Required	Description
name	String	null	Yes	Name of the config

Returns

ExportConfig: The instance of the exportConfig for method chaining.

Example

exportConfig.remove("chartConfig");

Method: `clear()`

Clears all the values that were set earlier.

Returns

void

Example

exportConfig.clear();

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");

`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");

`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>");

`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");

`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");

`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");

`templateFilePath`

Sets the path of the HTML template used for dashboard export

Type: String

Example

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

`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");

The resource.json looks like as shown below:

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

`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");

`asyncCapture`

Sets if the export process will wait for CAPTURE_EXIT event

Type: Boolean

Example

exportConfig.set("asyncCapture", true);

`maxWaitForCaptureExit`

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

Type: Integer

Example

exportConfig.set("maxWaitForCaptureExit", 8000);

`type`

Sets the format of the output file

Type: String

Example

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

`quality`

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

Type: String

Example

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

`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) %>");

`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");

Products

Developer

PHP

Class: ExportManager

Constructor: `new ExportManager($host, $port)`

Method: `export($exportConfig[, $outputDir, $unzip])`

Method: `exportAsStream(ExportConfig exportConfig)`

Class: ExportConfig

Constructor: `new ExportConfig()`

Method: `set($name, $value)`

Method: `get($name)`

Method: `has($name)`

Method: `remove($name)`

Method: `clear()`

ExportConfig Options

`chartConfig`

`inputSVG`

`template`

`templateWidth`

`templateHeight`

`templateFormat`

`templateFilePath`

`resourceFilePath`

`callbackFilePath`

`asyncCapture`

`maxWaitForCaptureExit`

`type`

`quality`

`outputFile`

`outputFileDefinition`

Explore

Integrations

Developers

Pricing

Resources

Company

PHP

Class: ExportManager

Constructor: new ExportManager($host, $port)

Method: export($exportConfig[, $outputDir, $unzip])

Method: exportAsStream(ExportConfig exportConfig)

Class: ExportConfig

Constructor: new ExportConfig()

Method: set($name, $value)

Method: get($name)

Method: has($name)

Method: remove($name)

Method: clear()

ExportConfig Options

chartConfig

inputSVG

template

templateWidth

templateHeight

templateFormat

templateFilePath

resourceFilePath

callbackFilePath

asyncCapture

maxWaitForCaptureExit

type

quality

outputFile

outputFileDefinition

Constructor: `new ExportManager($host, $port)`

Method: `export($exportConfig[, $outputDir, $unzip])`

Method: `exportAsStream(ExportConfig exportConfig)`

Constructor: `new ExportConfig()`

Method: `set($name, $value)`

Method: `get($name)`

Method: `has($name)`

Method: `remove($name)`

Method: `clear()`

`chartConfig`

`inputSVG`

`template`

`templateWidth`

`templateHeight`

`templateFormat`

`templateFilePath`

`resourceFilePath`

`callbackFilePath`

`asyncCapture`

`maxWaitForCaptureExit`

`type`

`quality`

`outputFile`

`outputFileDefinition`