ImageSaveOptions

Class ImageSaveOptions

java.lang.Object

com.grapecity.documents.excel.ImageSaveOptions

---

public class ImageSaveOptions extends Object

表示将工作表、区域或形状导出为图像文件的选项。

使用此类可控制图像导出设置，例如缩放比例、分辨率、背景色、网格线显示、行列标题、绘图对象、黑白输出，以及是否包含自动合并的单元格。

 worksheet.getRange("A1:B2").setValue(new Object[][] {
     {"Name", "Value"},
     {"North", 120}
 });
 ImageSaveOptions options = new ImageSaveOptions();
 options.setBackgroundColor(Color.FromArgb(255, 0, 0));
 options.setShowGridlines(true);
 ByteArrayOutputStream stream = new ByteArrayOutputStream();
 worksheet.toImage(stream, ImageType.PNG, options);
 

• Constructor Summary

  Constructors

  Constructor

  Description

  ImageSaveOptions()

   

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  Color

  getBackgroundColor()

  获取导出图像的背景色。

  Boolean

  getBlackAndWhite()

  获取导出的图像是否保存为黑白图像。

  Color

  getGridlineColor()

  获取网格线颜色。

  boolean

  getIncludeAutoMergedCells()

  获取导出为图像时是否包含自动合并的单元格。

  Integer

  getResolution()

  获取 JPEG 图像导出的分辨率（以 DPI 为单位）。

  Double

  getScaleX()

  获取 X 轴上的缩放比例。

  Double

  getScaleY()

  获取 Y 轴上的缩放比例。

  Boolean

  getShowColumnHeadings()

  获取是否显示列标题。

  Boolean

  getShowDrawingObjects()

  获取是否显示绘图对象（图表、形状和图片）。

  Boolean

  getShowGridlines()

  获取是否在导出的图像中显示网格线。

  Boolean

  getShowRowHeadings()

  获取是否显示行标题。

  void

  setBackgroundColor(Color backgroundColor)

  设置导出图像的背景色。

  void

  setBlackAndWhite(Boolean blackAndWhite)

  设置导出的图像是否保存为黑白图像。

  void

  setGridlineColor(Color gridlineColor)

  设置网格线颜色。

  void

  setIncludeAutoMergedCells(boolean value)

  设置导出为图像时是否包含自动合并的单元格。

  void

  setResolution(Integer resolution)

  设置 JPEG 图像导出的分辨率（以 DPI 为单位）。

  void

  setScaleX(Double scaleX)

  设置 X 轴上的缩放比例。

  void

  setScaleY(Double scaleY)

  设置 Y 轴上的缩放比例。

  void

  setShowColumnHeadings(Boolean showColumnHeadings)

  设置是否显示列标题。

  void

  setShowDrawingObjects(Boolean showDrawingObjects)

  设置是否显示绘图对象（图表、形状和图片）。

  void

  setShowGridlines(Boolean showGridlines)

  设置是否在导出的图像中显示网格线。

  void

  setShowRowHeadings(Boolean showRowHeadings)

  设置是否显示行标题。

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • ImageSaveOptions

    public ImageSaveOptions()

• Method Details

  • getBackgroundColor

    public Color getBackgroundColor()

    获取导出图像的背景色。

    此属性指定将工作表、区域或形状导出为图像时使用的颜色。如果未分配背景色，此方法返回 null。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setBackgroundColor(Color.FromArgb(255, 0, 0));
     Color backgroundColor = options.getBackgroundColor();
     

    Returns:

    导出图像的背景色。如果未设置背景色，则返回 null。

  • setBackgroundColor

    public void setBackgroundColor(Color backgroundColor)

    设置导出图像的背景色。

    此属性指定将工作表、区域或形状导出为图像时使用的颜色。如果未分配背景色，此方法设置 null。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setBackgroundColor(Color.FromArgb(255, 0, 0));
     

    Parameters:

    backgroundColor - 导出图像的背景色。如果未设置背景色，则设置 null。

  • getShowRowHeadings

    public Boolean getShowRowHeadings()

    获取是否显示行标题。

    此属性指示将内容导出为图像时是否包含行标题。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setShowRowHeadings(true);
     Boolean showRowHeadings = options.getShowRowHeadings();
     

    Returns:

    一个 Boolean，指示是否显示行标题。

  • setShowRowHeadings

    public void setShowRowHeadings(Boolean showRowHeadings)

    设置是否显示行标题。

    此属性指示将内容导出为图像时是否包含行标题。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setShowRowHeadings(true);
     

    Parameters:

    showRowHeadings - 一个 Boolean，指示是否显示行标题。

  • getShowColumnHeadings

    public Boolean getShowColumnHeadings()

    获取是否显示列标题。

    此选项控制导出为图像时是否包含工作表列标题。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setShowColumnHeadings(true);
     Boolean showColumnHeadings = options.getShowColumnHeadings();
     

    Returns:

    true 表示显示列标题；false 表示隐藏它们；如果未显式设置此选项，则为 null。

  • setShowColumnHeadings

    public void setShowColumnHeadings(Boolean showColumnHeadings)

    设置是否显示列标题。

    此选项控制导出为图像时是否包含工作表列标题。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setShowColumnHeadings(true);
     

    Parameters:

    showColumnHeadings - true 表示显示列标题；false 表示隐藏它们；如果未显式设置此选项，则为 null。

  • getShowGridlines

    public Boolean getShowGridlines()

    获取是否在导出的图像中显示网格线。

    此属性适用于使用 ImageSaveOptions 的图像导出场景，例如将工作表或区域导出为图像。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setShowGridlines(true);
     Boolean showGridlines = options.getShowGridlines();
     

    Returns:

    true 表示在导出的图像中显示网格线；否则为 false。

  • setShowGridlines

    public void setShowGridlines(Boolean showGridlines)

    设置是否在导出的图像中显示网格线。

    此属性适用于使用 ImageSaveOptions 的图像导出场景，例如将工作表或区域导出为图像。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setShowGridlines(true);
     

    Parameters:

    showGridlines - true 表示在导出的图像中显示网格线；否则为 false。

  • getShowDrawingObjects

    public Boolean getShowDrawingObjects()

    获取是否显示绘图对象（图表、形状和图片）。

    此选项控制导出为图像时是否包含绘图对象。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setShowDrawingObjects(Boolean.TRUE);
     Boolean showDrawingObjects = options.getShowDrawingObjects();
     

    Returns:

    Boolean.TRUE 表示显示绘图对象；Boolean.FALSE 表示隐藏它们；如果未显式设置此选项，则为 null。

  • setShowDrawingObjects

    public void setShowDrawingObjects(Boolean showDrawingObjects)

    设置是否显示绘图对象（图表、形状和图片）。

    此选项控制导出为图像时是否包含绘图对象。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setShowDrawingObjects(Boolean.TRUE);
     

    Parameters:

    showDrawingObjects - Boolean.TRUE 表示显示绘图对象；Boolean.FALSE 表示隐藏它们；如果未显式设置此选项，则为 null。

  • getScaleX

    public Double getScaleX()

    获取 X 轴上的缩放比例。

    此值指定 ImageSaveOptions导出为图像时使用的水平缩放比例。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setScaleX(0.5);
     Double scaleX = options.getScaleX();
     

    Returns:

    X 轴上的缩放比例。

  • setScaleX

    public void setScaleX(Double scaleX)

    设置 X 轴上的缩放比例。

    此值指定 ImageSaveOptions导出为图像时使用的水平缩放比例。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setScaleX(0.5);
     

    Parameters:

    scaleX - X 轴上的缩放比例。

  • getScaleY

    public Double getScaleY()

    获取 Y 轴上的缩放比例。

    此值指定 ImageSaveOptions导出为图像时使用的垂直缩放比例。如果未分配 Y 轴缩放比例，此方法返回 null。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setScaleY(0.75);
     Double scaleY = options.getScaleY();
     

    Returns:

    Y 轴上的缩放比例。如果未设置 Y 轴缩放比例，则返回 null。

  • setScaleY

    public void setScaleY(Double scaleY)

    设置 Y 轴上的缩放比例。

    此值指定 ImageSaveOptions导出为图像时使用的垂直缩放比例。如果未分配 Y 轴缩放比例，此方法设置 null。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setScaleY(0.75);
     

    Parameters:

    scaleY - Y 轴上的缩放比例。如果未设置 Y 轴缩放比例，则设置 null。

  • getResolution

    public Integer getResolution()

    获取 JPEG 图像导出的分辨率（以 DPI 为单位）。

    当将工作表、区域或形状导出为 JPEG 图像时，ImageSaveOptions 使用此属性。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setResolution(192);
     Integer resolution = options.getResolution();
     

    Returns:

    JPEG 图像导出的分辨率（以 DPI 为单位）。

  • setResolution

    public void setResolution(Integer resolution)

    设置 JPEG 图像导出的分辨率（以 DPI 为单位）。

    当将工作表、区域或形状导出为 JPEG 图像时，ImageSaveOptions 使用此属性。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setResolution(192);
     

    Parameters:

    resolution - JPEG 图像导出的分辨率（以 DPI 为单位）。

  • getBlackAndWhite

    public Boolean getBlackAndWhite()

    获取导出的图像是否保存为黑白图像。

    当将工作表、区域或形状导出为图像文件时，ImageSaveOptions 使用此属性。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setBlackAndWhite(true);
     Boolean blackAndWhite = options.getBlackAndWhite();
     

    Returns:

    如果导出的图像保存为黑白图像，则为 true；否则为 false。

  • setBlackAndWhite

    public void setBlackAndWhite(Boolean blackAndWhite)

    设置导出的图像是否保存为黑白图像。

    当将工作表、区域或形状导出为图像文件时，ImageSaveOptions 使用此属性。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setBlackAndWhite(true);
     

    Parameters:

    blackAndWhite - 如果导出的图像保存为黑白图像，则为 true；否则为 false。

  • getGridlineColor

    public Color getGridlineColor()

    获取网格线颜色。

    当将工作表、区域或形状导出为图像时，ImageSaveOptions 使用此属性。如果未分配网格线颜色，此方法返回 null。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setGridlineColor(Color.FromArgb(0, 0, 255));
     Color gridlineColor = options.getGridlineColor();
     

    Returns:

    导出图像所使用的网格线颜色。如果未设置网格线颜色，则返回 null。

  • setGridlineColor

    public void setGridlineColor(Color gridlineColor)

    设置网格线颜色。

    当将工作表、区域或形状导出为图像时，ImageSaveOptions 使用此属性。如果未分配网格线颜色，此方法设置 null。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setGridlineColor(Color.FromArgb(0, 0, 255));
     

    Parameters:

    gridlineColor - 导出图像所使用的网格线颜色。如果未设置网格线颜色，则设置 null。

  • getIncludeAutoMergedCells

    public boolean getIncludeAutoMergedCells()

    获取导出为图像时是否包含自动合并的单元格。

    此选项适用于由 IWorksheet.autoMerge(IRange,AutoMergeDirection,AutoMergeMode,AutoMergeSelectionMode) 添加的自动合并信息。默认值为 false。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setIncludeAutoMergedCells(true);
     boolean includeAutoMergedCells = options.getIncludeAutoMergedCells();
     

    Returns:

    如果导出为图像时包含自动合并的单元格，则为 true；否则为 false。

  • setIncludeAutoMergedCells

    public void setIncludeAutoMergedCells(boolean value)

    设置导出为图像时是否包含自动合并的单元格。

    此选项适用于由 IWorksheet.autoMerge(IRange,AutoMergeDirection,AutoMergeMode,AutoMergeSelectionMode) 添加的自动合并信息。默认值为 false。

    
     ImageSaveOptions options = new ImageSaveOptions();
     options.setIncludeAutoMergedCells(true);
     

    Parameters:

    value - 如果导出为图像时包含自动合并的单元格，则为 true；否则为 false。