XSSFPicture (POI API Documentation)

java.lang.Object
- org.apache.poi.xssf.usermodel.XSSFShape
- - org.apache.poi.xssf.usermodel.XSSFPicture

All Implemented Interfaces:

Picture, Shape
```
public final class XSSFPicture
extends XSSFShape
implements Picture
```
Represents a picture shape in a SpreadsheetML drawing. (表示 SpreadsheetML 绘图中的图片形状。)

Author:

Yegor Kozlov

Field Summary
- Fields inherited from class org.apache.poi.xssf.usermodel.XSSFShape
  anchor, drawing, parent

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`XSSFPicture(XSSFDrawing drawing, org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTPicture ctPicture)` Construct a new XSSFPicture object. (构造一个新的 XSSFPicture 对象。)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`XSSFClientAnchor`	`getClientAnchor()`
`org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTPicture`	`getCTPicture()` Return the underlying CTPicture bean that holds all properties for this picture (返回包含此图片所有属性的底层 CTPicture bean)
`java.awt.Dimension`	`getImageDimension()` Return the dimension of the embedded image in pixel (返回嵌入图像的尺寸（以像素为单位）)
`protected static java.awt.Dimension`	`getImageDimension(PackagePart part, int type)` Return the dimension of this image (返回此图像的尺寸)
`XSSFPictureData`	`getPictureData()` Return picture data for this shape (返回此形状的图片数据)
`XSSFClientAnchor`	`getPreferredSize()` Calculate the preferred size for this picture. (计算这张图片的首选尺寸。)
`XSSFClientAnchor`	`getPreferredSize(double scale)` Calculate the preferred size for this picture. (计算这张图片的首选尺寸。)
`XSSFClientAnchor`	`getPreferredSize(double scaleX, double scaleY)` Calculate the preferred size for this picture. (计算这张图片的首选尺寸。)
`java.lang.String`	`getShapeName()`
`protected org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties`	`getShapeProperties()` Returns xml bean with shape properties. (返回具有形状属性的 xml bean。)
`XSSFSheet`	`getSheet()`
`protected static org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTPicture`	`prototype()` Returns a prototype that is used to construct new shapes (返回用于构造新形状的原型)
`void`	`resize()` Reset the image to the dimension of the embedded image (将图像重置为嵌入图像的尺寸)
`void`	`resize(double scale)` Resize the image proportionally. (按比例调整图像大小。)
`void`	`resize(double scaleX, double scaleY)` Resize the image relatively to its current size. (相对于其当前大小调整图像大小。)
`protected void`	`setPictureReference(PackageRelationship rel)` Link this shape with the picture data (将此形状与图片数据链接)

Methods inherited from class org.apache.poi.xssf.usermodel.XSSFShape
getAnchor, getDrawing, getParent, isNoFill, setFillColor, setLineStyle, setLineStyleColor, setLineWidth, setNoFill

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.poi.ss.usermodel.Shape
getAnchor, getParent, isNoFill, setFillColor, setLineStyleColor, setNoFill

- Constructor Detail
  - XSSFPicture
```
protected XSSFPicture(XSSFDrawing drawing,
                      org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTPicture ctPicture)
```
    Construct a new XSSFPicture object. This constructor is called from XSSFDrawing.createPicture(XSSFClientAnchor, int) (构造一个新的 XSSFPicture 对象。从 XSSFDrawing.createPicture(XSSFClientAnchor, int) 调用此构造函数)
    
    Parameters:
    
    drawing - the XSSFDrawing that owns this picture (drawing - 拥有这张图片的 XSSFDrawing)
- Method Detail
  - prototype
```
protected static org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTPicture prototype()
```
    Returns a prototype that is used to construct new shapes (返回用于构造新形状的原型)
    
    Returns:
    
    a prototype that is used to construct new shapes (用于构建新形状的原型)
  - setPictureReference
```
protected void setPictureReference(PackageRelationship rel)
```
    Link this shape with the picture data (将此形状与图片数据链接)
    
    Parameters:
    
    rel - relationship referring the picture data (rel - 引用图片数据的关系)
  - getCTPicture
```
@Internal
public org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTPicture getCTPicture()
```
    Return the underlying CTPicture bean that holds all properties for this picture (返回包含此图片所有属性的底层 CTPicture bean)
    
    Returns:
    
    the underlying CTPicture bean (底层 CTPicture bean)
  - resize
```
public void resize()
```
    Reset the image to the dimension of the embedded image (将图像重置为嵌入图像的尺寸)
    
    Specified by:
    
    resize in interface Picture (在界面图片中调整大小)
    
    See Also:
    
    resize(double, double)
  - resize
```
public void resize(double scale)
```
    Resize the image proportionally. (按比例调整图像大小。)
    
    Specified by:
    
    resize in interface Picture (在界面图片中调整大小)
    
    See Also:
    
    resize(double, double)
  - resize
```
public void resize(double scaleX,
                   double scaleY)
```
    Resize the image relatively to its current size.
    Please note, that this method works correctly only for workbooks with the default font size (Calibri 11pt for .xlsx). If the default font is changed the resized image can be streched vertically or horizontally.
    
    resize(1.0,1.0) keeps the original size,
    resize(0.5,0.5) resize to 50% of the original,
    resize(2.0,2.0) resizes to 200% of the original.
    resize(Double.MAX_VALUE,Double.MAX_VALUE) resizes to the dimension of the embedded image.
    (相对于其当前大小调整图像大小。请注意，此方法仅适用于具有默认字体大小的工作簿（Calibri 11pt for .xlsx）。如果更改默认字体，则可以垂直或水平拉伸调整大小的图像。 resize(1.0,1.0) 保持原始大小，resize(0.5,0.5) 调整为原始大小的 50%，resize(2.0,2.0) 调整为原始大小的 200%。 resize(Double.MAX_VALUE,Double.MAX_VALUE) 调整为嵌入图像的尺寸。)
    
    Specified by:
    
    resize in interface Picture (在界面图片中调整大小)
    
    Parameters:
    
    scaleX - the amount by which the image width is multiplied relative to the original width, when set to Double.MAX_VALUE the width of the embedded image is used (scaleX - 图像宽度与原始宽度相乘的数量，当设置为 Double.MAX_VALUE 时，使用嵌入图像的宽度)
    
    scaleY - the amount by which the image height is multiplied relative to the original height, when set to Double.MAX_VALUE the height of the embedded image is used (scaleY - 图像高度相对于原始高度的乘积，当设置为 Double.MAX_VALUE 时，使用嵌入图像的高度)
  - getPreferredSize
```
public XSSFClientAnchor getPreferredSize()
```
    Calculate the preferred size for this picture. (计算这张图片的首选尺寸。)
    
    Specified by:
    
    getPreferredSize in interface Picture (接口图片中的getPreferredSize)
    
    Returns:
    
    XSSFClientAnchor with the preferred size for this image (具有此图像首选大小的 XSSFClientAnchor)
  - getPreferredSize
```
public XSSFClientAnchor getPreferredSize(double scale)
```
    Calculate the preferred size for this picture. (计算这张图片的首选尺寸。)
    
    Parameters:
    
    scale - the amount by which image dimensions are multiplied relative to the original size. (scale - 图像尺寸与原始尺寸相乘的数量。)
    
    Returns:
    
    XSSFClientAnchor with the preferred size for this image (具有此图像首选大小的 XSSFClientAnchor)
  - getPreferredSize
```
public XSSFClientAnchor getPreferredSize(double scaleX,
                                         double scaleY)
```
    Calculate the preferred size for this picture. (计算这张图片的首选尺寸。)
    
    Specified by:
    
    getPreferredSize in interface Picture (接口图片中的getPreferredSize)
    
    Parameters:
    
    scaleX - the amount by which image width is multiplied relative to the original width. (scaleX - 图像宽度与原始宽度相乘的数量。)
    
    scaleY - the amount by which image height is multiplied relative to the original height. (scaleY - 图像高度相对于原始高度的乘积量。)
    
    Returns:
    
    XSSFClientAnchor with the preferred size for this image (具有此图像首选大小的 XSSFClientAnchor)
  - getImageDimension
```
protected static java.awt.Dimension getImageDimension(PackagePart part,
                                                      int type)
```
    Return the dimension of this image (返回此图像的尺寸)
    
    Parameters:
    
    part - the package part holding raw picture data (part - 包含原始图片数据的包部分)
    
    type - type of the picture: Workbook.PICTURE_TYPE_JPEG, Workbook.PICTURE_TYPE_PNG or Workbook.PICTURE_TYPE_DIB (type - 图片的类型：Workbook.PICTURE_TYPE_JPEG、Workbook.PICTURE_TYPE_PNG 或 Workbook.PICTURE_TYPE_DIB)
    
    Returns:
    
    image dimension in pixels (图像尺寸（以像素为单位）)
  - getImageDimension
```
public java.awt.Dimension getImageDimension()
```
    Return the dimension of the embedded image in pixel (返回嵌入图像的尺寸（以像素为单位）)
    
    Specified by:
    
    getImageDimension in interface Picture (接口图片中的getImageDimension)
    
    Returns:
    
    image dimension in pixels (图像尺寸（以像素为单位）)
  - getPictureData
```
public XSSFPictureData getPictureData()
```
    Return picture data for this shape (返回此形状的图片数据)
    
    Specified by:
    
    getPictureData in interface Picture (接口图片中的getPictureData)
    
    Returns:
    
    picture data for this shape (此形状的图片数据)
  - getShapeProperties
```
protected org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties getShapeProperties()
```
    Description copied from class: XSSFShape
    
    Returns xml bean with shape properties. (返回具有形状属性的 xml bean。)
    
    Specified by:
    
    getShapeProperties in class XSSFShape (XSSFShape 类中的 getShapeProperties)
    
    Returns:
    
    xml bean with shape properties. (具有形状属性的 xml bean。)
  - getClientAnchor
```
public XSSFClientAnchor getClientAnchor()
```
    Specified by:
    
    getClientAnchor in interface Picture (接口图片中的getClientAnchor)
    
    Returns:
    
    the anchor that is used by this shape. (此形状使用的锚点。)
  - getSheet
```
public XSSFSheet getSheet()
```
    Specified by:
    
    getSheet in interface Picture (界面图片中的getSheet)
    
    Returns:
    
    the sheet which contains the picture shape (包含图片形状的工作表)
  - getShapeName
```
public java.lang.String getShapeName()
```
    Specified by:
    
    getShapeName in interface Shape (接口 Shape 中的 getShapeName)
    
    Returns:
    
    the name of this shape (这个形状的名字)

Class XSSFPicture

Field Summary

Fields inherited from class org.apache.poi.xssf.usermodel.XSSFShape

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.xssf.usermodel.XSSFShape

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.poi.ss.usermodel.Shape

Constructor Detail

XSSFPicture

Method Detail

prototype

setPictureReference

getCTPicture

resize

resize

resize

getPreferredSize

getPreferredSize

getPreferredSize

getImageDimension

getImageDimension

getPictureData

getShapeProperties

getClientAnchor

getSheet

getShapeName