Apache POI - Common 5.3.0 · org.apache.poi.ss.usermodel.Picture

Method Summary

Modifier and Type	Method and Description
public ClientAnchor	Returns: the anchor that is used by this picture getClientAnchor()
public Dimension	Returns: image dimension in pixels getImageDimension() Return the dimension of the embedded image in pixel
public PictureData	Returns: picture data for this picture getPictureData() Return picture data for this picture
public ClientAnchor	Returns: XSSFClientAnchor with the preferred size for this image getPreferredSize() Calculate the preferred size for this picture.
public ClientAnchor	Returns: ClientAnchor with the preferred size for this image getPreferredSize(double the amount by which image width is multiplied relative to the original width. scaleX, double the amount by which image height is multiplied relative to the original height. scaleY) Calculate the preferred size for this picture.
public Sheet	Returns: the sheet which contains the picture getSheet()
public void	resize() Reset the image to the dimension of the embedded image
public void	resize(double scale) Resize the image proportionally.
public void	resize(double the amount by which the image width is multiplied relative to the original width. scaleX, double the amount by which the image height is multiplied relative to the original height. scaleY) Resize the image.

Inherited from org.apache.poi.ss.usermodel.Shape:: getAnchor getParent getShapeName isNoFill setFillColor setLineStyleColor setNoFill

Method Detail

getClientAnchor	back to summary
public ClientAnchor getClientAnchor() Returns:ClientAnchor the anchor that is used by this picture

getImageDimension	back to summary
public Dimension getImageDimension() Return the dimension of the embedded image in pixel Returns:Dimension image dimension in pixels

getImageDimension

back to summary

public Dimension getImageDimension()

Return the dimension of the embedded image in pixel

Returns:Dimension: image dimension in pixels

getPictureData	back to summary
public PictureData getPictureData() Return picture data for this picture Returns:PictureData picture data for this picture

getPictureData

back to summary

public PictureData getPictureData()

Return picture data for this picture

Returns:PictureData: picture data for this picture

getPreferredSize	back to summary
public ClientAnchor getPreferredSize() Calculate the preferred size for this picture. Returns:ClientAnchor XSSFClientAnchor with the preferred size for this image

getPreferredSize

back to summary

public ClientAnchor getPreferredSize()

Calculate the preferred size for this picture.

Returns:ClientAnchor: XSSFClientAnchor with the preferred size for this image

getPreferredSize	back to summary
public ClientAnchor getPreferredSize(double scaleX, double scaleY) Calculate the preferred size for this picture. Parameters scaleX:double the amount by which image width is multiplied relative to the original width. scaleY:double the amount by which image height is multiplied relative to the original height. Returns:ClientAnchor ClientAnchor with the preferred size for this image

getPreferredSize

back to summary

public ClientAnchor getPreferredSize(double scaleX, double scaleY)

Calculate the preferred size for this picture.

Parameters

scaleX:double: the amount by which image width is multiplied relative to the original width.
scaleY:double: the amount by which image height is multiplied relative to the original height.

Returns:ClientAnchor

ClientAnchor with the preferred size for this image

getSheet	back to summary
public Sheet getSheet() Returns:Sheet the sheet which contains the picture

resize back to summary

resize	back to summary
public void resize() Reset the image to the dimension of the embedded image See Also `resize(double, double)`

public void resize()

Reset the image to the dimension of the embedded image

See Also: resize(double, double)

resize back to summary

resize	back to summary
public void resize(double scale) Resize the image proportionally. See Also `resize(double, double)`

public void resize(double scale)

Resize the image proportionally.

See Also: resize(double, double)

resize back to summary

resize	back to summary
public void resize(double scaleX, double scaleY) Resize the image. Please note, that this method works correctly only for workbooks with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx). If the default font is changed the resized image can be stretched 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. Parameters scaleX:double the amount by which the image width is multiplied relative to the original width. scaleY:double the amount by which the image height is multiplied relative to the original height.

public void resize(double scaleX, double scaleY)

Resize the image.

Please note, that this method works correctly only for workbooks with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx). If the default font is changed the resized image can be stretched 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.

Parameters

scaleX:double: the amount by which the image width is multiplied relative to the original width.
scaleY:double: the amount by which the image height is multiplied relative to the original height.

public Interface Picture

Method Summary

Method Detail