Documentation

IExportImageOptions

Type interface

Represents options for image export.

Inheritance

IExportImageOptions does not extend any other symbol.

IExportImageOptions is extended by IExportPDFOptions, IExportPrintOptions.

Properties

disabled
#

Type boolean

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

@since 4.9.11

keepTainted
#

Type boolean

Default 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 number

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.

@since 4.9.24

maxWidth
#

Type number

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.

@since 4.9.24

minHeight
#

Type number

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

@since 4.9.24

minWidth
#

Type number

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

@since 4.9.24

quality
#

Type number

Quality of the exported image. (0-1)
scale
#

Type number

Default 1

Rescale image.

Number less than 1 will shrink the image.

Number bigger than 1 will scale up the image.