IExportingSettings – amCharts 5 Documentation

Type interface

Inheritance

IExportingSettings extends IEntitySettings.

IExportingSettings is not extended by any other symbol.

Properties

backgroundColor #	Type `Color` Export will try to determine background color based on the DOM styles. You can use this setting to explicitly specify background color for exported images.
canvasOptions #	Type `IExportingImageOptions` Canvas format options.
charset #	Type `undefined` \| `string` Charset to use for export. @defaul "utf-8"
csvOptions #	Type `IExportingCSVOptions` CSV format options.
dataFields #	Type `undefined` \| `object` Fields to include in data export. Key - field in data. Value - column name.
dataFieldsOrder #	Type `string[]` Specifies the order of fields to export in data.
dataSource #	Type `any` Data to export. Click here for more info
dateFields #	Type `string[]` Fields in data that have date/time value.
dateFormat #	Type `string` \| `DateTimeFormatOptions` Use this date format on date values.
durationFields #	Type `string[]` Fields in data that need to be formatted as "duration" as per `durationFormat`. @since 5.0.16
durationFormat #	Type `undefined` \| `string` Format to use when formatting values in `durationFields`. If not set, will use `durationFormat` as set in `DurationFormatter` of the root element. @since 5.0.16
durationUnit #	Type `TimeUnit` Time unit to assume duration values are in. If not set, will use `baseUnit` as set in `DurationFormatter` of the root element. @since 5.0.16
extraImages #	Type `Array` Include these images or other charts in image exports.
filePrefix #	Type `undefined` \| `string` Default `"chart"` A string to prefix exported files with.
htmlOptions #	Type `IExportingHTMLOptions` HTML format options.
id #	Type `undefined` \| `string` Inherited from `IEntitySettings` A custom string ID for the element. If set, element can be looked up via `am5.registry.entitiesById`. Will raise error if an element with the same ID already exists.
jpgOptions #	Type `IExportingImageOptions` JPEG format options.
jsonOptions #	Type `IExportingJSONOptions` JSON format options.
menu #	Type `ExportingMenu` A reference to `ExportingMenu` object.
numberFormat #	Type `string` \| `NumberFormatOptions` Use this number format on numeric values.
numericFields #	Type `string[]` Fields in data that are numeric.
pdfOptions #	Type `IExportingPDFOptions` PDF format options.
pdfdataOptions #	Type `IExportingDataOptions` PDF with data table format options.
pngOptions #	Type `IExportingImageOptions` PNG format options.
printOptions #	Type `IExportingPrintOptions` Print options.
stateAnimationDuration #	Type `undefined` \| `number` Inherited from `IEntitySettings` Duration of transition from one state to another.
stateAnimationEasing #	Type `$ease.Easing` Inherited from `IEntitySettings` Easing of transition from one state to another.
themeTags #	Type `Array` Inherited from `IEntitySettings` Tags which can be used by the theme rules. Click here for more info
themeTagsSelf #	Type `Array` Inherited from `IEntitySettings` Tags which can be used by the theme rules. These tags only apply to this object, not any children. Click here for more info
themes #	Type `Array` Inherited from `IEntitySettings` A list of themes applied to the element.
title #	Type `undefined` \| `string` Chart title. Used for print, PDF and Excel exports.
userData #	Type `any` Inherited from `IEntitySettings` A storage for any custom user data that needs to be associated with the element.
xlsxOptions #	Type `IExportingXLSXOptions` XSLX format options.
There are 7 inherited items currently hidden from this list.