IExportingSettings

Type interface

Sources

IExportingSettings is an interface: it describes a shape of data and is not imported on its own.

Inheritance

IExportingSettings extends IEntitySettings.

IExportingSettings is not extended by any other symbol.

Properties

#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 | numberDefault 1Since 5.2.34

Opacity of the exported image's background: 0 (transparent) to 1 (opaque). JPEG has no transparency.

#canvasOptions

Type IExportingImageOptions

Options for exportCanvas().

#charset

Type undefined | stringDefault "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.

More info: Exporting: exporting data

#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[]Since 5.0.16

Fields whose numbers are durations, formatted with durationFormat.

#durationFormat

Type undefined | stringSince 5.0.16

Format for the values in durationFields. If not set, the root's DurationFormatter format is used.

#durationUnit

Type TimeUnitSince 5.0.16

Time unit the values in durationFields are in. If not set, the root's DurationFormatter baseUnit is used.

#extraImages

Type Array

Other charts to add around the main chart in image exports.

#filePrefix

Type undefined | stringDefault "chart"

Name of downloaded files, before the extension.

#htmlOptions

Type IExportingHTMLOptions

HTML format options.

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

#pdfdataOptions

Type IExportingDataOptions

Options for the PDF with a data table.

#pdfOptions

Type IExportingPDFOptions

PDF format options.

#pngOptions

Type IExportingImageOptions

PNG format options.

#printOptions

Type IExportingPrintOptions

Print options.

#svgOptions

Type IExportingSVGOptionsSince 5.21.0

SVG format options.

#title

Type undefined | string

Title of the export: the heading of a PDF, the page title when printing and the sheet name in XLSX.

#xlsxOptions

Type IExportingXLSXOptions

XLSX format options.

9 inherited items

#animations

Type ArrayInherited from IEntitySettingsSince 5.20.8

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

#id

Type undefined | stringInherited 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 | trueDefault falseInherited from IEntitySettingsSince 5.15.6

Ignores themes: no theme rule applies to the element, not even one of the default theme.

#stateAnimationDuration

Type undefined | numberDefault 0Inherited from IEntitySettings

How long, in milliseconds, a switch from one state to another animates.

0 switches at once.

#stateAnimationEasing

Type $ease.EasingDefault out(cubic)Inherited from IEntitySettings

Easing of the animated switch from one state to another.

#themes

Type ArrayInherited from IEntitySettings

Themes applied to the element and everything inside it.

#themeTags

Type ArrayInherited 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.

More info: Themes

#themeTagsSelf

Type ArrayInherited from IEntitySettings

Tags that theme rules can target, like themeTags, but only for this element, not its children.

More info: Themes

#userData

Type anyInherited from IEntitySettings

Any data of your own to keep with the element.