Chart: Image

Espace de noms: microsoft.graph

Affiche le graphique sous forme d’image codée en Base64 ajustée aux dimensions spécifiées.

Disponibilité de l’API

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ✅ ✅ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) Files.ReadWrite Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Non prise en charge. Non prise en charge.

Requête HTTP

GET /me/drive/items/{id}/workbook/worksheets/{id|name}/charts/{name}/image
GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/image
GET /me/drive/items/{id}/workbook/worksheets/{id|name}/charts/{name}/image(width=640)
GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/image(width=640)
GET /me/drive/items/{id}/workbook/worksheets/{id|name}/charts/{name}/image(width=640,height=480)
GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/image(width=640,height=480)
GET /me/drive/items/{id}/workbook/worksheets/{id|name}/charts/{name}/image(width=640,height=480,fittingMode='fit')
GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/image(width=640,height=480,fittingMode='fit')

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Workbook-Session-Id ID de session d’un classeur qui détermine si les modifications sont permanentes ou non. Facultatif.

Paramètres du chemin d’accès

Dans le corps de la demande, indiquez un objet JSON avec les paramètres suivants.

Paramètre Type Description
height Int32 Hauteur souhaitée de l’image produite. Facultatif.
largeur Int32 Largeur souhaitée de l’image produite. Facultatif.
fittingMode string Méthode utilisée pour mettre à l’échelle le graphique aux dimensions spécifiées (si la hauteur et la largeur sont définies). » Les valeurs possibles sont : Fit, , FillFitAndCenter.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et une chaîne d’image en base 64 dans le corps de la réponse.

Exemple

Voici comment vous pouvez appeler cette API.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/worksheets/{id|name}/charts/{name}/image(width=640,height=480,fittingMode='fit')

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-type: application/json;odata.metadata=minimal;odata.streaming=true

{
"value" : "base-64 chart image string"
}

Utilisation

Vous pouvez afficher la chaîne en base 64 à l’intérieur d’une balise d’image HTML : <img src="data:image/png;base64,{base-64 chart image string}/>.

Pour le comportement par défaut, utilisez Image(width=0,height=0,fittingMode='fit'). Voici un exemple de l’image d’un graphique renvoyé avec les paramètres par défaut.

Capture d’écran montrant un graphique en secteurs affiché avec les paramètres par défaut et le mode d’ajustement défini sur ajuster.

Si vous souhaitez personnaliser l’affichage de l’image, indiquez une hauteur, une largeur et un mode d’ajustement. Voici à quoi ressemble la même image de graphique si vous la récupérez avec ces paramètres : Image(width=500,height=500,fittingMode='Fill').

Capture d’écran montrant un graphique en secteurs affiché avec une largeur et une hauteur définies sur 500 et un mode d’ajustement défini sur remplissage.