com.vaadin.flow.component.charts.model.Exporting Maven / Gradle / Ivy
/**
* Copyright 2000-2024 Vaadin Ltd.
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See {@literal } for the full
* license.
*/
package com.vaadin.flow.component.charts.model;
import java.util.Map;
/**
* Options for the exporting module. For an overview on the matter, see
* the docs.
*/
public class Exporting extends AbstractConfigurationObject {
private Boolean allowHTML;
private Buttons buttons;
private Boolean enabled;
private String _fn_error;
private Boolean fallbackToExportServer;
private String filename;
private String libURL;
private Map menuItemDefinitions;
private Number printMaxWidth;
private Number scale;
private Number sourceHeight;
private Number sourceWidth;
private ExportFileType type;
private String url;
private Number width;
public Exporting() {
}
/**
* @see #setAllowHTML(Boolean)
*/
public Boolean getAllowHTML() {
return 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.
*
*
* Defaults to: false
*/
public void setAllowHTML(Boolean allowHTML) {
this.allowHTML = allowHTML;
}
/**
* @see #setButtons(Buttons)
*/
public Buttons getButtons() {
if (buttons == null) {
buttons = new Buttons();
}
return 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.
*/
public void setButtons(Buttons buttons) {
this.buttons = buttons;
}
public Exporting(Boolean enabled) {
this.enabled = enabled;
}
/**
* @see #setEnabled(Boolean)
*/
public Boolean getEnabled() {
return enabled;
}
/**
* Whether to enable the exporting module. Disabling the module will hide
* the context button, but API methods will still be available.
*
* Defaults to: true
*/
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
public String getError() {
return _fn_error;
}
public void setError(String _fn_error) {
this._fn_error = _fn_error;
}
/**
* @see #setFallbackToExportServer(Boolean)
*/
public Boolean getFallbackToExportServer() {
return 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
*/
public void setFallbackToExportServer(Boolean fallbackToExportServer) {
this.fallbackToExportServer = fallbackToExportServer;
}
/**
* @see #setFilename(String)
*/
public String getFilename() {
return filename;
}
/**
* The filename, without extension, to use for the exported chart.
*
* Defaults to: chart
*/
public void setFilename(String filename) {
this.filename = filename;
}
/**
* @see #setLibURL(String)
*/
public String getLibURL() {
return 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.
*
* Defaults to: https://code.highcharts.com/{version}/lib
*/
public void setLibURL(String libURL) {
this.libURL = libURL;
}
/**
* @see #setMenuItemDefinitions(Map)
*/
public Map getMenuItemDefinitions() {
return 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:
*
*
* - onclick
* - The click handler for the menu item
* - text
* - The text for the menu item
*
- textKey
* - If internationalization is required, the key to a language
* string
*
*/
public void setMenuItemDefinitions(
Map menuItemDefinitions) {
this.menuItemDefinitions = menuItemDefinitions;
}
/**
* @see #setPrintMaxWidth(Number)
*/
public Number getPrintMaxWidth() {
return 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
*/
public void setPrintMaxWidth(Number printMaxWidth) {
this.printMaxWidth = printMaxWidth;
}
/**
* @see #setScale(Number)
*/
public Number getScale() {
return 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
*/
public void setScale(Number scale) {
this.scale = scale;
}
/**
* @see #setSourceHeight(Number)
*/
public Number getSourceHeight() {
return sourceHeight;
}
/**
* Analogous to sourceWidth
*/
public void setSourceHeight(Number sourceHeight) {
this.sourceHeight = sourceHeight;
}
/**
* @see #setSourceWidth(Number)
*/
public Number getSourceWidth() {
return 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.
*/
public void setSourceWidth(Number sourceWidth) {
this.sourceWidth = sourceWidth;
}
/**
* @see #setType(ExportFileType)
*/
public ExportFileType getType() {
return 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
*/
public void setType(ExportFileType type) {
this.type = type;
}
/**
* @see #setUrl(String)
*/
public String getUrl() {
return 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
*/
public void setUrl(String url) {
this.url = url;
}
/**
* @see #setWidth(Number)
*/
public Number getWidth() {
return 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.
*
* Defaults to: undefined
*/
public void setWidth(Number width) {
this.width = width;
}
}