Excel.Image class
Stellt ein Bild im Arbeitsblatt dar. Verwenden Sie Image.shape
, um das entsprechende Shape
-Objekt abzurufen.
- Extends
Hinweise
Eigenschaften
context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
format | Gibt das Format des Bilds zurück. |
id | Gibt den Shape-Bezeichner für das Bildobjekt an. |
shape | Gibt das |
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 " |
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 " |
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
format
Gibt das Format des Bilds zurück.
readonly format: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG";
Eigenschaftswert
Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const image = sheet.shapes.getItem("Image").image;
image.load("format");
await context.sync();
console.log("The image's format is: " + image.format);
await context.sync();
});
id
Gibt den Shape-Bezeichner für das Bildobjekt an.
readonly id: string;
Eigenschaftswert
string
Hinweise
shape
Gibt das Shape
dem Bild zugeordnete Objekt zurück.
readonly shape: Excel.Shape;
Eigenschaftswert
Hinweise
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?: Excel.Interfaces.ImageLoadOptions): Excel.Image;
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[]): Excel.Image;
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;
}): Excel.Image;
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
toJSON()
Überschreibt die JavaScript-Methode toJSON()
, um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()
übergeben wird. (JSON.stringify
ruft wiederum die toJSON
-Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.Image-Objekt ein API-Objekt ist, gibt die toJSON
Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ImageData
) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.ImageData;
Gibt zurück
Office Add-ins