Excel.ShapeCollection interface

Representa uma coleção de todas as formas na planilha.

Métodos

_GetItem(shapeId)

Retorna uma forma identificada pela ID da forma.

addGeometricShape(geometricShapeType)

Adiciona uma forma geométrica à planilha. Retorna um objeto Shape que representa a nova forma.

addGroup(values)

Um subconjunto de formas na planilha do conjunto de grupos. Retorna um objeto Shape que representa o novo grupo de formas.

addImage(base64ImageString)

Cria uma imagem de uma cadeia de caracteres na base 64 e a adiciona à planilha. Retorna o objeto Shape que representa a nova imagem.

addLine(startLeft, startTop, endLeft, endTop, connectorType)

Adiciona uma linha à planilha. Retorna um objeto Shape que representa a nova linha.

addTextBox(text)

Adiciona uma caixa de texto na planilha com o texto fornecido como conteúdo. Retorna um objeto Shape que representa a nova caixa de texto.

getCount()

Retorna o número de formas da planilha.

getItem(key)

Obtém uma forma usando seu nome ou ID.

getItemAt(index)

Obtém uma forma usando sua posição na coleção.

load(propertyNames)

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

Detalhes do método

_GetItem(shapeId)

Retorna uma forma identificada pela ID da forma.

_GetItem(shapeId: string): Shape;

Parâmetros

shapeId
string

O identificador da forma.

Retornos

addGeometricShape(geometricShapeType)

Adiciona uma forma geométrica à planilha. Retorna um objeto Shape que representa a nova forma.

addGeometricShape(
            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"
        ): Shape;

Parâmetros

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"

Representa o tipo da forma geométrica. Para saber detalhes, confira Excel.GeometricShapeType.

Retornos

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.hexagon);
    shape.left = 5;
    shape.top = 5;
    shape.height = 175;
    shape.width = 200;
    await context.sync();
}

addGroup(values)

Um subconjunto de formas na planilha do conjunto de grupos. Retorna um objeto Shape que representa o novo grupo de formas.

addGroup(values: Array<string | Shape>): Shape;

Parâmetros

values
Array<string | Shape>

Uma matriz de ID da forma ou objetos Shape.

Retornos

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let square = sheet.shapes.getItem("Square");
    let pentagon = sheet.shapes.getItem("Pentagon");
    let octagon = sheet.shapes.getItem("Octagon");

    let shapeGroup = sheet.shapes.addGroup([square, pentagon, octagon]);
    shapeGroup.name = "Group";
    console.log("Shapes grouped");

    await context.sync();
}

addImage(base64ImageString)

Cria uma imagem de uma cadeia de caracteres na base 64 e a adiciona à planilha. Retorna o objeto Shape que representa a nova imagem.

addImage(base64ImageString: string): Shape;

Parâmetros

base64ImageString
string

Uma cadeia de caracteres codificada em base64 que representa uma imagem no formato JPEG ou PNG.

Retornos

Exemplos

let myFile = <HTMLInputElement>document.getElementById("selectedFile");
let reader = new FileReader();

reader.onload = (event) => {
    Excel.run((context) => {
        let startIndex = reader.result.toString().indexOf("base64,");
        let mybase64 = reader.result.toString().substr(startIndex + 7);
        let sheet = context.workbook.worksheets.getItem("Shapes");
        let image = sheet.shapes.addImage(mybase64);
        image.name = "Image";
        return context.sync();
    });
};

// Read in the image file as a data URL.
reader.readAsDataURL(myFile.files[0]);

addLine(startLeft, startTop, endLeft, endTop, connectorType)

Adiciona uma linha à planilha. Retorna um objeto Shape que representa a nova linha.

addLine(
            startLeft: number,
            startTop: number,
            endLeft: number,
            endTop: number,
            connectorType?: ConnectorType | "Straight" | "Elbow" | "Curve"
        ): Shape;

Parâmetros

startLeft
number

A distância, em pontos, desde o início da linha até o lado esquerdo da planilha.

startTop
number

A distância, em pontos, desde o início da linha até a parte superior da planilha.

endLeft
number

A distância, em pontos, do final da linha à esquerda da planilha.

endTop
number

A distância, em pontos, do final da linha até a parte superior da planilha.

connectorType
ConnectorType | "Straight" | "Elbow" | "Curve"

Representa o tipo de conector. Confira Excel. ConnectorType para obter detalhes.

Retornos

Exemplos

async function main(context: Excel.RequestContext) {
    let shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    let line = shapes.addLine(200, 50, 300, 150, Excel.ConnectorType.straight);
    line.name = "StraightLine";
    await context.sync();
}

addTextBox(text)

Adiciona uma caixa de texto na planilha com o texto fornecido como conteúdo. Retorna um objeto Shape que representa a nova caixa de texto.

addTextBox(text?: string): Shape;

Parâmetros

text
string

Representa o texto que será mostrado na caixa de texto criado.

Retornos

Exemplos

async function main(context: Excel.RequestContext) {
    let shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    let textbox = shapes.addTextBox("A box with text");
    textbox.left = 100;
    textbox.top = 100;
    textbox.height = 20;
    textbox.width = 175;
    textbox.name = "Textbox";
    await context.sync();
}

getCount()

Retorna o número de formas da planilha.

getCount(): ClientResult<number>;

Retornos

ClientResult<number>

getItem(key)

Obtém uma forma usando seu nome ou ID.

getItem(key: string): Shape;

Parâmetros

key
string

Nome ou ID da forma a ser recuperada.

Retornos

getItemAt(index)

Obtém uma forma usando sua posição na coleção.

getItemAt(index: number): Shape;

Parâmetros

index
number

O índice com base em zero da forma a ser recuperada.

Retornos

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