Python

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: ExportManager(host, port)**

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

Parameters

Example

em = ExportManager("api.fusionexport.com", 1337)COPY

Method: export(export_config, output_dir='.', unzip=False)

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 an array of string which contains filenames of the exported files.

Parameters

Returns

• Array: It returns an array of strings which contains the array of filenames of the exported files.

Example

export_manager.export(export_config, ".", true)COPY

Class: ExportConfig

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

Constructor: new ExportConfig()

This constructor does not take any argument.

Example

export_config = ExportConfig()COPY

Method: set(config_name, config_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

Returns

• None

Example

export_config.set('chartConfig', 'config.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

export_config.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 whether the key is set or not.

Example

export_config.has('chartConfig')COPY

Method: remove()

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

Parameters

Returns

• Boolean: depending on whether the config_name is removed or not.

Example

export_config.remove('chartConfig')COPY

Method: clear()

Clears all the values that were set earlier.

Returns

• None

Example

export_config.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

export_config.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

export_config.set('inputSVG', 'resources/vector.svg')COPY

templateFilePath

Sets the path of the HTML template used for dashboard export

• Type: String

Example

export_config.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

export_config.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

export_config.set('callbackFilePath', 'resources/callback.js')COPY

asyncCapture

Sets if the export process will wait for CAPTURE_EXIT event

• Type: Boolean

Example

export_config.set('asyncCapture', True)COPY

maxWaitForCaptureExit

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

• Type: Integer

Example

export_config.set('maxWaitForCaptureExit', 8000)COPY

dashboardLogo

Sets the path to the logo file

• Type: String

Example

export_config.set('dashboardLogo', 'resources/logo.jpg')COPY

dashboardHeading

Sets the title of the dashboard

• Type: String

Example

export_config.set('dashboardHeading', 'FusionCharts');COPY

dashboardSubheading

Sets the sub-title of the dashboard

• Type: String

Example

export_config.set('dashboardSubheading', 'The best charting library in the world')COPY

type

Sets the format of the output file

• Type: String

Example

export_config.set('type', 'pdf')COPY

quality

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

• Type: String

Example

export_config.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

export_config.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

export_config.set('outputFileDefinition', 'resources/outputFileDefinition.js')COPY