class Exporting extends Object
- Annotations
- @RawJSType() @ScalaJSDefined()
- Note
JavaScript name:
exporting
- Alphabetic
- By Inheritance
- Exporting
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Exporting()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
allowHTML: UndefOr[Boolean]
Experimental setting to allow HTML inside the chart (added through the
useHTMLoptions), directly in the exported image.Experimental setting to allow HTML inside the chart (added through the
useHTMLoptions), 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
foreignObjecttag 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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
val
buttons: UndefOr[CleanJsObject[ExportingButtons]]
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.
-
val
chartOptions: UndefOr[Object]
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.
Example: -
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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.
- Since
2.0
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
error: UndefOr[Function]
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
-
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
4.1.8
-
val
filename: UndefOr[String]
The filename, without extension, to use for the exported chart.
The filename, without extension, to use for the exported chart.
- Since
2.0
Example: -
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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
targetcan be set to make sure the generated image is received in another frame, or a customenctypeorencodingcan be set.- Since
3.0.8
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
val
libURL: UndefOr[String]
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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
val
printMaxWidth: UndefOr[Double]
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
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
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.
- Since
3.0
Example: -
val
sourceHeight: UndefOr[Double]
Analogous to sourceWidth
Analogous to sourceWidth
- Since
3.0
-
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.
- Since
3.0
Example: -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
val
type: UndefOr[String]
Default MIME type for exporting if
chart.exportChart()is called without specifying atypeoption.Default MIME type for exporting if
chart.exportChart()is called without specifying atypeoption. Possible values areimage/png,image/jpeg,application/pdfandimage/svg+xml.- Since
2.0
Example: -
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 Highchart's free web service.
- Since
2.0
-
def
valueOf(): Any
- Definition Classes
- Object
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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 Highcharts 3.0, the default pixel width is a function of the chart.width or exporting.sourceWidth and the exporting.scale.
- Since
2.0
Example: