Excel.Shape interface

Representa um objeto Shape genérico na planilha. Uma forma pode ser uma forma geométrica, uma linha, um grupo de formas, etc. Para saber mais sobre o modelo de objeto Shape, leia trabalhar com formas usando a API JavaScript do Excel.

Propriedades

altTextDescription

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

altTextTitle

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

connectionSiteCount

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

fill

Retorna a formatação de preenchimento dessa forma.

geometricShape

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

geometricShapeType

Especifica o tipo de forma geométrica dessa forma geométrica. Para saber detalhes, confira Excel.GeometricShapeType. Retorna nulo se o tipo de forma não for "GeometricShape".

group

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

height

Especifica a altura, em pontos, da forma. Gera uma exceção de argumento inválida quando definida com um valor negativo ou zero como entrada.

id

Especifica o identificador da forma.

image

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

left

A distância, em pontos, da lateral esquerda da forma do lado esquerdo da planilha. Gera uma exceção de argumento inválida quando definida com um valor negativo como entrada.

level

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.

line

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

lineFormat

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

lockAspectRatio

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

name

Especifica o nome da forma.

parentGroup

Especifica o grupo pai desta forma.

placement

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

rotation

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

textFrame

Retorna o objeto text frame de uma forma. Somente leitura.

top

A distância, em pontos, da borda superior da forma até a borda superior da planilha. Gera uma exceção de argumento inválida quando definida com um valor negativo como entrada.

type

Retorna o tipo dessa forma. Para saber detalhes, confira Excel.ShapeType.

visible

Especifica se a forma está visível.

width

Especifica a largura, em pontos, da forma. Gera uma exceção de argumento inválida quando definida com um valor negativo ou zero como entrada.

zOrderPosition

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

Métodos

copyTo(destinationSheet)

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

delete()

Remove a forma da planilha.

getAsImage(format)

Converte a forma em uma imagem e retorna a imagem como uma cadeia de caracteres de base 64. O DPI é 96. Os únicos formatos suportados sãoExcel.PictureFormat.BMP, Excel.PictureFormat.PNG, Excel.PictureFormat.JPEG, eExcel.PictureFormat.GIF.

incrementLeft(increment)

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

incrementRotation(increment)

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.

incrementTop(increment)

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

load(propertyNames)

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

scaleHeight(scaleFactor, scaleType, scaleFrom)

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.

scaleWidth(scaleFactor, scaleType, scaleFrom)

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.

setZOrder(position)

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.

Detalhes da propriedade

altTextDescription

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

altTextDescription: string;

Valor da propriedade

string

altTextTitle

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

altTextTitle: string;

Valor da propriedade

string

connectionSiteCount

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

readonly connectionSiteCount: number;

Valor da propriedade

number

fill

Retorna a formatação de preenchimento dessa forma.

readonly fill: ShapeFill;

Valor da propriedade

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.smileyFace);
    shape.left = 300;
    shape.top = 100;
    shape.height = 100;
    shape.width = 100;
    shape.fill.foregroundColor = "yellow"
    await context.sync();
}

geometricShape

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

readonly geometricShape: GeometricShape;

Valor da propriedade

geometricShapeType

Especifica o tipo de forma geométrica dessa forma geométrica. Para saber detalhes, confira Excel.GeometricShapeType. Retorna nulo se o tipo de forma não for "GeometricShape".

geometricShapeType:
            | 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

| 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"

group

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

readonly group: ShapeGroup;

Valor da propriedade

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");

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

    await context.sync();
}

height

Especifica a altura, em pontos, da forma. Gera uma exceção de argumento inválida quando definida com um valor negativo ou zero como entrada.

height: number;

Valor da propriedade

number

id

Especifica o identificador da forma.

readonly id: string;

Valor da propriedade

string

image

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

readonly image: Image;

Valor da propriedade

left

A distância, em pontos, da lateral esquerda da forma do lado esquerdo da planilha. Gera uma exceção de argumento inválida quando definida com um valor negativo como entrada.

left: number;

Valor da propriedade

number

level

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

number

line

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

readonly line: Line;

Valor da propriedade

Exemplos

async function main(context: Excel.RequestContext) {
    let shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    let 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();
}

lineFormat

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

readonly lineFormat: ShapeLineFormat;

Valor da propriedade

lockAspectRatio

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

lockAspectRatio: boolean;

Valor da propriedade

boolean

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Octagon")
    shape.lockAspectRatio = true;
    shape.scaleHeight(1.25, Excel.ShapeScaleType.currentSize);
    await context.sync();
}

name

Especifica o nome da forma.

name: string;

Valor da propriedade

string

parentGroup

Especifica o grupo pai desta forma.

readonly parentGroup: Shape;

Valor da propriedade

placement

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

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

Valor da propriedade

Placement | "TwoCell" | "OneCell" | "Absolute"

rotation

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

rotation: number;

Valor da propriedade

number

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let 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();
}

textFrame

Retorna o objeto text frame de uma forma. Somente leitura.

readonly textFrame: TextFrame;

Valor da propriedade

top

A distância, em pontos, da borda superior da forma até a borda superior da planilha. Gera uma exceção de argumento inválida quando definida com um valor negativo como entrada.

top: number;

Valor da propriedade

number

type

Retorna o tipo dessa forma. Para saber detalhes, confira Excel.ShapeType.

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

Valor da propriedade

| ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line"

visible

Especifica se a forma está visível.

visible: boolean;

Valor da propriedade

boolean

width

Especifica a largura, em pontos, da forma. Gera uma exceção de argumento inválida quando definida com um valor negativo ou zero como entrada.

width: number;

Valor da propriedade

number

zOrderPosition

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

number

Detalhes do método

copyTo(destinationSheet)

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

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

Parâmetros

destinationSheet
Worksheet | string

A planilha à qual o objeto Shape será colado. O valor padrão é a planilha da forma copiada.

Retornos

delete()

Remove a forma da planilha.

delete(): void;

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    context.workbook.worksheets.getItemOrNullObject("Shapes").delete();
    let sheet = context.workbook.worksheets.add("Shapes");

    let 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();
}

getAsImage(format)

Converte a forma em uma imagem e retorna a imagem como uma cadeia de caracteres de base 64. O DPI é 96. Os únicos formatos suportados sãoExcel.PictureFormat.BMP, Excel.PictureFormat.PNG, Excel.PictureFormat.JPEG, eExcel.PictureFormat.GIF.

getAsImage(
            format:
                | PictureFormat
                | "Unknown"
                | "Bmp"
                | "Jpeg"
                | "Gif"
                | "Png"
                | "Svg"
        ): ClientResult<string>;

Parâmetros

format
| PictureFormat | "Unknown" | "Bmp" | "Jpeg" | "Gif" | "Png" | "Svg"

Especifica o formato da imagem.

Retornos

ClientResult<string>

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Image");
    let result = shape.getAsImage(Excel.PictureFormat.png);
    await context.sync();

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

incrementLeft(increment)

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

incrementLeft(increment: number): void;

Parâmetros

increment
number

O incremento, em pontos, a forma será horizontalmente movida. Um valor positivo move a forma para a direita e um valor negativo a move para a esquerda. Se a planilha for orientada da direita para a esquerda, ela será revertida: os valores positivos moverão a forma para a esquerda e os valores negativos a moverão para a direita.

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Square")
    shape.incrementLeft(-25);
    await context.sync();
}

incrementRotation(increment)

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

increment
number

Quantos graus a forma será girada. Um valor positivo gira a forma no sentido horário; um valor negativo a gira no sentido anti-horário.

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Image");
    shape.incrementRotation(180);
    await context.sync();
}

incrementTop(increment)

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

incrementTop(increment: number): void;

Parâmetros

increment
number

O incremento, em pontos, a forma será movida verticalmente. em pontos. Um valor positivo move a forma para baixo e um valor negativo a move para cima.

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Pentagon")
    shape.incrementTop(25);
    await context.sync();
}

load(propertyNames)

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[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void

scaleHeight(scaleFactor, scaleType, scaleFrom)

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: ShapeScaleType | "CurrentSize" | "OriginalSize",
            scaleFrom?:
                | ShapeScaleFrom
                | "ScaleFromTopLeft"
                | "ScaleFromMiddle"
                | "ScaleFromBottomRight"
        ): void;

Parâmetros

scaleFactor
number

Especifica a proporção entre a altura da forma após você redimensioná-la e a altura atual ou original.

scaleType
ShapeScaleType | "CurrentSize" | "OriginalSize"

Especifica se a forma é dimensionada em relação ao seu tamanho original ou atual. A opção de escala de tamanho original só funciona para imagens.

scaleFrom
| ShapeScaleFrom | "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"

Opcional. Especifica qual parte da forma mantém sua posição quando a forma é dimensionada. Se for omitido, representará o canto superior esquerdo da forma mantém sua posição.

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Octagon")
    shape.lockAspectRatio = true;
    shape.scaleHeight(1.25, Excel.ShapeScaleType.currentSize);
    await context.sync();
}

scaleWidth(scaleFactor, scaleType, scaleFrom)

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: ShapeScaleType | "CurrentSize" | "OriginalSize",
            scaleFrom?:
                | ShapeScaleFrom
                | "ScaleFromTopLeft"
                | "ScaleFromMiddle"
                | "ScaleFromBottomRight"
        ): void;

Parâmetros

scaleFactor
number

Especifica a proporção entre a largura da forma após você redimensioná-la e a largura atual ou original.

scaleType
ShapeScaleType | "CurrentSize" | "OriginalSize"

Especifica se a forma é dimensionada em relação ao seu tamanho original ou atual. A opção de escala de tamanho original só funciona para imagens.

scaleFrom
| ShapeScaleFrom | "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"

Opcional. Especifica qual parte da forma mantém sua posição quando a forma é dimensionada. Se for omitido, representará o canto superior esquerdo da forma mantém sua posição.

Retornos

void

setZOrder(position)

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:
                | ShapeZOrder
                | "BringToFront"
                | "BringForward"
                | "SendToBack"
                | "SendBackward"
        ): void;

Parâmetros

position
| ShapeZOrder | "BringToFront" | "BringForward" | "SendToBack" | "SendBackward"

Onde mover a forma na pilha da ordem z em relação às outras formas. Consulte Excel. ShapeZOrder para obter detalhes.

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Octagon")
    shape.setZOrder(Excel.ShapeZOrder.sendBackward);
    await context.sync();
}