io.jmix.charts.model.export

Class ExportMenuItem

java.lang.Object

io.jmix.charts.model.AbstractChartObject

io.jmix.charts.model.export.ExportMenuItem

All Implemented Interfaces:

java.io.Serializable

public class ExportMenuItem
extends AbstractChartObject

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExportMenuItem()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDateFormat()
java.lang.Double	getDelay()
java.lang.String	getDelimiter()
java.lang.Boolean	getEscape()
java.lang.String	getFileName()
ExportFormat	getFormat()
java.lang.String	getLabel()
java.lang.Boolean	getLossless()
java.lang.Double	getMultiplier()
PageOrientation	getPageOrientation()
java.lang.Boolean	getPageOrigin()
PageSize	getPageSize()
java.lang.Double	getQuality()
java.lang.Boolean	getQuotes()
java.lang.Boolean	getStringify()
java.lang.String	getTitle()
java.lang.Boolean	getWithHeader()
ExportMenuItem	setDateFormat(java.lang.String dateFormat) Sets the date format.
ExportMenuItem	setDelay(java.lang.Double delay) Sets delay by number of seconds.
ExportMenuItem	setDelimiter(java.lang.String delimiter) Sets a string that is used as a column delimiter.
ExportMenuItem	setEscape(java.lang.Boolean escape) Set escape to false if you want to escape strings.
ExportMenuItem	setFileName(java.lang.String fileName) Sets a file name that is used for generated export files.
ExportMenuItem	setFormat(ExportFormat format)
ExportMenuItem	setLabel(java.lang.String label)
ExportMenuItem	setLossless(java.lang.Boolean lossless) Set lossless to true if you want enable image optimization when printing.
ExportMenuItem	setMultiplier(java.lang.Double multiplier) Sets scale factor for the generated image.
ExportMenuItem	setPageOrientation(PageOrientation pageOrientation) Sets page orientation of the generated PDF file.
ExportMenuItem	setPageOrigin(java.lang.Boolean pageOrigin) Set pageOrigin to false if the origin of the generated PDF should be hidden (pdf format only).
ExportMenuItem	setPageSize(PageSize pageSize) Sets the format of PDF page.
@Max(value=1L) @Min(value=0L) ExportMenuItem	setQuality(java.lang.Double quality) Sets a quality of the resulting JPG image.
ExportMenuItem	setQuotes(java.lang.Boolean quotes) Set whether to enclose strings in double quotes.
ExportMenuItem	setStringify(java.lang.Boolean stringify) Set stringify to true if you want to convert all cell content to strings.
ExportMenuItem	setTitle(java.lang.String title)
ExportMenuItem	setWithHeader(java.lang.Boolean withHeader) Set withHeader to false if you don't want to add header row with column names.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportMenuItem

public ExportMenuItem()

Method Detail

getFormat

public ExportFormat getFormat()

setFormat

@StudioProperty(type=ENUMERATION)
public ExportMenuItem setFormat(ExportFormat format)

getLabel

public java.lang.String getLabel()

setLabel

@StudioProperty
public ExportMenuItem setLabel(java.lang.String label)

getTitle

public java.lang.String getTitle()

setTitle

@StudioProperty
public ExportMenuItem setTitle(java.lang.String title)

getFileName

public java.lang.String getFileName()

Returns:

file name

setFileName

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

Sets a file name that is used for generated export files.

Parameters:

fileName - file name

Returns:

export menu item

getPageOrientation

public PageOrientation getPageOrientation()

Returns:

page orientation of the generated PDF file

setPageOrientation

@StudioProperty(type=ENUMERATION,
                defaultValue="PORTRAIT")
public ExportMenuItem setPageOrientation(PageOrientation pageOrientation)

Sets page orientation of the generated PDF file. Default is portrait.

Parameters:

pageOrientation - page orientation

Returns:

export menu item

getPageOrigin

public java.lang.Boolean getPageOrigin()

Returns:

true if the origin of the generated PDF is shown

setPageOrigin

@StudioProperty
public ExportMenuItem setPageOrigin(java.lang.Boolean pageOrigin)

Set pageOrigin to false if the origin of the generated PDF should be hidden (pdf format only).

Parameters:

pageOrigin - pageOrigin option

Returns:

export menu item

getPageSize

public PageSize getPageSize()

Returns:

format of PDF page

setPageSize

@StudioProperty(type=ENUMERATION,
                defaultValue="A4")
public ExportMenuItem setPageSize(PageSize pageSize)

Sets the format of PDF page. Default value is A4.

Parameters:

pageSize - page size

Returns:

export menu item

getQuality

public java.lang.Double getQuality()

Returns:

a quality of the resulting JPG image

setQuality

@StudioProperty(defaultValue="1")
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) ExportMenuItem setQuality(java.lang.Double quality)

Sets a quality of the resulting JPG image. Default value is 1. Available values 0 - 1.

Parameters:

quality - quality

Returns:

export menu item

getMultiplier

public java.lang.Double getMultiplier()

Returns:

scale factor for the generated image

setMultiplier

@StudioProperty
public ExportMenuItem setMultiplier(java.lang.Double multiplier)

Sets scale factor for the generated image.

Parameters:

multiplier - multiplier

Returns:

export menu item

getDelay

public java.lang.Double getDelay()

Returns:

delay by number of seconds

setDelay

@StudioProperty
public ExportMenuItem setDelay(java.lang.Double delay)

Sets delay by number of seconds.

Parameters:

delay - delay

Returns:

export menu item

getLossless

public java.lang.Boolean getLossless()

Returns:

true if lossless is enabled

setLossless

@StudioProperty
public ExportMenuItem setLossless(java.lang.Boolean lossless)

Set lossless to true if you want enable image optimization when printing.

Parameters:

lossless - lossless option

Returns:

export menu item

getDelimiter

public java.lang.String getDelimiter()

Returns:

column delimiter

setDelimiter

@StudioProperty(defaultValue=",")
public ExportMenuItem setDelimiter(java.lang.String delimiter)

Sets a string that is used as a column delimiter. Default value is ",".

Parameters:

delimiter - delimiter

Returns:

export menu item

getQuotes

public java.lang.Boolean getQuotes()

Returns:

true if double quotes are enabled

setQuotes

@StudioProperty
public ExportMenuItem setQuotes(java.lang.Boolean quotes)

Set whether to enclose strings in double quotes.

Parameters:

quotes - quotes option

Returns:

export menu item

getEscape

public java.lang.Boolean getEscape()

Returns:

true if strings isn't escaped

setEscape

@StudioProperty
public ExportMenuItem setEscape(java.lang.Boolean escape)

Set escape to false if you want to escape strings.

Parameters:

escape - escape option

Returns:

export menu item

getWithHeader

public java.lang.Boolean getWithHeader()

Returns:

true if header row with column names is added

setWithHeader

@StudioProperty
public ExportMenuItem setWithHeader(java.lang.Boolean withHeader)

Set withHeader to false if you don't want to add header row with column names. Work for CSV and XLSX formats.

Parameters:

withHeader - withHeader option

Returns:

export menu item

getDateFormat

public java.lang.String getDateFormat()

Returns:

the date format

setDateFormat

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

Sets the date format. Work for XLSX format. Do not forget to set parseDates to true in CategoryAxis.

Parameters:

dateFormat - date format

Returns:

export menu item

getStringify

public java.lang.Boolean getStringify()

Returns:

true if all cell content is converted to strings

setStringify

@StudioProperty
public ExportMenuItem setStringify(java.lang.Boolean stringify)

Set stringify to true if you want to convert all cell content to strings. Work for XLSX format.

Parameters:

stringify - stringify option

Returns:

export menu item