Excel.ShapeGroup class

Пакет:

excel

Представляет группу фигур внутри листа. Чтобы получить соответствующий Shape объект, используйте .ShapeGroup.shape

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
id	Указывает идентификатор фигуры.
shape	Возвращает объект, Shape связанный с группой.
shapes	Возвращает коллекцию Shape объектов.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.ShapeGroup является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ShapeGroupData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
ungroup()	Отменяет группировку любых сгруппированных фигур в указанной группе фигур.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

id

Указывает идентификатор фигуры.

readonly id: string;

Значение свойства

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

shape

Возвращает объект, Shape связанный с группой.

readonly shape: Excel.Shape;

Значение свойства

Excel.Shape

Комментарии

[ Набор API: ExcelApi 1.9 ]

shapes

Возвращает коллекцию Shape объектов.

readonly shapes: Excel.GroupShapeCollection;

Значение свойства

Excel.GroupShapeCollection

Комментарии

[ Набор API: ExcelApi 1.9 ]

Сведения о методе

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.ShapeGroupLoadOptions): Excel.ShapeGroup;

Параметры

options

Excel.Interfaces.ShapeGroupLoadOptions

Предоставляет параметры свойств загружаемого объекта.

Возвращаемое значение

Excel.ShapeGroup

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.ShapeGroup

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.ShapeGroup

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.ShapeGroup является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ShapeGroupData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.ShapeGroupData;

Возвращаемое значение

Excel.Interfaces.ShapeGroupData

ungroup()

Отменяет группировку любых сгруппированных фигур в указанной группе фигур.

ungroup(): void;

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi 1.9 ]

Примеры

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