Package io.jmix.charts.model.export

Class Export

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

  • Constructor Details

    • Export

      public Export()

  • Method Details

    • getEnabled

      public Boolean getEnabled()
      Returns:
      true if export functionality is enabled

    • setEnabled

      @StudioProperty public Export setEnabled(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 List<ExportMenuItem> getMenu()
      Returns:
      a list of menu or submenu items

    • setMenu

      @StudioElementsGroup(caption="Menu", xmlElement="menu") public Export setMenu(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 String getFileName()
      Returns:
      file name

    • setFileName

      @StudioProperty public Export setFileName(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 Boolean getRemoveImages()
      Returns:
      true if removeImages is enabled

    • setRemoveImages

      @StudioProperty public Export setRemoveImages(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 Boolean getExportTitles()
      Returns:
      true if exportTitles is enabled

    • setExportTitles

      @StudioProperty public Export setExportTitles(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 Boolean getExportSelection()
      Returns:
      true if only current data selection is exported

    • setExportSelection

      @StudioProperty public Export setExportSelection(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 String getDataDateFormat()
      Returns:
      data date format

    • setDataDateFormat

      @StudioProperty public Export setDataDateFormat(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 String getDateFormat()
      Returns:
      date format

    • setDateFormat

      @StudioProperty public Export setDateFormat(String dateFormat)
      Formats the category field in given date format (data export only).
      Parameters:
      dateFormat - date format
      Returns:
      export

    • getKeyListener

      public Boolean getKeyListener()
      Returns:
      true if keyListener is enabled

    • setKeyListener

      @StudioProperty public Export setKeyListener(Boolean keyListener)
      If true it observes the pressed keys to undo/redo the annotations.
      Parameters:
      keyListener - keyListener option
      Returns:
      export

    • getFileListener

      public Boolean getFileListener()
      Returns:
      true if fileListener is enabled

    • setFileListener

      @StudioProperty public Export setFileListener(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