Visio.ShapeDataItem class
Представляет ShapeDataItem.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| format | Строка, которая определяет формат элемента данных фигуры. |
| formatted |
Строка, указывающая форматируемое значение элемента данных фигуры. |
| label | Строка, которая указывает метку элемента данных фигуры. |
| value | Строка, которая указывает значение элемента данных фигуры. |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
format
Строка, которая определяет формат элемента данных фигуры.
readonly format: string;Значение свойства
string
Комментарии
formattedValue
Строка, указывающая форматируемое значение элемента данных фигуры.
readonly formattedValue: string;Значение свойства
string
Комментарии
label
Строка, которая указывает метку элемента данных фигуры.
readonly label: string;Значение свойства
string
Комментарии
value
Строка, которая указывает значение элемента данных фигуры.
readonly value: string;Значение свойства
string
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(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[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.ShapeDataItem;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Visio.ShapeDataItem является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Visio.Interfaces.ShapeDataItemData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Visio.Interfaces.ShapeDataItemData;