Partager via

PowerPoint.ShapeGetImageOptions interface

Paquet:
powerpoint

Représente les options disponibles lors de l’obtention d’une image d’une forme. L’image est mise à l’échelle pour s’adapter aux dimensions souhaitées. Si la largeur et la hauteur ne sont pas spécifiées, la taille réelle de la forme est utilisée. Si une seule largeur ou hauteur est spécifiée, l’autre est calculée pour conserver les proportions. Les dimensions obtenues sont automatiquement limitées à la taille maximale prise en charge si elles sont trop grandes.

Remarques

[ Ensemble d’API : PowerPointApi 1.10 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shape-as-image.yaml

// Gets an image of the first selected shape with all options specified:
// a fixed width, height, and explicit PNG format.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  await context.sync();

  if (shapeCount.value === 0) {
    console.warn("No shapes are selected. Please select a shape and try again.");
    return;
  }

  const shape: PowerPoint.Shape = shapes.getItemAt(0);
  const options: PowerPoint.ShapeGetImageOptions = {
    format: PowerPoint.ShapeGetImageFormatType.png,
    width: 300,
    height: 150,
    // Both width and height are specified, so the image is scaled to fit within
    // 300x150 pixels. The image may not fill both dimensions if the aspect ratios differ.
  };
  const imageResult: OfficeExtension.ClientResult<string> = shape.getImageAsBase64(options);
  await context.sync();

  displayImage(imageResult.value, "PNG, 300x150px");
});

Propriétés

format

Format souhaité de l’image obtenue.
height

Hauteur souhaitée de l’image obtenue en pixels. Cette valeur est automatiquement limitée à la taille maximale prise en charge si elle est trop grande. Lève une exception lorsqu’elle InvalidArgument est définie avec un entier non positif.
width

Largeur souhaitée de l’image obtenue en pixels. Cette valeur est automatiquement limitée à la taille maximale prise en charge si elle est trop grande. Lève une exception lorsqu’elle InvalidArgument est définie avec un entier non positif.

Détails de la propriété

format

Format souhaité de l’image obtenue.

format?: PowerPoint.ShapeGetImageFormatType | "Png";

Valeur de propriété

PowerPoint.ShapeGetImageFormatType | "Png"

Remarques

[ Ensemble d’API : PowerPointApi 1.10 ]

height

Hauteur souhaitée de l’image obtenue en pixels. Cette valeur est automatiquement limitée à la taille maximale prise en charge si elle est trop grande. Lève une exception lorsqu’elle InvalidArgument est définie avec un entier non positif.

height?: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : PowerPointApi 1.10 ]

width

Largeur souhaitée de l’image obtenue en pixels. Cette valeur est automatiquement limitée à la taille maximale prise en charge si elle est trop grande. Lève une exception lorsqu’elle InvalidArgument est définie avec un entier non positif.

width?: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : PowerPointApi 1.10 ]