Поделиться через

Visio.ShapeCollection class

  • Ссылка
Пакет:
visio

Представляет коллекцию Shape.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: 1.1 ]

Свойства

context

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

Получает загруженные дочерние элементы в этой коллекции.

Методы

getCount()

Возвращает количество фигур в коллекции.
getItem(key)

Возвращает фигуру по ключу (имени или индексу).
load(options)

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

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

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

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

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

context

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

context: RequestContext;

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

Visio.RequestContext

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Visio.Shape[];

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

Visio.Shape[]

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

getCount()

Возвращает количество фигур в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: 1.1 ]

Примеры

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const numShapesActivePage = activePage.shapes.getCount();
    return ctx.sync().then(function () {
        console.log("Shapes Count: " + numShapesActivePage.value);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getItem(key)

Возвращает фигуру по ключу (имени или индексу).

getItem(key: number | string): Visio.Shape;

Параметры

key

number | string

Ключ — имя или индекс фигуры, которую нужно получить.

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

Visio.Shape

Комментарии

[ Набор API: 1.1 ]

load(options)

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

load(options?: Visio.Interfaces.ShapeCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.ShapeCollection;

Параметры

options

Visio.Interfaces.ShapeCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions

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

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

Visio.ShapeCollection

load(propertyNames)

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

load(propertyNames?: string | string[]): Visio.ShapeCollection;

Параметры

propertyNames

string | string[]

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

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

Visio.ShapeCollection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.ShapeCollection;

Параметры

propertyNamesAndPaths
OfficeExtension.LoadOption

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

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

Visio.ShapeCollection

toJSON()

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

toJSON(): Visio.Interfaces.ShapeCollectionData;

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

Visio.Interfaces.ShapeCollectionData