PowerPoint.ShapeZOrder enum

Remarks

API set: PowerPointApi 1.8

Used by

• PowerPoint.Shape: setZOrder

Examples

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

// Sends the shape to the back.
changeZOrder(PowerPoint.ShapeZOrder.sendToBack);

...

async function changeZOrder(operation: PowerPoint.ShapeZOrder) {
 // Changes the z-order position of the selected shapes.
 return PowerPoint.run(async (context) => {
 const selectedShapes = context.presentation.getSelectedShapes();
 selectedShapes.load();
 await context.sync();

 if (selectedShapes.items.length === 0) {
 console.log("No shapes are selected.");
 } else {
 let direction = 1; // Start with bottom-most (lowest number).

 // Start with top-most when sending to back or bringing forward.

 switch (operation) {
 case PowerPoint.ShapeZOrder.bringForward:

 case PowerPoint.ShapeZOrder.sendToBack:
 direction = -1; // Reverse direction.

 break;
 }

 // Change the z-order position for each of the selected shapes,

 // starting with the bottom-most when bringing to front or sending backward,

 // or top-most when sending to back or bringing forward,

 // so the selected shapes retain their relative z-order positions after they're changed.

 selectedShapes.items
 .sort((a, b) => (a.zOrderPosition - b.zOrderPosition) * direction)
 .forEach((shape) => {
 try {
 const originalZOrderPosition = shape.zOrderPosition;
 shape.setZOrder(operation);

 console.log(`Changed z-order of shape ${shape.id}.`);
 } catch (err) {
 console.log(`Unable to change z-order of shape ${shape.id}. ${err.message}`);
 }
 });

 await context.sync();
 }
 });
}

Fields