Skip to content

IExportImageOptions

Type interface

Represents options for image export.

Sources

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

Inheritance

IExportImageOptions does not extend any other symbol.

IExportImageOptions is extended by IExportPDFOptions, IExportPrintOptions.

Properties

disabled

Type booleanSince 4.9.11

Set this option to disabled for a format to not show up in ExportMenu.

keepTainted

Type booleanDefault false

Normally, Export removes "tainted" images (images that are loaded from other host than the chart itself) before export.

Set this to true to disable it.

Please note that removal of tainted images might trigger cross-origin security restrictions in browser and prevent the whole export operation, so use with caution.

maxHeight

Type numberSince 4.9.24

Maximum height in pixels of the exported image. If source chart is bigger thank this, it will be scaled down.

NOTE: this setting might be overidden by minHeight.

maxWidth

Type numberSince 4.9.24

Maximum width in pixels of the exported image. If source chart is bigger thank this, it will be scaled down.

NOTE: this setting might be overidden by minWidth.

minHeight

Type numberSince 4.9.24

Minimum height in pixels of the exported image. If source chart is smaller thank this, it will be scaled up.

minWidth

Type numberSince 4.9.24

Minimum width in pixels of the exported image. If source chart is smaller thank this, it will be scaled up.

quality

Type number

Quality of the exported image. (0-1)

scale

Type numberDefault 1

Rescale image.

Number less than 1 will shrink the image.

Number bigger than 1 will scale up the image.