Visio.ShapeCollection class

Paket:

visio

Stellt die Shape-Auflistung dar.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: 1.1 ]

Eigenschaften

context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
items	Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Methoden

getCount()	Ruft die Anzahl von Shapes in der Auflistung ab.
getItem(key)	Ruft ein Shape mithilfe des Schlüssels ab (Name oder ID).
load(options)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
setMockData(data)	Festlegen von Modelldaten
toJSON()	Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Visio.ShapeCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Visio.Interfaces.ShapeCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

Details zur Eigenschaft

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Visio.RequestContext

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Visio.Shape[];

Eigenschaftswert

Visio.Shape[]

Details zur Methode

getCount()

Ruft die Anzahl von Shapes in der Auflistung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: 1.1 ]

Beispiele

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)

Ruft ein Shape mithilfe des Schlüssels ab (Name oder ID).

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

Parameter

key

number | string

Der Schlüssel ist der Name oder Index des Shapes, das abgerufen werden soll.

Gibt zurück

Visio.Shape

Hinweise

[ API-Satz: 1.1 ]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

options

Visio.Interfaces.ShapeCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Visio.ShapeCollection

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Visio.ShapeCollection

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

propertyNamesAndPaths

OfficeExtension.LoadOption

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Visio.ShapeCollection

setMockData(data)

Festlegen von Modelldaten

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

Parameter

data

Visio.Interfaces.ShapeCollectionData

Gibt zurück

void

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Visio.ShapeCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Visio.Interfaces.ShapeCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): Visio.Interfaces.ShapeCollectionData;

Gibt zurück

Visio.Interfaces.ShapeCollectionData