Visio.ShapeDataItem class

Пакет:

visio

Представляет ShapeDataItem.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: 1.1 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
format	Строка, которая определяет формат элемента данных фигуры.
formattedValue	Строка, указывающая форматируемое значение элемента данных фигуры.
label	Строка, которая указывает метку элемента данных фигуры.
value	Строка, которая указывает значение элемента данных фигуры.

Методы

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

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

context

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

context: RequestContext;

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

Visio.RequestContext

format

Строка, которая определяет формат элемента данных фигуры.

readonly format: string;

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

string

Комментарии

[ Набор API: 1.1 ]

formattedValue

Строка, указывающая форматируемое значение элемента данных фигуры.

readonly formattedValue: string;

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

string

Комментарии

[ Набор API: 1.1 ]

label

Строка, которая указывает метку элемента данных фигуры.

readonly label: string;

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

string

Комментарии

[ Набор API: 1.1 ]

value

Строка, которая указывает значение элемента данных фигуры.

readonly value: string;

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

string

Комментарии

[ Набор API: 1.1 ]

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

load(options)

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

load(options?: Visio.Interfaces.ShapeDataItemLoadOptions): Visio.ShapeDataItem;

Параметры

options

Visio.Interfaces.ShapeDataItemLoadOptions

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

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

Visio.ShapeDataItem

Примеры

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    const shapeDataItem = shape.shapeDataItems.getItem(0);
    shapeDataItem.load(["label", "value"]);
        return ctx.sync().then(function() {
            console.log(shapeDataItem.label);
            console.log(shapeDataItem.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.ShapeDataItem;

Параметры

propertyNames

string | string[]

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

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

Visio.ShapeDataItem

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Visio.ShapeDataItem;

Параметры

propertyNamesAndPaths

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

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

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

Visio.ShapeDataItem

setMockData(data)

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

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

Параметры

data

Visio.Interfaces.ShapeDataItemData

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

void

toJSON()

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

toJSON(): Visio.Interfaces.ShapeDataItemData;

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

Visio.Interfaces.ShapeDataItemData