scale property

ImageSaveOptions.scale property

Gets or sets the zoom factor for the generated images.

get scale(): number

Remarks

The default value is 1.0. The value must be greater than 0.

Examples

Shows how to edit the image while Aspose.words converts a document to one.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

builder.paragraphFormat.style = doc.styles.at("Heading 1");
builder.writeln("Hello world!");
builder.insertImage(base.imageDir + "Logo.jpg");

// When we save the document as an image, we can pass a SaveOptions object to
// edit the image while the saving operation renders it.
let options = new aw.Saving.ImageSaveOptions(aw.SaveFormat.Png)
{
  // We can adjust these properties to change the image's brightness and contrast.
  // Both are on a 0-1 scale and are at 0.5 by default.
  ImageBrightness = 0.3f,
  ImageContrast = 0.7f,

  // We can adjust horizontal and vertical resolution with these properties.
  // This will affect the dimensions of the image.
  // The default value for these properties is 96.0, for a resolution of 96dpi.
  HorizontalResolution = 72f,
  VerticalResolution = 72f,

  // We can scale the image using this property. The default value is 1.0, for scaling of 100%.
  // We can use this property to negate any changes in image dimensions that changing the resolution would cause.
  Scale = 96f / 72f
};

doc.save(base.artifactsDir + "ImageSaveOptions.EditImage.png", options);

Shows how to render an Office Math object into an image file in the local file system.

let doc = new aw.Document(base.myDir + "Office math.docx");

let officeMath = doc.getOfficeMath(0, true);

// Create an "ImageSaveOptions" object to pass to the node renderer's "Save" method to modify
// how it renders the OfficeMath node into an image.
let saveOptions = new aw.Saving.ImageSaveOptions(aw.SaveFormat.Png);

// Set the "Scale" property to 5 to render the object to five times its original size.
saveOptions.scale = 5;

officeMath.getMathRenderer().save(base.artifactsDir + "Shape.RenderOfficeMath.png", saveOptions);

See Also