グラフ:画像

名前空間: microsoft.graph

指定したサイズに合わせてグラフを拡大、縮小することで、グラフを Base64 でエンコードされた画像としてレンダリングします。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) Files.ReadWrite
委任 (個人用 Microsoft アカウント) サポートされていません。
アプリケーション サポートされていません。

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')

要求ヘッダー

名前 説明
Authorization ベアラー {token}。必須。
Workbook-Session-Id 変更を保持するかどうかを決定するブック セッション ID。省略可能。

パス パラメーター

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

パラメーター 説明
height Int32 結果の画像の希望する高さ。 省略可能。
width Int32 結果の画像の希望する幅。 省略可能。
fittingMode string グラフを指定したディメンションにスケーリングするために使用されるメソッド (高さと幅の両方が設定されている場合)。 使用可能な値: FitFitAndCenterFill

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で base-64 画像 string を返します。

以下は、この API を呼び出す方法の例です。

要求

以下は、要求の例です。

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

以下に応答の例を示します。注: ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

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

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

使用方法

HTML イメージ タグ: <img src="data:image/png;base64,{base-64 chart image string}/> 内の Base-64 文字列を表示できます。

既定の動作には、Image(width=0,height=0,fittingMode='fit') を使用します。 既定のパラメーターで返されるグラフ イメージの例を次に示します。

既定の設定と適合モードを使用して表示される円グラフを示すスクリーンショット。

イメージの表示をカスタマイズする場合は、高さ、幅、自動調整モードを指定します。 これらのパラメーターを使用してグラフ イメージを取得する場合、どのように表示されるかを次に示します。Image(width=500,height=500,fittingMode='Fill')

幅と高さが 500 に設定され、フィット モードが塗りつぶしに設定された円グラフを示すスクリーンショット。