Excel.Image class
Représente une image dans la feuille de calcul. Pour obtenir l’objet correspondant Shape , utilisez Image.shape.
- Extends
Remarques
Propriétés
| brightness | Spécifie la luminosité de l’image. La valeur de cette propriété doit être un nombre compris entre 0.0 (le plus sombre) et 1 (le plus clair). |
| color |
Spécifie le type de transformation de couleur appliquée à l’image. |
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| contrast | Spécifie le contraste de l’image. La valeur de cette propriété doit être un nombre compris entre 0.0 (contraste minimum) et 1,0 (contraste maximum). |
| crop |
Spécifie le nombre de points rogné en bas de l’image. |
| crop |
Spécifie le nombre de points rogné du côté gauche de l’image. |
| crop |
Spécifie le nombre de points rognées du côté droit de l’image. |
| crop |
Spécifie le nombre de points rogné en haut de l’image. |
| format | Renvoie le format de l’image. |
| id | Spécifie l’identificateur de forme de l’objet image. |
| shape | Retourne l’objet |
Méthodes
| increment |
Incrémente la luminosité de l’image d’une quantité spécifiée. |
| increment |
Incrémente le contraste de l’image d’un montant spécifié. |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type. |
| set(properties) | Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant. |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
brightness
Spécifie la luminosité de l’image. La valeur de cette propriété doit être un nombre compris entre 0.0 (le plus sombre) et 1 (le plus clair).
brightness: number;Valeur de propriété
number
Remarques
colorType
Spécifie le type de transformation de couleur appliquée à l’image.
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";Valeur de propriété
Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"
Remarques
context
Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
context: RequestContext;Valeur de propriété
contrast
Spécifie le contraste de l’image. La valeur de cette propriété doit être un nombre compris entre 0.0 (contraste minimum) et 1,0 (contraste maximum).
contrast: number;Valeur de propriété
number
Remarques
cropBottom
Spécifie le nombre de points rogné en bas de l’image.
cropBottom: number;Valeur de propriété
number
Remarques
cropLeft
Spécifie le nombre de points rogné du côté gauche de l’image.
cropLeft: number;Valeur de propriété
number
Remarques
cropRight
Spécifie le nombre de points rognées du côté droit de l’image.
cropRight: number;Valeur de propriété
number
Remarques
cropTop
Spécifie le nombre de points rogné en haut de l’image.
cropTop: number;Valeur de propriété
number
Remarques
format
Renvoie le format de l’image.
readonly format: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG";Valeur de propriété
Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"
Remarques
[ Ensemble d’API : ExcelApi 1.9 ]
Exemples
// 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
Spécifie l’identificateur de forme de l’objet image.
readonly id: string;Valeur de propriété
string
Remarques
shape
Retourne l’objet Shape associé à l’image.
readonly shape: Excel.Shape;Valeur de propriété
Remarques
Détails de la méthode
incrementBrightness(increment)
Incrémente la luminosité de l’image d’une quantité spécifiée.
incrementBrightness(increment: number): void;Paramètres
- increment
-
number
Spécifie de combien doit être modifiée la valeur de la propriété Brightness de l’image. Une valeur positive rend l’image plus claire et inversement, une valeur négative la rend plus sombre.
Retours
void
Remarques
incrementContrast(increment)
Incrémente le contraste de l’image d’un montant spécifié.
incrementContrast(increment: number): void;Paramètres
- increment
-
number
Spécifie dans quelle mesure pour modifier la valeur de la propriété Contrast de l'image. Une valeur positive augmente le contraste ; une valeur négative réduit le contraste.
Retours
void
Remarques
load(options)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(options?: Excel.Interfaces.ImageLoadOptions): Excel.Image;Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames?: string | string[]): Excel.Image;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.
Retours
load(propertyNamesAndPaths)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Image;Paramètres
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties: Interfaces.ImageUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.ImageUpdateData
Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.
- options
- OfficeExtension.UpdateOptions
Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.
Retours
void
set(properties)
Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
set(properties: Excel.Image): void;Paramètres
- properties
- Excel.Image
Retours
void
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Image est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.ImageDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.ImageData;