HIExporting

java.lang.Object
- java.util.Observable
- - com.highsoft.highcharts.core.HIFoundation
  - - com.highsoft.highcharts.common.hichartsclasses.HIExporting

public class HIExporting
extends HIFoundation

Constructor Summary

Constructors
Constructor and Description

HIExporting()

Constructors
Constructor and Description
`HIExporting()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HIAccessibility`	`getAccessibility()`
`java.lang.Boolean`	`getAllowHTML()`
`java.lang.Boolean`	`getAllowTableSorting()`
`HIButtons`	`getButtons()`
`java.lang.String`	`getChartMenuLabel()`
`java.util.HashMap`	`getChartOptions()`
`HICsv`	`getCsv()`
`java.lang.Boolean`	`getEnabled()`
`HIFunction`	`getError()`
`java.lang.Boolean`	`getFallbackToExportServer()`
`java.lang.Object`	`getFetchOptions()`
`java.lang.String`	`getFilename()`
`java.lang.String`	`getLibURL()`
`java.lang.String`	`getMenuButtonLabel()`
`java.lang.Object`	`getMenuItemDefinitions()`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getParams()`
`HIPdfFont`	`getPdfFont()`
`java.lang.Number`	`getPrintMaxWidth()`
`java.lang.Number`	`getScale()`
`java.lang.Boolean`	`getShowExportInProgress()`
`java.lang.Boolean`	`getShowTable()`
`java.lang.Number`	`getSourceHeight()`
`java.lang.Number`	`getSourceWidth()`
`java.lang.Object`	`getTableCaption()`
`java.lang.String`	`getType()`
`java.lang.String`	`getUrl()`
`java.lang.Boolean`	`getUseMultiLevelHeaders()`
`java.lang.Boolean`	`getUseRowspanHeaders()`
`java.lang.Number`	`getWidth()`
`void`	`setAccessibility(HIAccessibility accessibility)` Accessibility options for the exporting menu.
`void`	`setAllowHTML(java.lang.Boolean allowHTML)` Experimental setting to allow HTML inside the chart (added through the `useHTML` options), directly in the exported image.
`void`	`setAllowTableSorting(java.lang.Boolean allowTableSorting)` Allows the end user to sort the data table by clicking on column headers.
`void`	`setButtons(HIButtons buttons)` Options for the export related buttons, print and export.
`void`	`setChartMenuLabel(java.lang.String chartMenuLabel)`
`void`	`setChartOptions(java.util.HashMap chartOptions)` Additional chart options to be merged into the chart before exporting to an image format.
`void`	`setCsv(HICsv csv)` Options for exporting data to CSV or ExCel, or displaying the data in a HTML table or a JavaScript structure.
`void`	`setEnabled(java.lang.Boolean enabled)` Whether to enable the exporting module.
`void`	`setError(HIFunction error)` Function to call if the offline-exporting module fails to export a chart on the client side, and `fallbackToExportServer` is disabled.
`void`	`setFallbackToExportServer(java.lang.Boolean fallbackToExportServer)` 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.
`void`	`setFetchOptions(java.lang.Object fetchOptions)` Options for the fetch request used when sending the SVG to the export server.
`void`	`setFilename(java.lang.String filename)` The filename, without extension, to use for the exported chart.
`void`	`setLibURL(java.lang.String libURL)` Path where Highcharts will look for export module dependencies to load on demand if they don't already exist on `window`.
`void`	`setMenuButtonLabel(java.lang.String menuButtonLabel)`
`void`	`setMenuItemDefinitions(java.lang.Object menuItemDefinitions)` An object consisting of definitions for the menu items in the context menu.
`void`	`setPdfFont(HIPdfFont pdfFont)` Settings for a custom font for the exported PDF, when using the `offline-exporting` module.
`void`	`setPrintMaxWidth(java.lang.Number printMaxWidth)` When printing the chart from the menu item in the burger menu, if the on-screen chart exceeds this width, it is resized.
`void`	`setScale(java.lang.Number scale)` Defines the scale or zoom factor for the exported image compared to the on-screen display.
`void`	`setShowExportInProgress(java.lang.Boolean showExportInProgress)` Display a message when export is in progress.
`void`	`setShowTable(java.lang.Boolean showTable)` Show a HTML table below the chart with the chart's current data.
`void`	`setSourceHeight(java.lang.Number sourceHeight)` Analogous to `sourceWidth`.
`void`	`setSourceWidth(java.lang.Number sourceWidth)` The width of the original chart when exported, unless an explicit `chart.width` is set, or a pixel width is set on the container.
`void`	`setTableCaption(java.lang.Object tableCaption)` Caption for the data table.
`void`	`setType(java.lang.String type)` Default MIME type for exporting if `chart.exportChart()` is called without specifying a `type` option.
`void`	`setUrl(java.lang.String url)` The URL for the server module converting the SVG string to an image format.
`void`	`setUseMultiLevelHeaders(java.lang.Boolean useMultiLevelHeaders)` Use multi level headers in data table.
`void`	`setUseRowspanHeaders(java.lang.Boolean useRowspanHeaders)` If using multi level table headers, use rowspans for headers that have only one level.
`void`	`setWidth(java.lang.Number width)` The pixel width of charts exported to PNG or JPG.

Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HIExporting
```
public HIExporting()
```
- Method Detail
  - getAccessibility
```
public HIAccessibility getAccessibility()
```
  - getAllowHTML
```
public java.lang.Boolean getAllowHTML()
```
  - getAllowTableSorting
```
public java.lang.Boolean getAllowTableSorting()
```
  - getButtons
```
public HIButtons getButtons()
```
  - getChartMenuLabel
```
public java.lang.String getChartMenuLabel()
```
  - getChartOptions
```
public java.util.HashMap getChartOptions()
```
  - getCsv
```
public HICsv getCsv()
```
  - getEnabled
```
public java.lang.Boolean getEnabled()
```
  - getError
```
public HIFunction getError()
```
  - getFallbackToExportServer
```
public java.lang.Boolean getFallbackToExportServer()
```
  - getFetchOptions
```
public java.lang.Object getFetchOptions()
```
  - getFilename
```
public java.lang.String getFilename()
```
  - getLibURL
```
public java.lang.String getLibURL()
```
  - getMenuButtonLabel
```
public java.lang.String getMenuButtonLabel()
```
  - getMenuItemDefinitions
```
public java.lang.Object getMenuItemDefinitions()
```
  - getParams
```
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
```
    Specified by:
    
    getParams in class HIFoundation
  - getPdfFont
```
public HIPdfFont getPdfFont()
```
  - getPrintMaxWidth
```
public java.lang.Number getPrintMaxWidth()
```
  - getScale
```
public java.lang.Number getScale()
```
  - getShowExportInProgress
```
public java.lang.Boolean getShowExportInProgress()
```
  - getShowTable
```
public java.lang.Boolean getShowTable()
```
  - getSourceHeight
```
public java.lang.Number getSourceHeight()
```
  - getSourceWidth
```
public java.lang.Number getSourceWidth()
```
  - getTableCaption
```
public java.lang.Object getTableCaption()
```
  - getType
```
public java.lang.String getType()
```
  - getUrl
```
public java.lang.String getUrl()
```
  - getUseMultiLevelHeaders
```
public java.lang.Boolean getUseMultiLevelHeaders()
```
  - getUseRowspanHeaders
```
public java.lang.Boolean getUseRowspanHeaders()
```
  - getWidth
```
public java.lang.Number getWidth()
```
  - setAccessibility
```
public void setAccessibility(HIAccessibility accessibility)
```
    Accessibility options for the exporting menu. Requires the Accessibility module.
  - setAllowHTML
```
public void setAllowHTML(java.lang.Boolean allowHTML)
```
    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. Disclaimer: The HTML is rendered in a `foreignObject` tag in the generated SVG. The official export server is based on PhantomJS, which supports this, but other SVG clients, like Batik, does not support it. This also applies to downloaded SVG that you want to open in a desktop client.
    
    defaults:
    
    false
  - setAllowTableSorting
```
public void setAllowTableSorting(java.lang.Boolean allowTableSorting)
```
    Allows the end user to sort the data table by clicking on column headers.
    
    defaults:
    
    True
  - setButtons
```
public void setButtons(HIButtons buttons)
```
    Options for the export related buttons, print and export. In addition to the defaults buttons listed here, custom buttons can be added. See `navigation.buttonOptions` for general options.
  - setChartMenuLabel
```
public void setChartMenuLabel(java.lang.String chartMenuLabel)
```
  - setChartOptions
```
public void setChartOptions(java.util.HashMap chartOptions)
```
    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. For example, a common use case is to add data labels to improve readability of the exported chart, or to add a printer-friendly color scheme to exported PDFs.
  - setCsv
```
public void setCsv(HICsv csv)
```
    Options for exporting data to CSV or ExCel, or displaying the data in a HTML table or a JavaScript structure. This module adds data export options to the export menu and provides functions like `Chart.getCSV`, `Chart.getTable`, `Chart.getDataRows` and `Chart.viewData`. The XLS converter is limited and only creates a HTML string that is passed for download, which works but creates a warning before opening. The workaround for this is to use a third party XLSX converter, as demonstrated in the sample below.
  - setEnabled
```
public void setEnabled(java.lang.Boolean enabled)
```
    Whether to enable the exporting module. Disabling the module will hide the context button, but API methods will still be available.
    
    defaults:
    
    true
  - setError
```
public void setError(HIFunction error)
```
    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.
  - setFallbackToExportServer
```
public void setFallbackToExportServer(java.lang.Boolean fallbackToExportServer)
```
    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.
    
    defaults:
    
    true
  - setFetchOptions
```
public void setFetchOptions(java.lang.Object fetchOptions)
```
    Options for the fetch request used when sending the SVG to the export server. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/fetch) for more information
  - setFilename
```
public void setFilename(java.lang.String filename)
```
    The filename, without extension, to use for the exported chart.
    
    defaults:
    
    chart
  - setLibURL
```
public void setLibURL(java.lang.String libURL)
```
    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](https://github.com/canvg/canvg) library, [jsPDF](https://github.com/parallax/jsPDF) and [svg2pdf.js](https://github.com/yWorks/svg2pdf.js), required for client side export in certain browsers.
  - setMenuButtonLabel
```
public void setMenuButtonLabel(java.lang.String menuButtonLabel)
```
  - setMenuItemDefinitions
```
public void setMenuItemDefinitions(java.lang.Object menuItemDefinitions)
```
    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: - **onclick:** The click handler for the menu item - **text:** The text for the menu item - **textKey:** If internationalization is required, the key to a language string Custom text for the "exitFullScreen" can be set only in lang options (it is not a separate button).
    
    defaults:
    
    {"viewFullscreen": {}, "printChart": {}, "separator": {}, "downloadPNG": {}, "downloadJPEG": {}, "downloadPDF": {}, "downloadSVG": {}}
  - setPdfFont
```
public void setPdfFont(HIPdfFont pdfFont)
```
    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. As described in the [jsPDF docs](https://github.com/parallax/jsPDF#use-of-unicode-characters--utf-8), the 14 standard fonts in PDF are limited to the ASCII-codepage. Therefore, in order to support other text in the exported PDF, one or more TTF font files have to be passed on to the exporting module. See more in [the docs](https://www.highcharts.com/docs/export-module/client-side-export).
  - setPrintMaxWidth
```
public void setPrintMaxWidth(java.lang.Number printMaxWidth)
```
    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 defaults 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.
    
    defaults:
    
    780
  - setScale
```
public void setScale(java.lang.Number scale)
```
    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 defaults scale of 2 makes this chart export to a 1200px PNG or JPG.
    
    defaults:
    
    2
  - setShowExportInProgress
```
public void setShowExportInProgress(java.lang.Boolean showExportInProgress)
```
    Display a message when export is in progress. Uses `Chart.setLoading()` The message can be altered by changing [](#lang.exporting.exportInProgress)
    
    defaults:
    
    True
  - setShowTable
```
public void setShowTable(java.lang.Boolean showTable)
```
    Show a HTML table below the chart with the chart's current data.
  - setSourceHeight
```
public void setSourceHeight(java.lang.Number sourceHeight)
```
    Analogous to `sourceWidth`.
  - setSourceWidth
```
public void setSourceWidth(java.lang.Number sourceWidth)
```
    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`.
  - setTableCaption
```
public void setTableCaption(java.lang.Object tableCaption)
```
    Caption for the data table. Same as chart title by defaults. Set to `false` to disable.
  - setType
```
public void setType(java.lang.String type)
```
    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`.
    
    defaults:
    
    image/png
  - setUrl
```
public void setUrl(java.lang.String url)
```
    The URL for the server module converting the SVG string to an image format. By defaults this points to Highchart's free web service.
    
    defaults:
    
    https://export.highcharts.com/
  - setUseMultiLevelHeaders
```
public void setUseMultiLevelHeaders(java.lang.Boolean useMultiLevelHeaders)
```
    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.
    
    defaults:
    
    True
  - setUseRowspanHeaders
```
public void setUseRowspanHeaders(java.lang.Boolean useRowspanHeaders)
```
    If using multi level table headers, use rowspans for headers that have only one level.
    
    defaults:
    
    True
  - setWidth
```
public void setWidth(java.lang.Number width)
```
    The pixel width of charts exported to PNG or JPG. As of Highcharts 3.0, the defaults pixel width is a function of the `chart.width` or `exporting.sourceWidth` and the `exporting.scale`.

Class HIExporting

Constructor Summary

Method Summary

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Constructor Detail

HIExporting

Method Detail

getAccessibility

getAllowHTML

getAllowTableSorting

getButtons

getChartMenuLabel

getChartOptions

getCsv

getEnabled

getError

getFallbackToExportServer

getFetchOptions

getFilename

getLibURL

getMenuButtonLabel

getMenuItemDefinitions

getParams

getPdfFont

getPrintMaxWidth

getScale

getShowExportInProgress

getShowTable

getSourceHeight

getSourceWidth

getTableCaption

getType

getUrl

getUseMultiLevelHeaders

getUseRowspanHeaders

getWidth

setAccessibility

setAllowHTML

setAllowTableSorting

setButtons

setChartMenuLabel

setChartOptions

setCsv

setEnabled

setError

setFallbackToExportServer

setFetchOptions

setFilename

setLibURL

setMenuButtonLabel

setMenuItemDefinitions

setPdfFont

setPrintMaxWidth

setScale

setShowExportInProgress

setShowTable

setSourceHeight

setSourceWidth

setTableCaption

setType

setUrl

setUseMultiLevelHeaders

setUseRowspanHeaders

setWidth