Object/Class

com.highmaps.config

Exporting

Related Docs: class Exporting | package config

Permalink

object Exporting

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

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. def apply(allowHTML: UndefOr[Boolean] = js.undefined, buttons: UndefOr[CleanJsObject[ExportingButtons]] = js.undefined, chartOptions: UndefOr[Object] = js.undefined, enabled: UndefOr[Boolean] = js.undefined, error: UndefOr[Function] = js.undefined, fallbackToExportServer: UndefOr[Boolean] = js.undefined, filename: UndefOr[String] = js.undefined, formAttributes: UndefOr[Object] = js.undefined, libURL: UndefOr[String] = js.undefined, menuItemDefinitions: UndefOr[Object] = js.undefined, printMaxWidth: UndefOr[Double] = js.undefined, scale: UndefOr[Double] = js.undefined, sourceHeight: UndefOr[Double] = js.undefined, sourceWidth: UndefOr[Double] = js.undefined, type: UndefOr[String] = js.undefined, url: UndefOr[String] = js.undefined, width: UndefOr[Double] = js.undefined): Exporting

    Permalink

    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.

    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.

    chartOptions

    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.

    enabled

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

    error

    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.

    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.

    filename

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

    formAttributes

    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.

    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.

    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:. <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
    .

    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.

    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.

    sourceHeight

    Analogous to sourceWidth

    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.

    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.

    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.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped