Excel.ShapeGroup class

  • Referência
Pacote:
excel

Representa um grupo de formas dentro de uma folha de cálculo. Para obter o objeto correspondente Shape , utilize ShapeGroup.shape.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
id

Especifica o identificador da forma.
shape

Devolve o Shape objeto associado ao grupo.
shapes

Devolve a coleção de Shape objetos.

Métodos

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(propertyNames)

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

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

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Excel.ShapeGroup original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ShapeGroupData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
ungroup()

Desagrupa todas as formas agrupadas no grupo de forma especificado.

Detalhes da propriedade

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

id

Especifica o identificador da forma.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

shape

Devolve o Shape objeto associado ao grupo.

readonly shape: Excel.Shape;

Valor da propriedade

Excel.Shape

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

shapes

Devolve a coleção de Shape objetos.

readonly shapes: Excel.GroupShapeCollection;

Valor da propriedade

Excel.GroupShapeCollection

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Detalhes do método

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.ShapeGroupLoadOptions): Excel.ShapeGroup;

Parâmetros

options
Excel.Interfaces.ShapeGroupLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.ShapeGroup

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.ShapeGroup;

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.ShapeGroup

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?: {
            select?: string;
            expand?: string;
        }): Excel.ShapeGroup;

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Excel.ShapeGroup

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Excel.ShapeGroup original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ShapeGroupData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.ShapeGroupData;

Retornos

Excel.Interfaces.ShapeGroupData

ungroup()

Desagrupa todas as formas agrupadas no grupo de forma especificado.

ungroup(): void;

Retornos

void

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 shapeGroup = sheet.shapes.getItem("Group").group;
    shapeGroup.ungroup();
    console.log("Shapes ungrouped");

    await context.sync();
});