Exporting

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. val allowHTML: UndefOr[Boolean]

   

   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

   2.1.8

5. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

6. val buttons: UndefOr[CleanJsObject[ExportingButtons]]

   

   Options for the export related buttons, print and export.

7. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. val enabled: UndefOr[Boolean]

   

   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.

   Example:

   1. Exporting module is loaded but disabled

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

   

   Definition Classes

   AnyRef

10. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

11. val fallbackToExportServer: UndefOr[Boolean]

    

    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

    2.1.8

12. val filename: UndefOr[String]

    

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

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

    Example:

    1. Custom file name

13. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

14. val formAttributes: UndefOr[Object]

    

    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

    1.3.8

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

    

    Definition Classes

    AnyRef → Any

16. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

17. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

18. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

19. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

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

    

    Definition Classes

    AnyRef

21. final def notify(): Unit

    

    Definition Classes

    AnyRef

22. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

23. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

24. val scale: UndefOr[Double]

    

    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.

    Example:

    1. Scale demonstrated

    Since

    1.3

25. val sourceHeight: UndefOr[Double]

    

    Analogous to sourceWidth

    Analogous to sourceWidth

    Since

    1.3

26. val sourceWidth: UndefOr[Double]

    

    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.

    Example:

    1. Source size demo

    Since

    1.3

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

    

    Definition Classes

    AnyRef

28. def toLocaleString(): String

    

    Definition Classes

    Object

29. def toString(): String

    

    Definition Classes

    AnyRef → Any

30. val type: UndefOr[String]

    

    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.

    Example:

    1. Default type set to image/jpeg

31. val url: UndefOr[String]

    

    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 Highslide Software's free web service.

32. def valueOf(): Any

    

    Definition Classes

    Object

33. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

34. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

35. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

36. val width: UndefOr[Double]

    

    The pixel width of charts exported to PNG or JPG.

    The pixel width of charts exported to PNG or JPG. As of Highstock 1.3, the default pixel width is a function of the chart.width or exporting.sourceWidth and the exporting.scale.

    Example:

    1. Export to 200px wide images