Package io.jmix.charts.model.export

Class ExportMenuItem

java.lang.Object
io.jmix.charts.model.AbstractChartObject
io.jmix.charts.model.export.ExportMenuItem
All Implemented Interfaces:
Serializable
public class ExportMenuItem extends AbstractChartObject
See Also:

  • Constructor Details

    • ExportMenuItem

      public ExportMenuItem()

  • Method Details

    • getFormat

      public ExportFormat getFormat()

    • setFormat

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

    • getLabel

      public String getLabel()

    • setLabel

      @StudioProperty public ExportMenuItem setLabel(String label)

    • getTitle

      public String getTitle()

    • setTitle

      @StudioProperty public ExportMenuItem setTitle(String title)

    • getFileName

      public String getFileName()
      Returns:
      file name

    • setFileName

      @StudioProperty public ExportMenuItem setFileName(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 Boolean getPageOrigin()
      Returns:
      true if the origin of the generated PDF is shown

    • setPageOrigin

      @StudioProperty public ExportMenuItem setPageOrigin(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 Double getQuality()
      Returns:
      a quality of the resulting JPG image

    • setQuality

      @StudioProperty(defaultValue="1") @Max(1L) @Min(0L) public @Max(1L) @Min(0L) ExportMenuItem setQuality(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 Double getMultiplier()
      Returns:
      scale factor for the generated image

    • setMultiplier

      @StudioProperty public ExportMenuItem setMultiplier(Double multiplier)
      Sets scale factor for the generated image.
      Parameters:
      multiplier - multiplier
      Returns:
      export menu item

    • getDelay

      public Double getDelay()
      Returns:
      delay by number of seconds

    • setDelay

      @StudioProperty public ExportMenuItem setDelay(Double delay)
      Sets delay by number of seconds.
      Parameters:
      delay - delay
      Returns:
      export menu item

    • getLossless

      public Boolean getLossless()
      Returns:
      true if lossless is enabled

    • setLossless

      @StudioProperty public ExportMenuItem setLossless(Boolean lossless)
      Set lossless to true if you want enable image optimization when printing.
      Parameters:
      lossless - lossless option
      Returns:
      export menu item

    • getDelimiter

      public String getDelimiter()
      Returns:
      column delimiter

    • setDelimiter

      @StudioProperty(defaultValue=",") public ExportMenuItem setDelimiter(String delimiter)
      Sets a string that is used as a column delimiter. Default value is ",".
      Parameters:
      delimiter - delimiter
      Returns:
      export menu item

    • getQuotes

      public Boolean getQuotes()
      Returns:
      true if double quotes are enabled

    • setQuotes

      @StudioProperty public ExportMenuItem setQuotes(Boolean quotes)
      Set whether to enclose strings in double quotes.
      Parameters:
      quotes - quotes option
      Returns:
      export menu item

    • getEscape

      public Boolean getEscape()
      Returns:
      true if strings isn't escaped

    • setEscape

      @StudioProperty public ExportMenuItem setEscape(Boolean escape)
      Set escape to false if you want to escape strings.
      Parameters:
      escape - escape option
      Returns:
      export menu item

    • getWithHeader

      public Boolean getWithHeader()
      Returns:
      true if header row with column names is added

    • setWithHeader

      @StudioProperty public ExportMenuItem setWithHeader(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 String getDateFormat()
      Returns:
      the date format

    • setDateFormat

      @StudioProperty public ExportMenuItem setDateFormat(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 Boolean getStringify()
      Returns:
      true if all cell content is converted to strings

    • setStringify

      @StudioProperty public ExportMenuItem setStringify(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