Visio.ShapeDataItemCollection class

Пакет:

visio

Представляет ShapeDataItemCollection для заданного объекта Shape.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: 1.1 ]

Свойства

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

Методы

getCount()	Возвращает количество элементов данных фигуры.
getItem(key)	Возвращает ShapeDataItem по имени.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
setMockData(data)	Настройка макетных данных
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Visio.ShapeDataItemCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Visio.Interfaces.ShapeDataItemCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

Visio.RequestContext

items

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

readonly items: Visio.ShapeDataItem[];

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

Visio.ShapeDataItem[]

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

getCount()

Возвращает количество элементов данных фигуры.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: 1.1 ]

getItem(key)

Возвращает ShapeDataItem по имени.

getItem(key: string): Visio.ShapeDataItem;

Параметры

key

string

Ключ — имя элемента ShapeDataItem, который нужно получить.

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

Visio.ShapeDataItem

Комментарии

[ Набор API: 1.1 ]

load(options)

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

load(options?: Visio.Interfaces.ShapeDataItemCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.ShapeDataItemCollection;

Параметры

options

Visio.Interfaces.ShapeDataItemCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions

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

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

Visio.ShapeDataItemCollection

Примеры

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    const shapeDataItems = shape.shapeDataItems;
    shapeDataItems.load(["label", "value"]);
    return ctx.sync().then(function() {
        for (let i = 0; i < shapeDataItems.items.length; i++) {
            console.log(shapeDataItems.items[i].label);
            console.log(shapeDataItems.items[i].value);
        }
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Visio.ShapeDataItemCollection

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

Visio.ShapeDataItemCollection

setMockData(data)

Настройка макетных данных

setMockData(data: Visio.Interfaces.ShapeDataItemCollectionData): void;

Параметры

data

Visio.Interfaces.ShapeDataItemCollectionData

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

void

toJSON()

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

toJSON(): Visio.Interfaces.ShapeDataItemCollectionData;

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

Visio.Interfaces.ShapeDataItemCollectionData