HighchartsExportingOptions class

Options for the exporting module. For an overview on the matter, see the docs and read our Fair Usage Policy.

API Docs: https://api.highcharts.com/highcharts/exporting

Inheritance

Constructors

HighchartsExportingOptions.new({HighchartsExportingAccessibilityOptions? accessibility, bool? allowHTML, bool? allowTableSorting, bool? applyStyleSheets, Map<String, HighchartsExportingButtonsOptions>? buttons, dynamic chartOptions, HighchartsExportingCsvOptions? csv, bool? enabled, dynamic error, bool? fallbackToExportServer, dynamic fetchOptions, String? filename, dynamic formAttributes, String? libURL, Map<String, Map<String, dynamic>>? menuItemDefinitions, HighchartsExportingPdfFontOptions? pdfFont, double? printMaxWidth, double? scale, bool? showExportInProgress, bool? showTable, double? sourceHeight, double? sourceWidth, String? tableCaption, String? type, dynamic url, bool? useMultiLevelHeaders, bool? useRowspanHeaders, double? width})
Options for the exporting module. For an overview on the matter, see the docs and read our Fair Usage Policy.

Properties

accessibility ↔ HighchartsExportingAccessibilityOptions?
Accessibility options for the exporting menu. Requires the Accessibility module.
getter/setter pair
allowHTML ↔ bool?
Experimental setting to allow HTML inside the chart (added through the useHTML options), directly in the exported image. This allows you to preserve complicated HTML structures like tables or bi-directional text in exported charts.
getter/setter pair
allowTableSorting ↔ bool?
Allows the end user to sort the data table by clicking on column headers.
getter/setter pair
applyStyleSheets ↔ bool?
Allow exporting a chart retaining any user-applied CSS.
getter/setter pair
buttons ↔ Map<String, HighchartsExportingButtonsOptions>?
Options for the export related buttons, print and export. In addition to the default buttons listed here, custom buttons can be added. See navigation.buttonOptions for general options.
getter/setter pair
chartOptions ↔ dynamic
Additional chart options to be merged into the chart before exporting to an image format. This does not apply to printing the chart via the export menu.
getter/setter pair
csv ↔ HighchartsExportingCsvOptions?
Options for exporting data to CSV or ExCel, or displaying the data in a HTML table or a JavaScript structure.
getter/setter pair
enabled ↔ bool?
Whether to enable the exporting module. Disabling the module will hide the context button, but API methods will still be available.
getter/setter pair
error ↔ dynamic
Function to call if the offline-exporting module fails to export a chart on the client side, and fallbackToExportServer is disabled. If left undefined, an exception is thrown instead. Receives two parameters, the exporting options, and the error from the module.
getter/setter pair
fallbackToExportServer ↔ bool?
Whether or not to fall back to the export server if the offline-exporting module is unable to export the chart on the client side. This happens for certain browsers, and certain features (e.g. allowHTML), depending on the image type exporting to. For very complex charts, it is possible that export can fail in browsers that don't support Blob objects, due to data URL length limits. It is recommended to define the exporting.error handler if disabling fallback, in order to notify users in case export fails.
getter/setter pair
fetchOptions ↔ dynamic
Options for the fetch request used when sending the SVG to the export server.
getter/setter pair
filename ↔ String?
The filename, without extension, to use for the exported chart.
getter/setter pair
formAttributes ↔ dynamic
Highcharts v11.2.0 and older. An object containing additional key value data for the POST form that sends the SVG to the export server. For example, a target can be set to make sure the generated image is received in another frame, or a custom enctype or encoding can be set.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
libURL ↔ String?
Path where Highcharts will look for export module dependencies to load on demand if they don't already exist on window. Should currently point to location of CanVG library, jsPDF and svg2pdf.js, required for client side export in certain browsers.
getter/setter pair
An object consisting of definitions for the menu items in the context menu. Each key value pair has a key that is referenced in the menuItems setting, and a value, which is an object with the following properties:
getter/setter pair
pdfFont ↔ HighchartsExportingPdfFontOptions?
Settings for a custom font for the exported PDF, when using the offline-exporting module. This is used for languages containing non-ASCII characters, like Chinese, Russian, Japanese etc.
getter/setter pair
printMaxWidth ↔ double?
When printing the chart from the menu item in the burger menu, if the on-screen chart exceeds this width, it is resized. After printing or cancelled, it is restored. The default width makes the chart fit into typical paper format. Note that this does not affect the chart when printing the web page as a whole.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scale ↔ double?
Defines the scale or zoom factor for the exported image compared to the on-screen display. While for instance a 600px wide chart may look good on a website, it will look bad in print. The default scale of 2 makes this chart export to a 1200px PNG or JPG.
getter/setter pair
showExportInProgress ↔ bool?
Display a message when export is in progress. Uses Chart.setLoading()
getter/setter pair
showTable ↔ bool?
Show a HTML table below the chart with the chart's current data.
getter/setter pair
sourceHeight ↔ double?
Analogous to sourceWidth.
getter/setter pair
sourceWidth ↔ double?
The width of the original chart when exported, unless an explicit chart.width is set, or a pixel width is set on the container. The width exported raster image is then multiplied by scale.
getter/setter pair
tableCaption ↔ String?
Caption for the data table. Same as chart title by default. Set to false to disable.
getter/setter pair
type ↔ String?
Default MIME type for exporting if chart.exportChart() is called without specifying a type option. Possible values are image/png, image/jpeg, application/pdf and image/svg+xml.
getter/setter pair
url ↔ dynamic
The URL for the server module converting the SVG string to an image format. By default this points to Highchart's free web service.
getter/setter pair
useMultiLevelHeaders ↔ bool?
Use multi level headers in data table. If csv.columnHeaderFormatter is defined, it has to return objects in order for multi level headers to work.
getter/setter pair
useRowspanHeaders ↔ bool?
If using multi level table headers, use rowspans for headers that have only one level.
getter/setter pair
width ↔ double?
The pixel width of charts exported to PNG or JPG. As of Highcharts 3.0, the default pixel width is a function of the chart.width or exporting.sourceWidth and the exporting.scale.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJSON() → String
Serializes the settings to a JSON string.
inherited
toOptionsJSON(StringBuffer buffer) → void
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited