com.aspose.words.ImageSize
java.lang.Object
com.aspose.words.ImageSize
public class ImageSize
To learn more, visit the Working with Images documentation article. Example:
// 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");
| Constructor Summary |
|---|
ImageSize(int widthPixels, int heightPixels)
Initializes width and height to the given values in pixels. Initializes resolution to 96 dpi. |
ImageSize(int widthPixels, int heightPixels, double horizontalResolution, double verticalResolution)
Initializes width, height and resolution to the given values. |
| Property Getters/Setters Summary | ||
|---|---|---|
int | getHeightPixels() | |
| Gets the height of the image in pixels. | ||
double | getHeightPoints() | |
| Gets the height of the image in points. 1 point is 1/72 inch. | ||
double | getHorizontalResolution() | |
| Gets the horizontal resolution in DPI. | ||
double | getVerticalResolution() | |
| Gets the vertical resolution in DPI. | ||
int | getWidthPixels() | |
| Gets the width of the image in pixels. | ||
double | getWidthPoints() | |
| Gets the width of the image in points. 1 point is 1/72 inch. | ||
| Constructor Detail |
|---|
public ImageSize(int widthPixels, int heightPixels)
widthPixels - Width in pixels.heightPixels - Height in pixels.public ImageSize(int widthPixels, int heightPixels, double horizontalResolution, double verticalResolution)
widthPixels - Width in pixels.heightPixels - Height in pixels.horizontalResolution - Horizontal resolution in DPI.verticalResolution - Vertical resolution in DPI.| Property Getters/Setters Detail |
|---|
getHeightPixels | |
public int getHeightPixels() | |
Example:
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");
getHeightPoints | |
public double getHeightPoints() | |
Example:
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");
getHorizontalResolution | |
public double getHorizontalResolution() | |
Example:
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");
getVerticalResolution | |
public double getVerticalResolution() | |
Example:
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");
getWidthPixels | |
public int getWidthPixels() | |
Example:
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");
getWidthPoints | |
public double getWidthPoints() | |
Example:
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");