Export

Type Adapter < Export, IExportAdapters >

Default new Adapter<Export,
IExportAdapters>(this)

Adapter.

Type $type.Optional < Color >

A background color to be used for exported images. If set, this will override the automatically acquired background color.

Type HTMLElement

A reference to a container to be used to place ExportMenu in.

Type any

Data to export.

Type any

Data fields in { field: fieldName } format. Those are used for exporting in data formats to name the columns.

Click here for examples and details

Type string[]

Default []

Holds an array of data field names. If set, exported data fields will try to maintain this order.

If not set (default), the export will try to maintain the same order as in source data, or as in dataFields (if set).

@since 4.9.7

Type List < string >

A list of fields that hold date values.

Type $type.Optional < string | DateTimeFormatOptions >

A date format to use for exporting dates. Will use DateFormatter format if not set.

Type DateFormatter

A DateFormatter to use when formatting dates when exporting data.

Type List < string >

A list of fields that hold duration values.

Type $type.Optional < string >

A format to use when formatting values from durationFields.

Will use DurationFormatter format if not set.

Type DurationFormatter

A DurationFormatter to use when formatting duration values when exporting data.

Type Array < Sprite | IExportCanvas >

An array of extra Sprite elements to include in export.

It can be used to export any external elements, or even other charts.

E.g.:

chart.exporting.extraSprites.push(chart2);

chart.exporting.extraSprites.push(chart2);

IMPORTANT: This setting is ignored when exporting to SVG format.

@since 4.2.0

Type string

A file prefix to be used for all exported formats.

Export will apply format-related extension to it. E.g. if this is set to "myExport", the file name of the PNG exported image will be "myExport.png".

Type Dictionary < string, ExportOptions >

A Dictionary object containing format-specific options.

May be used to change specific option for the format:

chart.exporting.formatOptions.getKey("csv").disabled = true;

chart.exporting.formatOptions.getKey("csv").disabled = true;

{
  // ...
  "exporting": {
    // ...
    "formatOptions": {
      "csv": {
        "disabled": true
      }
    }
  }
}

@since 4.9.12

Type Language

A Language instance to be used for translations.

Type $type.Optional < ExportMenu >

An instance of ExportMenu.

To add an export menu to a chart, set this to a new instance of ExportMenu.

chart.exporting.menu = new am4core.ExportMenu();

chart.exporting.menu = new am4core.ExportMenu();

{
  // ...
  "exporting": {
    "menu": {}
  }
}

Type List < string >

A list of fields that hold number values.

@since 4.5.15

Type $type.Optional < string >

A number format to use for exporting dates. Will use NumberFormatter format if not set.

@since 4.5.15

Type NumberFormatter

A NumberFormatter to use when formatting dates when exporting data.

@since 4.5.15

Type Preloader

Returns a an instance of Preloader associated with the Sprite being exported.

Type Sprite

A reference to Sprite to export. Can be any Sprite, including some internal elements.

Type number

Default 2000

If export operation takes longer than milliseconds in this second, we will show a modal saying export operation took longer than expected.

Type $type.Optional < string >

A title to be used when printing.

Type boolean

Default true


Many modern displays have use more actual pixels per displayed pixel. This results in sharper images on screen. Unfortunately, when exported to a bitmap image of the sam width/height size it will lose those extra pixels, resulting in somewhat blurry image.

This is why we are going to export images larger than they are, so that we don't lose any details.

If you'd rather export images without change in size, set this to false.

Type boolean

Default true

By default Export will try to use built-in method for transforming chart into an image for download, then fallback to external library (canvg) for conversion if failed.

Setting this to false will force use of external library for all export operations.

It might be useful to turn off simplified export if you are using strict content security policies, that disallow images with blobs as their source.

@since 4.2.5

Type boolean

Default true


If you are using web fonts (such as Google Fonts), your chart might be using them as well.

Normally, exporting to image will require to download these fonts so the are carried over to exported image.

This setting can be used to disable or enable this functionality.

Type Array < Sprite >

An array of Sprite elements that need to be valid before export commences.

If any of those elements is not completely ready when export is triggered, the export will wait until they are (their validated event triggers) before going through with the export opertaion.

This is useful if you need to modify chart appearance for the export.

E.g.:

// Add watermark
let watermark = chart.createChild(am4core.Label);
watermark.text = "Copyright (C) 2019";
watermark.disabled = true;

// Add watermark to validated sprites
chart.exporting.validateSprites.push(watermark);

// Enable watermark on export
chart.exporting.events.on("exportstarted", function(ev) {
  watermark.disabled = false;
});

// Disable watermark when export finishes
chart.exporting.events.on("exportfinished", function(ev) {
  watermark.disabled = true;
});

// Add watermark
var watermark = chart.createChild(am4core.Label);
watermark.text = "Copyright (C) 2019";
watermark.disabled = true;

// Add watermark to validated sprites
chart.exporting.validateSprites.push(watermark);

// Enable watermark on export
chart.exporting.events.on("exportstarted", function(ev) {
  watermark.disabled = false;
});

// Disable watermark when export finishes
chart.exporting.events.on("exportfinished", function(ev) {
  watermark.disabled = true;
});

@since 4.6.8

Type RegExp

A regular expression that will be matched against each URL of an external font being loaded. Font will only be loaded of regular expression matches.

Has no effect of useWebFonts is set to false.

chart.exporting.webFontFilter = /pacifico|roboto/;

chart.exporting.webFontFilter = /pacifico|roboto/;

{
  // ...
  "exporting": {
    // ...
    "webFontFilter": /pacifico|roboto/
  }
}

@since 4.10.17

Returns Export

Constructor

Returns Promise < boolean >

Triggers download of the file.

This is an asynchronous function. Check the description of getImage() for description and example usage.

@async

Returns boolean

Returns true if browser has any supported methods to trigger download of a binary file.

Returns Promise < boolean >

Initiates export procedure.

@async

Returns Promise < string >

Returns chart's data formatted as CSV.

This is an asynchronous function. Check the description of getImage() for description and example usage.

@async

Returns Promise < HTMLCanvasElement >

Returns canvas representation of the Sprite.

Returns Promise < HTMLCanvasElement >

Returns canvas representation of the Sprite using canvg.

Returns string

Returns proper content type for the export type.

Returns Promise < string >

Returns an Excel file of chart's data.

This is an asynchronous function. Check the description of getImage() for description and example usage.

@async
@todo Handle dates
@todo Support for multi-sheet

Returns IExportOptions[""]

Returns current options for a format.

Returns Promise < string >

Returns chart's data formatted as HTML table.

This is an asynchronous function. Check the description of getImage() for description and example usage.

@since 4.7.0
@async

Returns Promise < string >

Produces image output from the element.

Converts to a Canvas first, then produces an image to download.

This is an asynchronous function. Rather than returning a result, it returns a Promise.

You can use await notion from other async functions, or then() anywhere else.

let img;

// Async
img = await chart.exporting.getImage( "png" );

// Sync
chart.exporting.getImage( "png" ).then( ( data ) => {
  img = data;
} );

var img;
chart.exporting.getImage( "png" ).then( ( data ) => {
  img = data;
} );

Returns Promise < string >

Tries to dynamically load canvg.js and export an image using its functions.

This is an asynchronous function. Check the description of getImage() for description and example usage.

Returns Promise < string >

Returns chart's data in JSON format.

This is an asynchronous function. Check the description of getImage() for description and example usage.

@async

Returns Promise < string >

Returns a PDF containing chart image.

This is an asynchronous function. Check the description of getImage() for description and example usage.

@async
@todo Account for header when calculating vertical fit

Returns Promise < any >

Returns chart's data formatted suitable for PDF export (pdfmake).

This is an asynchronous function. Check the description of getImage() for description and example usage.

@since 4.7.0
@async

Returns Promise < string >

Requests a Print of the chart.

@async

Returns Promise < string >

Returns an SVG representation of the chart.

This is an asynchronous function. Check the description of getImage() for description and example usage.

Returns Promise < boolean >

Initiates print of the chart.

This is an asynchronous function. Check the description of getImage() for description and example usage.

@async

Returns void

Sets options for a format.

Returns boolean

Checks if this specific menu item type is supported by current system.

Param { type: "error",
  target: this }

Invoked when export operation encounters error.

Param { type: "exportfinished",
  target: this }

Invoked when export operation finishes.

Param { type: "exportstarted",
  target: this }

Invoked when the Export starts export procedure.

You can use event handlers here to modify config before actual export starts.

Param { type: "exporttimedout",
  target: this }

Invoked when export operation times out.

Use Export's timeoutDelay setting to set timeout. (default: 2000ms)

Param { type: "inited",
  target: this }

Invoked when Export initializes.

Param { type: "menucreated",
  target: this }

Invoked when Export menu is created.

Param { backgroundColor: $type.Optional < Color > }

Param { charset: string,
  options: IExportOptions[""],
  type: Keys }

Param { container: HTMLElement }

Param { contentType: string,
  type: Keys }

Param { data: Array < any > }

Param { field: string,
  name: string }

Param { dataFields: any }

Param { dataFieldsOrder: string[],
  format: string }

Param { dateFields: any }

Param { dateFormat: $type.Optional < string | DateTimeFormatOptions > }

Param { dateFormatter: DateFormatter }

Param { durationFields: any }

Param { durationFormat: $type.Optional < string > }

Param { durationFormatter: DurationFormatter }

Param { func: ( type: Key, options: IExportOptions[""]) => Promise < any > ,
  options: IExportOptions[""],
  type: Keys }

Param { extraSprites: Array < Sprite | IExportCanvas > }

Param { filePrefix: string }

Param { dataFields: any,
  format: string }

Param { data: string,
  options: IExportOptions[""] }

Param { data: string,
  options: IExportOptions[""] }

Param { data: string,
  options: IExportOptions[""] }

Param { data: string,
  options: IExportOptions[""] }

Param { data: string,
  options: IExportOptions[""] }

Param { field: string,
  isDateField: boolean }

Param { field: string,
  isDurationField: boolean }

Param { field: string,
  isNumberField: boolean }

Param { data: string,
  options: IExportOptions[""] }

Param { numberFields: any }

Param { numberFormat: $type.Optional < string > }

Param { numberFormatter: NumberFormatter }

Param { options: IExportOptions[""],
  type: Keys }

Param { doc: any,
  options: IExportOptions[""] }

Param { options: IExportOptions[""],
  table: any }

Param { sprite: Sprite }

Param { options: IExportOptions[""],
  supported: boolean,
  type: Keys }

Param { data: string,
  options: IExportOptions[""] }

Param { message: string }

Param { options: IExportOptions[""],
  title: $type.Optional < string > }

Param { validateSprites: Array < Sprite > }

Param { name: string,
  xlsx: any }

Param { options: IExportOptions[""],
  workbook: any,
  xlsx: any }

@since 4.9.28

Param { options: any,
  xlsx: any }