IExportingSettings – amCharts 5 Documentation

Type interface

Inheritance

IExportingSettings extends IEntitySettings.

IExportingSettings is not extended by any other symbol.

Properties

animations #	Type `Array` Inherited from `IEntitySettings` Animations the element plays on its own, described as data - so they can be set from a JSON config and saved with it. Each one animates a setting of the element (or, with `target: "dataItem"`, a value of its data item - a map point's `positionOnLine`, say). They start when the setting is applied, restart when it changes, and stop when the element is disposed. A saved config keeps what was configured, never a value caught half way through an animation. sprite.set("animations", [ { key: "rotation", to: 360, duration: 4000, loops: 0 }, { key: "scale", from: 1, to: 1.3, duration: 800, loops: 0, yoyo: true, easing: "sine" } ]); @since 5.20.8
backgroundColor #	Type `Color` Background color of exported images. If not set, it is taken from the CSS background of the chart's element, or the nearest parent that has one; white if none does.
backgroundOpacity #	Type `undefined` \| `number` Default `1` Opacity of the exported image's background: `0` (transparent) to `1` (opaque). JPEG has no transparency. @since 5.2.34
canvasOptions #	Type `IExportingImageOptions` Options for `exportCanvas()`.
charset #	Type `undefined` \| `string` Default `"utf-8"` Charset of exported files.
csvOptions #	Type `IExportingCSVOptions` CSV format options.
dataFields #	Type `undefined` \| `object` Fields to include in data exports, and their column names: keys are fields in the data, values the column names.
dataFieldsOrder #	Type `string[]` Order of the fields in data exports.
dataSource #	Type `any` Data for data exports: an array of objects. Without it, the data formats are not offered. Click here for more info
dateFields #	Type `string[]` Fields whose numbers are timestamps, exported as dates.
dateFormat #	Type `string` \| `DateTimeFormatOptions` Date format for dates in data exports. If not set, the root's `DateFormatter` format is used.
durationFields #	Type `string[]` Fields whose numbers are durations, formatted with `durationFormat`. @since 5.0.16
durationFormat #	Type `undefined` \| `string` Format for the values in `durationFields`. If not set, the root's `DurationFormatter` format is used. @since 5.0.16
durationUnit #	Type `TimeUnit` Time unit the values in `durationFields` are in. If not set, the root's `DurationFormatter` `baseUnit` is used. @since 5.0.16
extraImages #	Type `Array` Other charts to add around the main chart in image exports.
filePrefix #	Type `undefined` \| `string` Default `"chart"` Name of downloaded files, before the extension.
htmlOptions #	Type `IExportingHTMLOptions` HTML format options.
id #	Type `undefined` \| `string` Inherited from `IEntitySettings` A unique ID for looking the element up in `root.entitiesById`. Setting an ID that another element already has throws an error.
ignoreThemes #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IEntitySettings` Ignores themes: no theme rule applies to the element, not even one of the default theme. @since 5.15.6
jpgOptions #	Type `IExportingImageOptions` JPEG format options.
jsonOptions #	Type `IExportingJSONOptions` JSON format options.
menu #	Type `ExportingMenu` The `ExportingMenu` that offers the formats to the user.
numberFormat #	Type `string` \| `NumberFormatOptions` Number format for the values in `numericFields`. If not set, they are exported as they are.
numericFields #	Type `string[]` Fields whose numbers are formatted with `numberFormat`.
pdfOptions #	Type `IExportingPDFOptions` PDF format options.
pdfdataOptions #	Type `IExportingDataOptions` Options for the PDF with a data table.
pngOptions #	Type `IExportingImageOptions` PNG format options.
printOptions #	Type `IExportingPrintOptions` Print options.
stateAnimationDuration #	Type `undefined` \| `number` Default `0` Inherited from `IEntitySettings` How long, in milliseconds, a switch from one state to another animates. `0` switches at once.
stateAnimationEasing #	Type `$ease.Easing` Default `out(cubic)` Inherited from `IEntitySettings` Easing of the animated switch from one state to another.
svgOptions #	Type `IExportingSVGOptions` SVG format options. @since 5.21.0
themeTags #	Type `Array` Inherited from `IEntitySettings` Tags that theme rules can target. They also count for the element's children, so a rule can match a child by a tag of its parent. Click here for more info
themeTagsSelf #	Type `Array` Inherited from `IEntitySettings` Tags that theme rules can target, like `themeTags`, but only for this element, not its children. Click here for more info
themes #	Type `Array` Inherited from `IEntitySettings` Themes applied to the element and everything inside it.
title #	Type `undefined` \| `string` Title of the export: the heading of a PDF, the page title when printing and the sheet name in XLSX.
userData #	Type `any` Inherited from `IEntitySettings` Any data of your own to keep with the element.
xlsxOptions #	Type `IExportingXLSXOptions` XLSX format options.
There are 9 inherited items currently hidden from this list.