Package com.vaadin.componentfactory.maps.model

Class Exporting

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.Exporting
All Implemented Interfaces:
Serializable
@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") public class Exporting extends AbstractConfigurationObject
Options for the exporting module. For an overview on the matter, see the docs.
Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • Exporting

      public Exporting()

      Constructor for Exporting.

    • Exporting

      public Exporting(Boolean enabled)

      Constructor for Exporting.

      Parameters:
      enabled - a Boolean object.

  • Method Details

    • getAllowHTML

      public Boolean getAllowHTML()

      Getter for the field allowHTML.

      Returns:
      a Boolean object.
      See Also:

    • 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

      Parameters:
      allowHTML - a Boolean object.

    • getButtons

      public Buttons getButtons()

      Getter for the field buttons.

      Returns:
      a Buttons object.
      See Also:

    • 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.
      Parameters:
      buttons - a Buttons object.

    • getEnabled

      public Boolean getEnabled()

      Getter for the field enabled.

      Returns:
      a Boolean object.
      See Also:

    • 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

      Parameters:
      enabled - a Boolean object.

    • getFallbackToExportServer

      public Boolean getFallbackToExportServer()

      Getter for the field fallbackToExportServer.

      Returns:
      a Boolean object.
      See Also:

    • 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

      Parameters:
      fallbackToExportServer - a Boolean object.

    • getFilename

      public String getFilename()

      Getter for the field filename.

      Returns:
      a String object.
      See Also:

    • setFilename

      public void setFilename(String filename)
      The filename, without extension, to use for the exported chart.

      Defaults to: chart

      Parameters:
      filename - a String object.

    • getPrintMaxWidth

      public Number getPrintMaxWidth()

      Getter for the field printMaxWidth.

      Returns:
      a Number object.
      See Also:

    • 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

      Parameters:
      printMaxWidth - a Number object.

    • getScale

      public Number getScale()

      Getter for the field scale.

      Returns:
      a Number object.
      See Also:

    • 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

      Parameters:
      scale - a Number object.

    • getSourceHeight

      public Number getSourceHeight()

      Getter for the field sourceHeight.

      Returns:
      a Number object.
      See Also:

    • setSourceHeight

      public void setSourceHeight(Number sourceHeight)
      Analogous to sourceWidth
      Parameters:
      sourceHeight - a Number object.

    • getSourceWidth

      public Number getSourceWidth()

      Getter for the field sourceWidth.

      Returns:
      a Number object.
      See Also:

    • 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.
      Parameters:
      sourceWidth - a Number object.

    • getType

      public String getType()

      Getter for the field type.

      Returns:
      a String object.
      See Also:

    • setType

      public void setType(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 to: image/png

      Parameters:
      type - a String object.

    • getUrl

      public String getUrl()

      Getter for the field url.

      Returns:
      a String object.
      See Also:

    • 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: http://export.highcharts.com

      Parameters:
      url - a String object.

    • getWidth

      public Number getWidth()

      Getter for the field width.

      Returns:
      a Number object.
      See Also:

    • 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

      Parameters:
      width - a Number object.