Excel.Shape class

Especifica o texto de descrição alternativo para um Shape objeto.

altTextDescription: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Especifica o texto alternativo do título de um Shape objeto.

altTextTitle: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Retorna o número de locais de conexão nessa forma.

readonly connectionSiteCount: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Obtém o nome de exibição da forma. Uma forma recém-criada tem um nome gerado que está localizado e pode não corresponder ao seu name. Nesse cenário, você pode usar essa API para obter o nome exibido na interface do usuário.

readonly displayName: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.15

Retorna a formatação de preenchimento dessa forma.

readonly fill: Excel.ShapeFill;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml

await Excel.run(async (context) => {
    // Apply a solid fill color to the shape.
    const sheet = context.workbook.worksheets.getItem("Sample");
    const badge = sheet.shapes.getItem("Badge");
    const shapeFill: Excel.ShapeFill = badge.fill;
    shapeFill.setSolidColor("#FFE08A");

    await context.sync();
});

Retorna a forma geométrica associada à forma. Um erro será lançado, se o tipo de forma não for "GeometricShape".

readonly geometricShape: Excel.GeometricShape;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Especifica o tipo de forma geométrica dessa forma geométrica. Consulte Excel.GeometricShapeType para obter detalhes. Retorna null se o tipo de forma não for "GeometricShape".

geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Retorna o grupo de forma associado à forma. Um erro será lançado, se o tipo de forma não for "GroupShape".

readonly group: Excel.ShapeGroup;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-groups.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");

    const shapeGroup = sheet.shapes.getItem("Group").group;
    shapeGroup.ungroup();
    console.log("Shapes ungrouped");

    await context.sync();
});

Especifica a altura, em pontos, da forma. Lança uma InvalidArgument exceção quando definido com um valor negativo ou zero como entrada.

height: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Especifica o identificador de forma.

readonly id: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Retorna a imagem associada à forma. Um erro será lançado, se o tipo de forma não for "Imagem".

readonly image: Excel.Image;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

A distância, em pontos, da lateral esquerda da forma do lado esquerdo da planilha. Lança uma InvalidArgument exceção quando definido com um valor negativo como entrada.

left: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Especifica o nível da forma especificada. Por exemplo, um nível de 0 significa que a forma não faz parte de nenhum grupo, um nível de 1 significa que a forma é parte de um grupo de nível superior e um nível 2 significa que a forma faz parte de um subgrupo do nível superior.

readonly level: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Retorna a linha associada à forma. Um erro será lançado, se o tipo de forma não for "Linha".

readonly line: Excel.Line;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const line = shapes.getItem("StraightLine").line;
    line.beginArrowheadLength = Excel.ArrowheadLength.long;
    line.beginArrowheadWidth = Excel.ArrowheadWidth.wide;
    line.beginArrowheadStyle = Excel.ArrowheadStyle.oval;

    line.endArrowheadLength = Excel.ArrowheadLength.long;
    line.endArrowheadWidth = Excel.ArrowheadWidth.wide;
    line.endArrowheadStyle = Excel.ArrowheadStyle.triangle;

    await context.sync();
});

Retorna a formatação de linha do objeto de forma.

readonly lineFormat: Excel.ShapeLineFormat;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml

await Excel.run(async (context) => {
    // Load and log the shape's fill and outline properties.
    const sheet = context.workbook.worksheets.getItem("Sample");
    const badge = sheet.shapes.getItem("Badge");
    badge.fill.load(["foregroundColor", "transparency", "type"]);
    badge.lineFormat.load(["color", "dashStyle", "style", "transparency", "visible", "weight"]);

    await context.sync();

    console.log("Badge fill: " + JSON.stringify(badge.fill));
    console.log("Badge line format: " + JSON.stringify(badge.lineFormat));
});

Especifica se a taxa de proporção dessa forma está bloqueada.

lockAspectRatio: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Octagon")
    shape.lockAspectRatio = true;
    shape.scaleHeight(1.25, Excel.ShapeScaleType.currentSize);
    await context.sync();
});

Especifica o nome da forma.

name: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Especifica o grupo pai dessa forma.

readonly parentGroup: Excel.Shape;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Representa como o objeto é anexado às células abaixo dela.

placement: Excel.Placement | "TwoCell" | "OneCell" | "Absolute";

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.10

Especifica a rotação, em graus, da forma.

rotation: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-create-and-delete.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.triangle);
    shape.left = 100;
    shape.top = 300;
    shape.height = 150;
    shape.width = 200;
    shape.rotation = 45;
    shape.fill.clear();
    await context.sync();
});

Retorna o objeto text frame de uma forma.

readonly textFrame: Excel.TextFrame;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

A distância, em pontos, da borda superior da forma até a borda superior da planilha. Lança uma InvalidArgument exceção quando definido com um valor negativo como entrada.

top: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Retorna o tipo dessa forma. Consulte Excel.ShapeType para obter detalhes.

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

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Especifica se a forma é visível.

visible: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Especifica a largura, em pontos, da forma. Lança uma InvalidArgument exceção quando definido com um valor negativo ou zero como entrada.

width: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Retorna a posição da forma especificada na ordem z, com 0 representando a parte inferior da pilha do pedido.

readonly zOrderPosition: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Copia e cola um Shape objeto. A forma colada é copiada para o mesmo local de pixel que essa forma.

copyTo(destinationSheet?: Worksheet | string): Excel.Shape;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.10

Remove a forma da planilha.

delete(): void;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-create-and-delete.yaml

await Excel.run(async (context) => {
    context.workbook.worksheets.getItemOrNullObject("Shapes").delete();
    const sheet = context.workbook.worksheets.add("Shapes");

    const shapes = sheet.shapes;

    // load all the shapes in the collection without loading their properties
    shapes.load("items/$none");
    await context.sync();

    shapes.items.forEach((shape) => shape.delete());
    await context.sync();
});

Converte a forma em uma imagem e retorna a imagem como uma cadeia de caracteres codificada em Base64. O DPI é 96. Os únicos formatos com suporte são Excel.PictureFormat.BMP,Excel.PictureFormat.PNG ,Excel.PictureFormat.JPEG e Excel.PictureFormat.GIF.

getAsImage(format: Excel.PictureFormat): OfficeExtension.ClientResult<string>;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Image");
    const result = shape.getAsImage(Excel.PictureFormat.png);
    await context.sync();

    const imageString = result.value;
    // Your add-in would save this string as a .png file.
    console.log("The image's Base64-encoded string: " + imageString);
});

Converte a forma em uma imagem e retorna a imagem como uma cadeia de caracteres codificada em Base64. O DPI é 96. Os únicos formatos com suporte são Excel.PictureFormat.BMP,Excel.PictureFormat.PNG ,Excel.PictureFormat.JPEG e Excel.PictureFormat.GIF.

getAsImage(format: "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"): OfficeExtension.ClientResult<string>;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Move a forma horizontalmente pelo número especificado de pontos.

incrementLeft(increment: number): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Square")
    shape.incrementLeft(-25);
    await context.sync();
});

O formato é girado em sentido horário ao redor do eixo z pelo número especificado de graus. Use a rotation propriedade para definir a rotação absoluta da forma.

incrementRotation(increment: number): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Image");
    shape.incrementRotation(180);
    await context.sync();
});

Move a forma verticalmente pelo número especificado de pontos.

incrementTop(increment: number): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Pentagon")
    shape.incrementTop(25);
    await context.sync();
});

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Dimensiona a altura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua altura atual.

scaleHeight(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Octagon")
    shape.lockAspectRatio = true;
    shape.scaleHeight(1.25, Excel.ShapeScaleType.currentSize);
    await context.sync();
});

Dimensiona a altura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua altura atual.

scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Dimensiona a largura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua largura atual.

scaleWidth(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Dimensiona a largura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua largura atual.

scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.Shape): void;

Parâmetros

Retornos

Move a forma especificada para cima ou para baixo na ordem z da coleção, que a desloca para frente ou para trás de outras formas.

setZOrder(position: Excel.ShapeZOrder): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");
    const shape = sheet.shapes.getItem("Octagon")
    shape.setZOrder(Excel.ShapeZOrder.sendBackward);
    await context.sync();
});

Move a forma especificada para cima ou para baixo na ordem z da coleção, que a desloca para frente ou para trás de outras formas.

setZOrder(position: "BringToFront" | "BringForward" | "SendToBack" | "SendBackward"): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.Shape é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ShapeData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.ShapeData;

Retornos

Ocorre quando a forma é ativada.

readonly onActivated: OfficeExtension.EventHandlers<Excel.ShapeActivatedEventArgs>;

Tipo de evento

Comentários

Conjunto de APIs: ExcelApi 1.9

Ocorre quando a forma é desativada.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ShapeDeactivatedEventArgs>;

Tipo de evento

Comentários

Conjunto de APIs: ExcelApi 1.9