io.jmix.charts.model.export

Class Export

java.lang.Object

io.jmix.charts.model.AbstractChartObject

io.jmix.charts.model.export.Export

All Implemented Interfaces:

java.io.Serializable

public class Export
extends AbstractChartObject

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Export()

Method Summary

Modifier and Type	Method and Description
Export	addMenuItem(ExportMenuItem menuItem) Adds menu item.
Color	getBackgroundColor()
java.lang.String	getDataDateFormat()
java.lang.String	getDateFormat()
java.lang.Boolean	getEnabled()
java.lang.Boolean	getExportSelection()
java.lang.Boolean	getExportTitles()
java.lang.Boolean	getFileListener()
java.lang.String	getFileName()
java.lang.Boolean	getKeyListener()
ExportLibs	getLibs()
java.util.List<ExportMenuItem>	getMenu()
ExportPosition	getPosition()
java.lang.Boolean	getRemoveImages()
Export	setBackgroundColor(Color backgroundColor) Sets the color for the background of the exported image.
Export	setDataDateFormat(java.lang.String dataDateFormat) Sets data date format to convert date strings to date objects.
Export	setDateFormat(java.lang.String dateFormat) Formats the category field in given date format (data export only).
Export	setEnabled(java.lang.Boolean enabled) Set enabled to false if you want to disable export functionality.
Export	setExportSelection(java.lang.Boolean exportSelection) Set exportSelection to true if you want to export the current data selection only (data export only).
Export	setExportTitles(java.lang.Boolean exportTitles) Set exportTitles to true if the data field names should be replaced with it's dedicated title (data export only).
Export	setFileListener(java.lang.Boolean fileListener) If true it observes the drag and drop feature and loads the dropped image file into the annotation.
Export	setFileName(java.lang.String fileName) Sets a file name that used for generated export files (an extension will be appended to it based on the export format).
Export	setKeyListener(java.lang.Boolean keyListener) If true it observes the pressed keys to undo/redo the annotations.
Export	setLibs(ExportLibs libs) Sets 3rd party required library settings.
Export	setMenu(java.util.List<ExportMenuItem> menu) Sets a list of menu or submenu items.
Export	setPosition(ExportPosition position) Sets a position of export icon.
Export	setRemoveImages(java.lang.Boolean removeImages) If true, export checks for and removes "tainted" images that area loaded from different domains.

Methods inherited from class java.lang.Object

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

Constructor Detail

Export

public Export()

Method Detail

getEnabled

public java.lang.Boolean getEnabled()

Returns:

true if export functionality is enabled

setEnabled

@StudioProperty
public Export setEnabled(java.lang.Boolean enabled)

Set enabled to false if you want to disable export functionality.

Parameters:

enabled - enabled option

Returns:

export

getLibs

public ExportLibs getLibs()

Returns:

3rd party required library settings

setLibs

public Export setLibs(ExportLibs libs)

Sets 3rd party required library settings.

Parameters:

libs - export libs

Returns:

export

getMenu

public java.util.List<ExportMenuItem> getMenu()

Returns:

a list of menu or submenu items

setMenu

@StudioElementsGroup(caption="Menu",
                     xmlElement="menu")
public Export setMenu(java.util.List<ExportMenuItem> menu)

Sets a list of menu or submenu items.

Parameters:

menu - list of menu

Returns:

export

addMenuItem

public Export addMenuItem(ExportMenuItem menuItem)

Adds menu item.

Parameters:

menuItem - menu item

Returns:

export

getBackgroundColor

public Color getBackgroundColor()

Returns:

the color for the background of the exported image

setBackgroundColor

@StudioProperty(type=OPTIONS)
public Export setBackgroundColor(Color backgroundColor)

Sets the color for the background of the exported image.

Parameters:

backgroundColor - color

Returns:

export

getFileName

public java.lang.String getFileName()

Returns:

file name

setFileName

@StudioProperty
public Export setFileName(java.lang.String fileName)

Sets a file name that used for generated export files (an extension will be appended to it based on the export format).

Parameters:

fileName - file name

Returns:

export

getPosition

public ExportPosition getPosition()

Returns:

a position of export icon

setPosition

@StudioProperty(type=ENUMERATION)
public Export setPosition(ExportPosition position)

Sets a position of export icon. Possible values: "top-left", "top-right" (default), "bottom-left", "bottom-right".

Parameters:

position - position

Returns:

export

getRemoveImages

public java.lang.Boolean getRemoveImages()

Returns:

true if removeImages is enabled

setRemoveImages

@StudioProperty
public Export setRemoveImages(java.lang.Boolean removeImages)

If true, export checks for and removes "tainted" images that area loaded from different domains.

Parameters:

removeImages - removeImages option

Returns:

export

getExportTitles

public java.lang.Boolean getExportTitles()

Returns:

true if exportTitles is enabled

setExportTitles

@StudioProperty
public Export setExportTitles(java.lang.Boolean exportTitles)

Set exportTitles to true if the data field names should be replaced with it's dedicated title (data export only).

Parameters:

exportTitles - exportTitles option

Returns:

export

getExportSelection

public java.lang.Boolean getExportSelection()

Returns:

true if only current data selection is exported

setExportSelection

@StudioProperty
public Export setExportSelection(java.lang.Boolean exportSelection)

Set exportSelection to true if you want to export the current data selection only (data export only).

Parameters:

exportSelection - exportSelection option

Returns:

export

getDataDateFormat

public java.lang.String getDataDateFormat()

Returns:

data date format

setDataDateFormat

@StudioProperty
public Export setDataDateFormat(java.lang.String dataDateFormat)

Sets data date format to convert date strings to date objects. Uses by default charts dataDateFormat (data export only).

Parameters:

dataDateFormat - data date format

Returns:

export

getDateFormat

public java.lang.String getDateFormat()

Returns:

date format

setDateFormat

@StudioProperty
public Export setDateFormat(java.lang.String dateFormat)

Formats the category field in given date format (data export only).

Parameters:

dateFormat - date format

Returns:

export

getKeyListener

public java.lang.Boolean getKeyListener()

Returns:

true if keyListener is enabled

setKeyListener

@StudioProperty
public Export setKeyListener(java.lang.Boolean keyListener)

If true it observes the pressed keys to undo/redo the annotations.

Parameters:

keyListener - keyListener option

Returns:

export

getFileListener

public java.lang.Boolean getFileListener()

Returns:

true if fileListener is enabled

setFileListener

@StudioProperty
public Export setFileListener(java.lang.Boolean fileListener)

If true it observes the drag and drop feature and loads the dropped image file into the annotation.

Parameters:

fileListener - fileListener option

Returns:

export