Class/Object

com.highcharts.config

Exporting

Related Docs: object Exporting | package config

Permalink

class Exporting extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: exporting

Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Exporting
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Exporting()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val allowHTML: UndefOr[Boolean]

    Permalink

    Experimental setting to allow HTML inside the chart (added through the useHTML options), directly in the exported image.

    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.

    Since

    4.1.8

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val buttons: UndefOr[CleanJsObject[ExportingButtons]]

    Permalink

    Options for the export related buttons, print and export.

    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.

  7. val chartOptions: UndefOr[Object]

    Permalink

    Additional chart options to be merged into an exported chart.

    Additional chart options to be merged into an exported chart. For example, a common use case is to add data labels to improve readaility of the exported chart, or to add a printer-friendly color scheme.

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val enabled: UndefOr[Boolean]

    Permalink

    Whether to enable the exporting module.

    Whether to enable the exporting module. Disabling the module will hide the context button, but API methods will still be available.

    Since

    2.0

  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  12. val error: UndefOr[Function]

    Permalink

    Function to call if the offline-exporting module fails to export a chart on the client side, and fallbackToExportServer is disabled.

    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.

    Since

    5.0.0

  13. val fallbackToExportServer: UndefOr[Boolean]

    Permalink

    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.

    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.

    Since

    4.1.8

  14. val filename: UndefOr[String]

    Permalink

    The filename, without extension, to use for the exported chart.

    The filename, without extension, to use for the exported chart.

    Since

    2.0

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. val formAttributes: UndefOr[Object]

    Permalink

    An object containing additional attributes for the POST form that sends the SVG to the export server.

    An object containing additional attributes 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.

    Since

    3.0.8

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  22. val libURL: UndefOr[String]

    Permalink

    Path where Highcharts will look for export module dependencies to load on demand if they don't already exist on window.

    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.

    Since

    5.0.0

  23. val menuItemDefinitions: UndefOr[Object]

    Permalink

    An object consisting of definitions for the menu items in the context menu.

    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: <dl> <dt>onclick</dt>

    The click handler for the menu item
    <dt>text</dt>
    The text for the menu item
    textKey
    If internationalization is required, the key to a language string

    Since

    5.0.13

  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. val printMaxWidth: UndefOr[Double]

    Permalink

    When printing the chart from the menu item in the burger menu, if the on-screen chart exceeds this width, it is resized.

    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.

    Since

    4.2.5

  28. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  29. val scale: UndefOr[Double]

    Permalink

    Defines the scale or zoom factor for the exported image compared to the on-screen display.

    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.

    Since

    3.0

  30. val sourceHeight: UndefOr[Double]

    Permalink

    Analogous to sourceWidth

    Analogous to sourceWidth

    Since

    3.0

  31. val sourceWidth: UndefOr[Double]

    Permalink

    The width of the original chart when exported, unless an explicit chart.width is set.

    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.

    Since

    3.0

  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  33. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  34. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  35. val type: UndefOr[String]

    Permalink

    Default MIME type for exporting if chart.exportChart() is called without specifying a type option.

    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.

    Since

    2.0

  36. val url: UndefOr[String]

    Permalink

    The URL for the server module converting the SVG string to an image format.

    The URL for the server module converting the SVG string to an image format. By default this points to Highchart's free web service.

    Since

    2.0

  37. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  38. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. val width: UndefOr[Double]

    Permalink

    The pixel width of charts exported to PNG or JPG.

    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.

    Since

    2.0

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped