Visio.ShapeView class
Stellt die ShapeView-Klasse dar.
- Extends
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. |
| highlight | Stellt die Hervorhebung um das Shape herum dar. |
Methoden
| add |
Fügt eine Überlagerung auf dem Shape hinzu. |
| add |
Fügt eine Überlagerung auf dem Shape hinzu. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| remove |
Entfernt eine bestimmte Überlagerung oder alle Überlagerungen auf dem Shape. |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| set |
Der Zweck der SetText-API besteht darin, den Text in einem Visio-Shape zur Laufzeit zu aktualisieren. Der aktualisierte Text behält die vorhandenen Formatierungseigenschaften des Texts der Form bei. |
| show |
Zeigt eine bestimmte Überlagerung auf der Form an. |
| toJSON() | Überschreibt die JavaScript-Methode |
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
highlight
Stellt die Hervorhebung um das Shape herum dar.
highlight: Visio.Highlight;Eigenschaftswert
Hinweise
[ API-Satz: 1.1 ]
Beispiele
Visio.run(session, function (ctx) {
const activePage = ctx.document.getActivePage();
const shape = activePage.shapes.getItem(0);
shape.view.highlight = { color: "#E7E7E7", width: 100 };
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
Details zur Methode
addOverlay(OverlayType, Content, OverlayHorizontalAlignment, OverlayVerticalAlignment, Width, Height)
Fügt eine Überlagerung auf dem Shape hinzu.
addOverlay(OverlayType: Visio.OverlayType, Content: string, OverlayHorizontalAlignment: Visio.OverlayHorizontalAlignment, OverlayVerticalAlignment: Visio.OverlayVerticalAlignment, Width: number, Height: number): OfficeExtension.ClientResult<number>;Parameter
- OverlayType
- Visio.OverlayType
Ein Überlagerungstyp. Kann "Text", "Image" oder "Html" sein.
- Content
-
string
Inhalt der Überlagerung.
- OverlayHorizontalAlignment
- Visio.OverlayHorizontalAlignment
Horizontale Ausrichtung der Überlagerung. Kann "Left", "Center" oder "Right" sein.
- OverlayVerticalAlignment
- Visio.OverlayVerticalAlignment
Vertikale Ausrichtung der Überlagerung. Kann "Top", "Middle", "Bottom" sein.
- Width
-
number
Überlagerungsbreite.
- Height
-
number
Überlagerungshöhe.
Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
[ API-Satz: 1.1 ]
Beispiele
Visio.run(session, function (ctx) {
const activePage = ctx.document.getActivePage();
const shape = activePage.shapes.getItem(0);
const overlayId = shape.view.addOverlay("Image", "Visio Online", "Center", "Middle", 50, 50);
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
addOverlay(OverlayTypeString, Content, OverlayHorizontalAlignmentString, OverlayVerticalAlignmentString, Width, Height)
Fügt eine Überlagerung auf dem Shape hinzu.
addOverlay(OverlayTypeString: "Text" | "Image" | "Html", Content: string, OverlayHorizontalAlignmentString: "Left" | "Center" | "Right", OverlayVerticalAlignmentString: "Top" | "Middle" | "Bottom", Width: number, Height: number): OfficeExtension.ClientResult<number>;Parameter
- OverlayTypeString
-
"Text" | "Image" | "Html"
Ein Überlagerungstyp. Kann "Text", "Image" oder "Html" sein.
- Content
-
string
Inhalt der Überlagerung.
- OverlayHorizontalAlignmentString
-
"Left" | "Center" | "Right"
Horizontale Ausrichtung der Überlagerung. Kann "Left", "Center" oder "Right" sein.
- OverlayVerticalAlignmentString
-
"Top" | "Middle" | "Bottom"
Vertikale Ausrichtung der Überlagerung. Kann "Top", "Middle", "Bottom" sein.
- Width
-
number
Überlagerungsbreite.
- Height
-
number
Überlagerungshöhe.
Gibt zurück
OfficeExtension.ClientResult<number>
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.ShapeViewLoadOptions): Visio.ShapeView;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
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.ShapeView;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
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.ShapeView;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
removeOverlay(OverlayId)
Entfernt eine bestimmte Überlagerung oder alle Überlagerungen auf dem Shape.
removeOverlay(OverlayId: number): void;Parameter
- OverlayId
-
number
Eine Überlagerungs-ID. Entfernt eine bestimmte Überlagerungs-ID aus dem Shape.
Gibt zurück
void
Hinweise
[ API-Satz: 1.1 ]
Beispiele
Visio.run(session, function (ctx) {
const activePage = ctx.document.getActivePage();
const shape = activePage.shapes.getItem(0);
shape.view.removeOverlay(1);
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.ShapeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Visio.Interfaces.ShapeViewUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Visio.ShapeView): void;Parameter
- properties
- Visio.ShapeView
Gibt zurück
void
setText(Text)
Der Zweck der SetText-API besteht darin, den Text in einem Visio-Shape zur Laufzeit zu aktualisieren. Der aktualisierte Text behält die vorhandenen Formatierungseigenschaften des Texts der Form bei.
setText(Text: string): void;Parameter
- Text
-
string
Der Textparameter ist der aktualisierte Text, der auf der Form angezeigt werden soll.
Gibt zurück
void
Hinweise
[ API-Satz: 1.1 ]
showOverlay(overlayId, show)
Zeigt eine bestimmte Überlagerung auf der Form an.
showOverlay(overlayId: number, show: boolean): void;Parameter
- overlayId
-
number
Die Überlagerungs-ID im Kontext.
- show
-
boolean
Gibt an, ob die Überlagerung angezeigt werden soll.
Gibt zurück
void
Hinweise
[ API-Satz: 1.1 ]
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.ShapeView-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Visio.Interfaces.ShapeViewData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Visio.Interfaces.ShapeViewData;Gibt zurück
Office Add-ins