Excel.ShapeCollection class
Representa uma coleção de todas as formas na planilha.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.9 ]
Propriedades
context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
items | Obtém os itens filhos carregados nesta coleção. |
Métodos
add |
Adiciona uma forma geométrica à planilha. Retorna um |
add |
Adiciona uma forma geométrica à planilha. Retorna um |
add |
Um subconjunto de formas na planilha do conjunto de grupos. Retorna um |
add |
Cria uma imagem de uma cadeia de caracteres na base 64 e a adiciona à planilha. Retorna o |
add |
Adiciona uma linha à planilha. Retorna um |
add |
Adiciona uma linha à planilha. Retorna um |
add |
Cria um gráfico vetorial escalável (SVG) de uma cadeia de caracteres XML e a adiciona à planilha. Retorna um |
add |
Adiciona uma caixa de texto na planilha com o texto fornecido como conteúdo. Retorna um |
get |
Retorna o número de formas da planilha. |
get |
Obtém uma forma usando seu nome ou ID. |
get |
Obtém uma forma usando sua posição na coleção. |
get |
Obtém uma forma usando seu nome ou ID. Se o objeto shape não existir, esse método retornará um objeto com sua |
load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
context
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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.Shape[];
Valor da propriedade
Detalhes do método
addGeometricShape(geometricShapeType)
Adiciona uma forma geométrica à planilha. Retorna um Shape
objeto que representa a nova forma.
addGeometricShape(geometricShapeType: Excel.GeometricShapeType): Excel.Shape;
Parâmetros
- geometricShapeType
- Excel.GeometricShapeType
Representa o tipo da forma geométrica. Confira Excel.GeometricShapeType
detalhes.
Retornos
Comentários
[ Conjunto de API: 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.hexagon);
shape.left = 5;
shape.top = 5;
shape.height = 175;
shape.width = 200;
await context.sync();
});
addGeometricShape(geometricShapeTypeString)
Adiciona uma forma geométrica à planilha. Retorna um Shape
objeto que representa a nova forma.
addGeometricShape(geometricShapeTypeString: "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"): Excel.Shape;
Parâmetros
- geometricShapeTypeString
-
"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. Confira Excel.GeometricShapeType
detalhes.
Retornos
Comentários
addGroup(values)
Um subconjunto de formas na planilha do conjunto de grupos. Retorna um Shape
objeto que representa o novo grupo de formas.
addGroup(values: Array<string | Shape>): Excel.Shape;
Parâmetros
- values
-
Array<string | Excel.Shape>
Uma matriz de IDs de forma ou objetos de forma.
Retornos
Comentários
[ Conjunto de API: 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 square = sheet.shapes.getItem("Square");
const pentagon = sheet.shapes.getItem("Pentagon");
const octagon = sheet.shapes.getItem("Octagon");
const 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 Shape
objeto que representa a nova imagem.
addImage(base64ImageString: string): Excel.Shape;
Parâmetros
- base64ImageString
-
string
Uma cadeia de caracteres codificada base64 que representa uma imagem no formato JPEG ou PNG.
Retornos
Comentários
[ Conjunto de API: ExcelApi 1.9 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml
const myFile = <HTMLInputElement>document.getElementById("selectedFile");
const reader = new FileReader();
reader.onload = (event) => {
Excel.run((context) => {
const startIndex = reader.result.toString().indexOf("base64,");
const myBase64 = reader.result.toString().substr(startIndex + 7);
const sheet = context.workbook.worksheets.getItem("Shapes");
const 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 Shape
objeto que representa a nova linha.
addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorType?: Excel.ConnectorType): Excel.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, do 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
- Excel.ConnectorType
Representa o tipo de conector. Confira Excel.ConnectorType
detalhes.
Retornos
Comentários
[ Conjunto de API: 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.addLine(200, 50, 300, 150, Excel.ConnectorType.straight);
line.name = "StraightLine";
await context.sync();
});
addLine(startLeft, startTop, endLeft, endTop, connectorTypeString)
Adiciona uma linha à planilha. Retorna um Shape
objeto que representa a nova linha.
addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorTypeString?: "Straight" | "Elbow" | "Curve"): Excel.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, do 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.
- connectorTypeString
-
"Straight" | "Elbow" | "Curve"
Representa o tipo de conector. Confira Excel.ConnectorType
detalhes.
Retornos
Comentários
addSvg(xml)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Cria um gráfico vetorial escalável (SVG) de uma cadeia de caracteres XML e a adiciona à planilha. Retorna um Shape
objeto que representa a nova imagem.
addSvg(xml: string): Excel.Shape;
Parâmetros
- xml
-
string
Uma cadeia de caracteres XML que representa o SVG.
Retornos
Comentários
addTextBox(text)
Adiciona uma caixa de texto na planilha com o texto fornecido como conteúdo. Retorna um Shape
objeto que representa a nova caixa de texto.
addTextBox(text?: string): Excel.Shape;
Parâmetros
- text
-
string
Representa o texto que será mostrado na caixa de texto criada.
Retornos
Comentários
[ Conjunto de API: ExcelApi 1.9 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-textboxes.yaml
await Excel.run(async (context) => {
const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
const 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(): OfficeExtension.ClientResult<number>;
Retornos
OfficeExtension.ClientResult<number>
Comentários
getItem(key)
Obtém uma forma usando seu nome ou ID.
getItem(key: string): Excel.Shape;
Parâmetros
- key
-
string
O nome ou a ID da forma a ser recuperada.
Retornos
Comentários
getItemAt(index)
Obtém uma forma usando sua posição na coleção.
getItemAt(index: number): Excel.Shape;
Parâmetros
- index
-
number
O índice baseado em zero da forma a ser recuperada.
Retornos
Comentários
getItemOrNullObject(key)
Obtém uma forma usando seu nome ou ID. Se o objeto shape não existir, esse método retornará um objeto com sua isNullObject
propriedade definida como true
. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getItemOrNullObject(key: string): Excel.Shape;
Parâmetros
- key
-
string
O nome ou a ID da forma a ser recuperada.
Retornos
Comentários
load(options)
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.ShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ShapeCollection;
Parâmetros
Fornece opções para quais propriedades do objeto carregar.
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[]): Excel.ShapeCollection;
Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync()
antes de ler as propriedades.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ShapeCollection;
Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select
é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand
é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
toJSON()
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.) Considerando que o objeto original Excel.ShapeCollection
é um objeto API, o toJSON
método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ShapeCollectionData
) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.ShapeCollectionData;
Retornos
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de