Visio.ShapeDataItem class

Paket:

visio

Stellt das ShapeDataItem 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.
format	Eine Zeichenfolge, die das Format des Shape-Datenelements angibt.
formattedValue	Eine Zeichenfolge, die den formatierten Wert des Shape-Datenelements angibt.
label	Eine Zeichenfolge, die die Beschriftung des Shape-Datenelements angibt.
value	Eine Zeichenfolge, die den Wert des Shape-Datenelements angibt.

Methoden

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.ShapeDataItem-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Visio.Interfaces.ShapeDataItemData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt 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

format

Eine Zeichenfolge, die das Format des Shape-Datenelements angibt.

readonly format: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: 1.1 ]

formattedValue

Eine Zeichenfolge, die den formatierten Wert des Shape-Datenelements angibt.

readonly formattedValue: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: 1.1 ]

label

Eine Zeichenfolge, die die Beschriftung des Shape-Datenelements angibt.

readonly label: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: 1.1 ]

value

Eine Zeichenfolge, die den Wert des Shape-Datenelements angibt.

readonly value: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: 1.1 ]

Details zur Methode

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.ShapeDataItemLoadOptions): Visio.ShapeDataItem;

Parameter

options

Visio.Interfaces.ShapeDataItemLoadOptions

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

Gibt zurück

Visio.ShapeDataItem

Beispiele

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)

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.ShapeDataItem;

Parameter

propertyNames

string | string[]

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

Gibt zurück

Visio.ShapeDataItem

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?: {
            select?: string;
            expand?: string;
        }): Visio.ShapeDataItem;

Parameter

propertyNamesAndPaths

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

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.ShapeDataItem

setMockData(data)

Festlegen von Modelldaten

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

Parameter

data

Visio.Interfaces.ShapeDataItemData

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.ShapeDataItem-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Visio.Interfaces.ShapeDataItemData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Visio.Interfaces.ShapeDataItemData;

Gibt zurück

Visio.Interfaces.ShapeDataItemData