Compartir a través de

PowerPoint.Shape class

  • Referencia
Paquete:
powerpoint

Representa una sola forma en la diapositiva.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: PowerPointApi 1.3 ]

Ejemplos

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

// Changes the transparency of every geometric shape in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the shape transparency to be halfway transparent.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.geometricShape) {
      shape.fill.transparency = 0.5;
    }
  });
  await context.sync();
});

Propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
customXmlParts

Devuelve una colección de elementos XML personalizados de la forma.
fill

Devuelve el formato de relleno de esta forma.
height

Especifica el alto, en puntos, de la forma. Produce una InvalidArgument excepción cuando se establece con un valor negativo.
id

Obtiene el identificador único de la forma.
left

Distancia, en puntos, desde el lado izquierdo de la forma hasta el lado izquierdo de la diapositiva.
lineFormat

Devuelve el formato de línea de esta forma.
name

Especifica el nombre de esta forma.
tags

Devuelve una colección de etiquetas de la forma.
textFrame

Devuelve el objeto de marco de texto de esta forma.
top

Distancia, en puntos, desde el borde superior de la forma hasta el borde superior de la diapositiva.
type

Devuelve el tipo de esta forma. Vea PowerPoint.ShapeType para obtener más información.
width

Especifica el ancho, en puntos, de la forma. Produce una InvalidArgument excepción cuando se establece con un valor negativo.

Métodos

delete()

Elimina la forma de la colección de formas. No hace nada si la forma no existe.
getParentSlide()

Devuelve el objeto PowerPoint.Slide primario que contiene este Shapeobjeto . Produce una excepción si esta forma no pertenece a .Slide
getParentSlideLayout()

Devuelve el objeto PowerPoint.SlideLayout primario que contiene este Shapeobjeto . Produce una excepción si esta forma no pertenece a .SlideLayout
getParentSlideLayoutOrNullObject()

Devuelve el objeto PowerPoint.SlideLayout primario que contiene este Shapeobjeto . Si esta forma no pertenece a , se devuelve un SlideLayoutobjeto con una isNullObject propiedad establecida en true .
getParentSlideMaster()

Devuelve el objeto PowerPoint.SlideMaster primario que contiene este Shapeobjeto . Produce una excepción si esta forma no pertenece a .SlideMaster
getParentSlideMasterOrNullObject()

Devuelve el objeto PowerPoint.SlideMaster primario que contiene este Shapeobjeto . Si esta forma no pertenece a , se devuelve un SlideMasterobjeto con una isNullObject propiedad establecida en true .
getParentSlideOrNullObject()

Devuelve el objeto PowerPoint.Slide primario que contiene este Shapeobjeto . Si esta forma no pertenece a , se devuelve un Slideobjeto con una isNullObject propiedad establecida en true .
load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.Shape es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.ShapeData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

PowerPoint.RequestContext

customXmlParts

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Devuelve una colección de elementos XML personalizados de la forma.

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

Valor de propiedad

PowerPoint.CustomXmlPartCollection

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

fill

Devuelve el formato de relleno de esta forma.

readonly fill: PowerPoint.ShapeFill;

Valor de propiedad

PowerPoint.ShapeFill

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

Ejemplos

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

// Changes the selected shapes fill color to red.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  shapes.items.map((shape) => {
    shape.fill.setSolidColor("red");
  });
  await context.sync();
});

height

Especifica el alto, en puntos, de la forma. Produce una InvalidArgument excepción cuando se establece con un valor negativo.

height: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

Ejemplos

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

// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  let maxHeight = 0;
  shapes.items.map((shape) => {
    shape.load("width,height");
  });
  await context.sync();
  shapes.items.map((shape) => {
    shape.left = currentLeft;
    shape.top = currentTop;
    currentLeft += shape.width;
    if (shape.height > maxHeight) maxHeight = shape.height;
  });
  await context.sync();
  currentLeft = 0;
  if (currentTop > slideHeight - 200) currentTop = 0;
});

id

Obtiene el identificador único de la forma.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: PowerPointApi 1.3 ]

left

Distancia, en puntos, desde el lado izquierdo de la forma hasta el lado izquierdo de la diapositiva.

left: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

Ejemplos

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

// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  let maxHeight = 0;
  shapes.items.map((shape) => {
    shape.load("width,height");
  });
  await context.sync();
  shapes.items.map((shape) => {
    shape.left = currentLeft;
    shape.top = currentTop;
    currentLeft += shape.width;
    if (shape.height > maxHeight) maxHeight = shape.height;
  });
  await context.sync();
  currentLeft = 0;
  if (currentTop > slideHeight - 200) currentTop = 0;
});

lineFormat

Devuelve el formato de línea de esta forma.

readonly lineFormat: PowerPoint.ShapeLineFormat;

Valor de propiedad

PowerPoint.ShapeLineFormat

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

name

Especifica el nombre de esta forma.

name: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

tags

Devuelve una colección de etiquetas de la forma.

readonly tags: PowerPoint.TagCollection;

Valor de propiedad

PowerPoint.TagCollection

Comentarios

[ Conjunto de API: PowerPointApi 1.3 ]

textFrame

Devuelve el objeto de marco de texto de esta forma.

readonly textFrame: PowerPoint.TextFrame;

Valor de propiedad

PowerPoint.TextFrame

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

top

Distancia, en puntos, desde el borde superior de la forma hasta el borde superior de la diapositiva.

top: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

Ejemplos

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

// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  let maxHeight = 0;
  shapes.items.map((shape) => {
    shape.load("width,height");
  });
  await context.sync();
  shapes.items.map((shape) => {
    shape.left = currentLeft;
    shape.top = currentTop;
    currentLeft += shape.width;
    if (shape.height > maxHeight) maxHeight = shape.height;
  });
  await context.sync();
  currentLeft = 0;
  if (currentTop > slideHeight - 200) currentTop = 0;
});

type

Devuelve el tipo de esta forma. Vea PowerPoint.ShapeType para obtener más información.

readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";

Valor de propiedad

PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table"

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

Ejemplos

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

// Changes the transparency of every geometric shape in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the shape transparency to be halfway transparent.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.geometricShape) {
      shape.fill.transparency = 0.5;
    }
  });
  await context.sync();
});

width

Especifica el ancho, en puntos, de la forma. Produce una InvalidArgument excepción cuando se establece con un valor negativo.

width: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

Ejemplos

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

// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  let maxHeight = 0;
  shapes.items.map((shape) => {
    shape.load("width,height");
  });
  await context.sync();
  shapes.items.map((shape) => {
    shape.left = currentLeft;
    shape.top = currentTop;
    currentLeft += shape.width;
    if (shape.height > maxHeight) maxHeight = shape.height;
  });
  await context.sync();
  currentLeft = 0;
  if (currentTop > slideHeight - 200) currentTop = 0;
});

Detalles del método

delete()

Elimina la forma de la colección de formas. No hace nada si la forma no existe.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: PowerPointApi 1.3 ]

getParentSlide()

Devuelve el objeto PowerPoint.Slide primario que contiene este Shapeobjeto . Produce una excepción si esta forma no pertenece a .Slide

getParentSlide(): PowerPoint.Slide;

Devoluciones

PowerPoint.Slide

Comentarios

[ Conjunto de API: PowerPointApi 1.5 ]

getParentSlideLayout()

Devuelve el objeto PowerPoint.SlideLayout primario que contiene este Shapeobjeto . Produce una excepción si esta forma no pertenece a .SlideLayout

getParentSlideLayout(): PowerPoint.SlideLayout;

Devoluciones

PowerPoint.SlideLayout

Comentarios

[ Conjunto de API: PowerPointApi 1.5 ]

getParentSlideLayoutOrNullObject()

Devuelve el objeto PowerPoint.SlideLayout primario que contiene este Shapeobjeto . Si esta forma no pertenece a , se devuelve un SlideLayoutobjeto con una isNullObject propiedad establecida en true .

getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;

Devoluciones

PowerPoint.SlideLayout

Comentarios

[ Conjunto de API: PowerPointApi 1.5 ]

getParentSlideMaster()

Devuelve el objeto PowerPoint.SlideMaster primario que contiene este Shapeobjeto . Produce una excepción si esta forma no pertenece a .SlideMaster

getParentSlideMaster(): PowerPoint.SlideMaster;

Devoluciones

PowerPoint.SlideMaster

Comentarios

[ Conjunto de API: PowerPointApi 1.5 ]

getParentSlideMasterOrNullObject()

Devuelve el objeto PowerPoint.SlideMaster primario que contiene este Shapeobjeto . Si esta forma no pertenece a , se devuelve un SlideMasterobjeto con una isNullObject propiedad establecida en true .

getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;

Devoluciones

PowerPoint.SlideMaster

Comentarios

[ Conjunto de API: PowerPointApi 1.5 ]

getParentSlideOrNullObject()

Devuelve el objeto PowerPoint.Slide primario que contiene este Shapeobjeto . Si esta forma no pertenece a , se devuelve un Slideobjeto con una isNullObject propiedad establecida en true .

getParentSlideOrNullObject(): PowerPoint.Slide;

Devoluciones

PowerPoint.Slide

Comentarios

[ Conjunto de API: PowerPointApi 1.5 ]

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: PowerPoint.Interfaces.ShapeLoadOptions): PowerPoint.Shape;

Parámetros

options
PowerPoint.Interfaces.ShapeLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

PowerPoint.Shape

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): PowerPoint.Shape;

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

PowerPoint.Shape

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.Shape;

Parámetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

PowerPoint.Shape

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.Shape es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.ShapeData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): PowerPoint.Interfaces.ShapeData;

Devoluciones

PowerPoint.Interfaces.ShapeData