ImageSize
Contents
[
Hide
]Inheritance: java.lang.Object
public class ImageSize
Contains information about image size and resolution.
To learn more, visit the Working with Images documentation article.
Examples:
Shows how to resize a shape with an image.
// When we insert an image using the "InsertImage" method, the builder scales the shape that displays the image so that,
// when we view the document using 100% zoom in Microsoft Word, the shape displays the image in its actual size.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape shape = builder.insertImage(getImageDir() + "Logo.jpg");
// A 400x400 image will create an ImageData object with an image size of 300x300pt.
ImageSize imageSize = shape.getImageData().getImageSize();
Assert.assertEquals(300.0d, imageSize.getWidthPoints());
Assert.assertEquals(300.0d, imageSize.getHeightPoints());
// If a shape's dimensions match the image data's dimensions,
// then the shape is displaying the image in its original size.
Assert.assertEquals(300.0d, shape.getWidth());
Assert.assertEquals(300.0d, shape.getHeight());
// Reduce the overall size of the shape by 50%.
shape.setWidth(shape.getWidth() * 0.5);
// Scaling factors apply to both the width and the height at the same time to preserve the shape's proportions.
Assert.assertEquals(150.0d, shape.getWidth());
Assert.assertEquals(150.0d, shape.getHeight());
// When we resize the shape, the size of the image data remains the same.
Assert.assertEquals(300.0d, imageSize.getWidthPoints());
Assert.assertEquals(300.0d, imageSize.getHeightPoints());
// We can reference the image data dimensions to apply a scaling based on the size of the image.
shape.setWidth(imageSize.getWidthPoints() * 1.1);
Assert.assertEquals(330.0d, shape.getWidth());
Assert.assertEquals(330.0d, shape.getHeight());
doc.save(getArtifactsDir() + "Image.ScaleImage.docx");
Constructors
| Constructor | Description |
|---|---|
| ImageSize(int widthPixels, int heightPixels) | Initializes width and height to the given values in pixels. |
| ImageSize(int widthPixels, int heightPixels, double horizontalResolution, double verticalResolution) | Initializes width, height and resolution to the given values. |
Methods
| Method | Description |
|---|---|
| getHeightPixels() | Gets the height of the image in pixels. |
| getHeightPoints() | Gets the height of the image in points. |
| getHorizontalResolution() | Gets the horizontal resolution in DPI. |
| getVerticalResolution() | Gets the vertical resolution in DPI. |
| getWidthPixels() | Gets the width of the image in pixels. |
| getWidthPoints() | Gets the width of the image in points. |
ImageSize(int widthPixels, int heightPixels)
public ImageSize(int widthPixels, int heightPixels)
Initializes width and height to the given values in pixels. Initializes resolution to 96 dpi.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| widthPixels | int | Width in pixels. |
| heightPixels | int | Height in pixels. |
ImageSize(int widthPixels, int heightPixels, double horizontalResolution, double verticalResolution)
public ImageSize(int widthPixels, int heightPixels, double horizontalResolution, double verticalResolution)
Initializes width, height and resolution to the given values.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| widthPixels | int | Width in pixels. |
| heightPixels | int | Height in pixels. |
| horizontalResolution | double | Horizontal resolution in DPI. |
| verticalResolution | double | Vertical resolution in DPI. |
getHeightPixels()
public int getHeightPixels()
Gets the height of the image in pixels.
Examples:
Shows how to read the properties of an image in a shape.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a shape into the document which contains an image taken from our local file system.
Shape shape = builder.insertImage(getImageDir() + "Logo.jpg");
// If the shape contains an image, its ImageData property will be valid,
// and it will contain an ImageSize object.
ImageSize imageSize = shape.getImageData().getImageSize();
// The ImageSize object contains read-only information about the image within the shape.
Assert.assertEquals(imageSize.getHeightPixels(), 400);
Assert.assertEquals(imageSize.getWidthPixels(), 400);
final double delta = 0.05;
Assert.assertEquals(imageSize.getHorizontalResolution(), 95.98d, delta);
Assert.assertEquals(imageSize.getVerticalResolution(), 95.98d, delta);
// We can base the size of the shape on the size of its image to avoid stretching the image.
shape.setWidth(imageSize.getWidthPoints() * 2.0);
shape.setHeight(imageSize.getHeightPoints() * 2.0);
doc.save(getArtifactsDir() + "Drawing.ImageSize.docx");
Returns: int - The height of the image in pixels.
getHeightPoints()
public double getHeightPoints()
Gets the height of the image in points. 1 point is 1/72 inch.
Examples:
Shows how to resize a shape with an image.
// When we insert an image using the "InsertImage" method, the builder scales the shape that displays the image so that,
// when we view the document using 100% zoom in Microsoft Word, the shape displays the image in its actual size.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape shape = builder.insertImage(getImageDir() + "Logo.jpg");
// A 400x400 image will create an ImageData object with an image size of 300x300pt.
ImageSize imageSize = shape.getImageData().getImageSize();
Assert.assertEquals(300.0d, imageSize.getWidthPoints());
Assert.assertEquals(300.0d, imageSize.getHeightPoints());
// If a shape's dimensions match the image data's dimensions,
// then the shape is displaying the image in its original size.
Assert.assertEquals(300.0d, shape.getWidth());
Assert.assertEquals(300.0d, shape.getHeight());
// Reduce the overall size of the shape by 50%.
shape.setWidth(shape.getWidth() * 0.5);
// Scaling factors apply to both the width and the height at the same time to preserve the shape's proportions.
Assert.assertEquals(150.0d, shape.getWidth());
Assert.assertEquals(150.0d, shape.getHeight());
// When we resize the shape, the size of the image data remains the same.
Assert.assertEquals(300.0d, imageSize.getWidthPoints());
Assert.assertEquals(300.0d, imageSize.getHeightPoints());
// We can reference the image data dimensions to apply a scaling based on the size of the image.
shape.setWidth(imageSize.getWidthPoints() * 1.1);
Assert.assertEquals(330.0d, shape.getWidth());
Assert.assertEquals(330.0d, shape.getHeight());
doc.save(getArtifactsDir() + "Image.ScaleImage.docx");
Returns: double - The height of the image in points.
getHorizontalResolution()
public double getHorizontalResolution()
Gets the horizontal resolution in DPI.
Examples:
Shows how to read the properties of an image in a shape.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a shape into the document which contains an image taken from our local file system.
Shape shape = builder.insertImage(getImageDir() + "Logo.jpg");
// If the shape contains an image, its ImageData property will be valid,
// and it will contain an ImageSize object.
ImageSize imageSize = shape.getImageData().getImageSize();
// The ImageSize object contains read-only information about the image within the shape.
Assert.assertEquals(imageSize.getHeightPixels(), 400);
Assert.assertEquals(imageSize.getWidthPixels(), 400);
final double delta = 0.05;
Assert.assertEquals(imageSize.getHorizontalResolution(), 95.98d, delta);
Assert.assertEquals(imageSize.getVerticalResolution(), 95.98d, delta);
// We can base the size of the shape on the size of its image to avoid stretching the image.
shape.setWidth(imageSize.getWidthPoints() * 2.0);
shape.setHeight(imageSize.getHeightPoints() * 2.0);
doc.save(getArtifactsDir() + "Drawing.ImageSize.docx");
Returns: double - The horizontal resolution in DPI.
getVerticalResolution()
public double getVerticalResolution()
Gets the vertical resolution in DPI.
Examples:
Shows how to read the properties of an image in a shape.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a shape into the document which contains an image taken from our local file system.
Shape shape = builder.insertImage(getImageDir() + "Logo.jpg");
// If the shape contains an image, its ImageData property will be valid,
// and it will contain an ImageSize object.
ImageSize imageSize = shape.getImageData().getImageSize();
// The ImageSize object contains read-only information about the image within the shape.
Assert.assertEquals(imageSize.getHeightPixels(), 400);
Assert.assertEquals(imageSize.getWidthPixels(), 400);
final double delta = 0.05;
Assert.assertEquals(imageSize.getHorizontalResolution(), 95.98d, delta);
Assert.assertEquals(imageSize.getVerticalResolution(), 95.98d, delta);
// We can base the size of the shape on the size of its image to avoid stretching the image.
shape.setWidth(imageSize.getWidthPoints() * 2.0);
shape.setHeight(imageSize.getHeightPoints() * 2.0);
doc.save(getArtifactsDir() + "Drawing.ImageSize.docx");
Returns: double - The vertical resolution in DPI.
getWidthPixels()
public int getWidthPixels()
Gets the width of the image in pixels.
Examples:
Shows how to read the properties of an image in a shape.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a shape into the document which contains an image taken from our local file system.
Shape shape = builder.insertImage(getImageDir() + "Logo.jpg");
// If the shape contains an image, its ImageData property will be valid,
// and it will contain an ImageSize object.
ImageSize imageSize = shape.getImageData().getImageSize();
// The ImageSize object contains read-only information about the image within the shape.
Assert.assertEquals(imageSize.getHeightPixels(), 400);
Assert.assertEquals(imageSize.getWidthPixels(), 400);
final double delta = 0.05;
Assert.assertEquals(imageSize.getHorizontalResolution(), 95.98d, delta);
Assert.assertEquals(imageSize.getVerticalResolution(), 95.98d, delta);
// We can base the size of the shape on the size of its image to avoid stretching the image.
shape.setWidth(imageSize.getWidthPoints() * 2.0);
shape.setHeight(imageSize.getHeightPoints() * 2.0);
doc.save(getArtifactsDir() + "Drawing.ImageSize.docx");
Returns: int - The width of the image in pixels.
getWidthPoints()
public double getWidthPoints()
Gets the width of the image in points. 1 point is 1/72 inch.
Examples:
Shows how to resize a shape with an image.
// When we insert an image using the "InsertImage" method, the builder scales the shape that displays the image so that,
// when we view the document using 100% zoom in Microsoft Word, the shape displays the image in its actual size.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape shape = builder.insertImage(getImageDir() + "Logo.jpg");
// A 400x400 image will create an ImageData object with an image size of 300x300pt.
ImageSize imageSize = shape.getImageData().getImageSize();
Assert.assertEquals(300.0d, imageSize.getWidthPoints());
Assert.assertEquals(300.0d, imageSize.getHeightPoints());
// If a shape's dimensions match the image data's dimensions,
// then the shape is displaying the image in its original size.
Assert.assertEquals(300.0d, shape.getWidth());
Assert.assertEquals(300.0d, shape.getHeight());
// Reduce the overall size of the shape by 50%.
shape.setWidth(shape.getWidth() * 0.5);
// Scaling factors apply to both the width and the height at the same time to preserve the shape's proportions.
Assert.assertEquals(150.0d, shape.getWidth());
Assert.assertEquals(150.0d, shape.getHeight());
// When we resize the shape, the size of the image data remains the same.
Assert.assertEquals(300.0d, imageSize.getWidthPoints());
Assert.assertEquals(300.0d, imageSize.getHeightPoints());
// We can reference the image data dimensions to apply a scaling based on the size of the image.
shape.setWidth(imageSize.getWidthPoints() * 1.1);
Assert.assertEquals(330.0d, shape.getWidth());
Assert.assertEquals(330.0d, shape.getHeight());
doc.save(getArtifactsDir() + "Image.ScaleImage.docx");
Returns: double - The width of the image in points.
