org.fujion.highcharts

Class ExportingOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.ExportingOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class ExportingOptions
extends Options

Options for the exporting module.

Field Summary

Fields

Modifier and Type	Field and Description
ButtonOptions	buttons_exportButton Options for the export button.
ButtonOptions	buttons_printButton Options for the print button.
Boolean	enabled Whether to enable the exporting module.
String	error Function to call if the offline-exporting module fails to export a chart on the client side, and fallbackToExportServer is disabled.
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.
String	filename The filename, without extension, to use for the exported chart.
Integer	printMaxWidth When printing the chart from the menu item in the burger menu, if the on-screen chart exceeds this width, it is resized.
Integer	scale Defines the scale or zoom factor for the exported image compared to the on-screen display.
Boolean	showTable Export-data module required.
Integer	sourceHeight The height of the original chart when exported, unless an explicit chart.height is set.
Integer	sourceWidth The width of the original chart when exported, unless an explicit chart.width is set.
String	tableCaption Export-data module required.
ExportType	type Default MIME type for exporting if chart.exportChart() is called without specifying a type option.
String	url The URL for the server module converting the SVG string to an image format.
Boolean	useMultiLevelHeaders Export-data module required.
Boolean	useRowspanHeaders Export-data module required.
Integer	width The pixel width of charts exported to PNG or JPG.

Constructor Summary

Constructors

Constructor and Description
ExportingOptions()

Method Summary

Methods inherited from class org.fujion.ancillary.Options

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

buttons_exportButton

@Option(value="buttons.exportButton")
public final ButtonOptions buttons_exportButton

Options for the export button.

buttons_printButton

@Option(value="buttons.printButton")
public final ButtonOptions buttons_printButton

Options for the print button.

enabled

@Option
public Boolean enabled

Whether to enable the exporting module. Defaults to true.

error

@Option(convertTo=org.fujion.ancillary.JavaScript.class)
public String 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. Defaults to undefined.

fallbackToExportServer

@Option
public 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.

filename

@Option
public String filename

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

printMaxWidth

@Option
public Integer 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.

scale

@Option
public Integer 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.

showTable

@Option
public Boolean showTable

Export-data module required. Show a HTML table below the chart with the chart's current data. Defaults to false.

sourceHeight

@Option
public Integer sourceHeight

The height of the original chart when exported, unless an explicit chart.height is set. The height exported raster image is then multiplied by scale. Defaults to undefined.

sourceWidth

@Option
public Integer 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. Defaults to undefined.

tableCaption

@Option
public String tableCaption

Export-data module required. Caption for the data table. Same as chart title by default. Set to empty string to disable. Defaults to undefined.

type

@Option
public ExportType 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".

url

@Option
public 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 https://export.highcharts.com/.

useMultiLevelHeaders

@Option
public Boolean useMultiLevelHeaders

Export-data module required. Use multi level headers in data table. If csv.columnHeaderFormatter is defined, it has to return objects in order for multi level headers to work. Defaults to true.

useRowspanHeaders

@Option
public Boolean useRowspanHeaders

Export-data module required. If using multi level table headers, use rowspans for headers that have only one level. Defaults to true.

width

@Option
public Integer width

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

Constructor Detail

ExportingOptions

public ExportingOptions()