Exporting (Vaadin Platform (vaadin-platform-javadoc) 14.3.7 API)

java.lang.Object
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
- - com.vaadin.flow.component.charts.model.Exporting

All Implemented Interfaces:: Serializable

@Generated(value="This class is generated and shouldn\'t be modified",
           comments="Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new")
public class Exporting
extends AbstractConfigurationObject

Options for the exporting module. For an overview on the matter, see the docs.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

Exporting()

Exporting(Boolean enabled)

Constructors
Constructor and Description
`Exporting()`
`Exporting(Boolean enabled)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAllowHTML()`
`Buttons`	`getButtons()`
`Boolean`	`getEnabled()`
`String`	`getError()`
`Boolean`	`getFallbackToExportServer()`
`String`	`getFilename()`
`String`	`getLibURL()`
`Map<String,ExportingMenuItemDefinition>`	`getMenuItemDefinitions()`
`Number`	`getPrintMaxWidth()`
`Number`	`getScale()`
`Number`	`getSourceHeight()`
`Number`	`getSourceWidth()`
`ExportFileType`	`getType()`
`String`	`getUrl()`
`Number`	`getWidth()`
`void`	`setAllowHTML(Boolean allowHTML)` Experimental setting to allow HTML inside the chart (added through the `useHTML` options), directly in the exported image.
`void`	`setButtons(Buttons buttons)` Options for the export related buttons, print and export.
`void`	`setEnabled(Boolean enabled)` Whether to enable the exporting module.
`void`	`setError(String _fn_error)`
`void`	`setFallbackToExportServer(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`	`setFilename(String filename)` The filename, without extension, to use for the exported chart.
`void`	`setLibURL(String libURL)` Path where Highcharts will look for export module dependencies to load on demand if they don't already exist on `window`.
`void`	`setMenuItemDefinitions(Map<String,ExportingMenuItemDefinition> menuItemDefinitions)` An object consisting of definitions for the menu items in the context menu.
`void`	`setPrintMaxWidth(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(Number scale)` Defines the scale or zoom factor for the exported image compared to the on-screen display.
`void`	`setSourceHeight(Number sourceHeight)` Analogous to sourceWidth
`void`	`setSourceWidth(Number sourceWidth)` The width of the original chart when exported, unless an explicit chart.width is set.
`void`	`setType(ExportFileType type)` Default MIME type for exporting if `chart.exportChart()` is called without specifying a `type` option.
`void`	`setUrl(String url)` The URL for the server module converting the SVG string to an image format.
`void`	`setWidth(Number width)` The pixel width of charts exported to PNG or JPG.

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

- Constructor Detail
  - Exporting
```
public Exporting()
```
  - Exporting
```
public Exporting(Boolean enabled)
```
- Method Detail
  - getAllowHTML
```
public Boolean getAllowHTML()
```
    See Also:
    
    setAllowHTML(Boolean)
  - setAllowHTML
```
public void setAllowHTML(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 to: false
  - getButtons
```
public Buttons getButtons()
```
    See Also:
    
    setButtons(Buttons)
  - setButtons
```
public void setButtons(Buttons buttons)
```
    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.
  - getEnabled
```
public Boolean getEnabled()
```
    See Also:
    
    setEnabled(Boolean)
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    Whether to enable the exporting module. Disabling the module will hide the context button, but API methods will still be available.
    Defaults to: true
  - getError
```
public String getError()
```
  - setError
```
public void setError(String _fn_error)
```
  - getFallbackToExportServer
```
public Boolean getFallbackToExportServer()
```
    See Also:
    
    setFallbackToExportServer(Boolean)
  - setFallbackToExportServer
```
public void setFallbackToExportServer(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.
    Defaults to: true
  - getFilename
```
public String getFilename()
```
    See Also:
    
    setFilename(String)
  - setFilename
```
public void setFilename(String filename)
```
    The filename, without extension, to use for the exported chart.
    Defaults to: chart
  - getLibURL
```
public String getLibURL()
```
    See Also:
    
    setLibURL(String)
  - setLibURL
```
public void setLibURL(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 library, RGBColor.js, jsPDF and svg2pdf.js, required for client side export in certain browsers.
    Defaults to: https://code.highcharts.com/{version}/lib
  - getMenuItemDefinitions
```
public Map<String,ExportingMenuItemDefinition> getMenuItemDefinitions()
```
    See Also:
    
    setMenuItemDefinitions(Map)
  - setMenuItemDefinitions
```
public void setMenuItemDefinitions(Map<String,ExportingMenuItemDefinition> 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
  - getPrintMaxWidth
```
public Number getPrintMaxWidth()
```
    See Also:
    
    setPrintMaxWidth(Number)
  - setPrintMaxWidth
```
public void setPrintMaxWidth(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 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.
    Defaults to: 780
  - getScale
```
public Number getScale()
```
    See Also:
    
    setScale(Number)
  - setScale
```
public void setScale(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 default scale of 2 makes this chart export to a 1200px PNG or JPG.
    Defaults to: 2
  - getSourceHeight
```
public Number getSourceHeight()
```
    See Also:
    
    setSourceHeight(Number)
  - setSourceHeight
```
public void setSourceHeight(Number sourceHeight)
```
    Analogous to sourceWidth
  - getSourceWidth
```
public Number getSourceWidth()
```
    See Also:
    
    setSourceWidth(Number)
  - setSourceWidth
```
public void setSourceWidth(Number sourceWidth)
```
    The width of the original chart when exported, unless an explicit chart.width is set. The width exported raster image is then multiplied by scale.
  - getType
```
public ExportFileType getType()
```
    See Also:
    
    setType(ExportFileType)
  - setType
```
public void setType(ExportFileType 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 to: image/png
  - getUrl
```
public String getUrl()
```
    See Also:
    
    setUrl(String)
  - setUrl
```
public void setUrl(String url)
```
    The URL for the server module converting the SVG string to an image format. By default this points to Highchart's free web service.
    Defaults to: https://export.highcharts.com
  - getWidth
```
public Number getWidth()
```
    See Also:
    
    setWidth(Number)
  - setWidth
```
public void setWidth(Number width)
```
    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.
    Defaults to: undefined

Class Exporting

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Exporting

Exporting

Method Detail

getAllowHTML

setAllowHTML

getButtons

setButtons

getEnabled

setEnabled

getError

setError

getFallbackToExportServer

setFallbackToExportServer

getFilename

setFilename

getLibURL

setLibURL

getMenuItemDefinitions

setMenuItemDefinitions

getPrintMaxWidth

setPrintMaxWidth

getScale

setScale

getSourceHeight

setSourceHeight

getSourceWidth

setSourceWidth

getType

setType

getUrl

setUrl

getWidth

setWidth