Visio.ShapeCollection class
Represents the Shape Collection.
- Extends
Remarks
[ API set: 1.1 ]
Properties
context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
items | Gets the loaded child items in this collection. |
Methods
get |
Gets the number of Shapes in the collection. |
get |
Gets a Shape using its key (name or Index). |
load(options) | Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
set |
Set mock data |
toJSON() | Overrides the JavaScript |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;
Property Value
items
Gets the loaded child items in this collection.
readonly items: Visio.Shape[];
Property Value
Method Details
getCount()
Gets the number of Shapes in the collection.
getCount(): OfficeExtension.ClientResult<number>;
Returns
OfficeExtension.ClientResult<number>
Remarks
[ API set: 1.1 ]
Examples
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)
Gets a Shape using its key (name or Index).
getItem(key: number | string): Visio.Shape;
Parameters
- key
-
number | string
Key is the Name or Index of the shape to be retrieved.
Returns
Remarks
[ API set: 1.1 ]
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(options?: Visio.Interfaces.ShapeCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.ShapeCollection;
Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNames?: string | string[]): Visio.ShapeCollection;
Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.ShapeCollection;
Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select
is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand
is a comma-delimited string that specifies the navigation properties to load.
Returns
setMockData(data)
Set mock data
setMockData(data: Visio.Interfaces.ShapeCollectionData): void;
Parameters
Returns
void
toJSON()
Overrides the JavaScript toJSON()
method in order to provide more useful output when an API object is passed to JSON.stringify()
. (JSON.stringify
, in turn, calls the toJSON
method of the object that is passed to it.) Whereas the original Visio.ShapeCollection
object is an API object, the toJSON
method returns a plain JavaScript object (typed as Visio.Interfaces.ShapeCollectionData
) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Visio.Interfaces.ShapeCollectionData;
Returns
Office Add-ins