グラフ:画像Chart: Image

名前空間: microsoft graphNamespace: microsoft.graph

指定したサイズに合わせてグラフを拡大、縮小することで、グラフを Base64 でエンコードされた画像としてレンダリングします。Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Files.ReadWriteFiles.ReadWrite
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication サポートされていません。Not supported.

HTTP 要求HTTP request

GET /workbook/worksheets/{id|name}/charts/{name}/image
GET /workbook/worksheets/{id|name}/charts/{name}/image(width=640)
GET /workbook/worksheets/{id|name}/charts/{name}/image(width=640,height=480)
GET /workbook/worksheets/{id|name}/charts/{name}/image(width=640,height=480,fittingMode='fit')

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
Workbook-Session-IdWorkbook-Session-Id 変更を保持するかどうかを決定するブック セッション ID。省略可能。Workbook session Id that determines if changes are persisted or not. Optional.

パス パラメーターPath parameters

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。In the request body, provide a JSON object with the following parameters.

パラメーターParameter Type 説明Description
heightheight Int32Int32 結果の画像の希望する高さ。The desired height of the resulting image. 省略可能です。Optional.
widthwidth Int32Int32 結果の画像の希望する幅。The desired width of the resulting image. 省略可能です。Optional.
fittingModefittingMode stringstring 指定した寸法 (高さと幅の両方が設定されている場合) にグラフを拡大または縮小するために使用されるメソッドです。The method used to scale the chart to the specified dimensions (if both height and width are set)." 使用可能な値: FitFitAndCenterFillThe possible values are: Fit, FitAndCenter, Fill.

応答Response

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で base-64 画像 string を返します。If successful, this method returns 200 OK response code and base-64 image string in the response body.

Example

以下は、この API を呼び出す方法の例です。Here is an example of how to call this API.

要求Request

以下は、要求の例です。Here is an example of the request.

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

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

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

使用方法Usage

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

既定の動作には、Image(width=0,height=0,fittingMode='fit') を使用します。For default behavior, use Image(width=0,height=0,fittingMode='fit'). 既定のパラメーターで返されるグラフ イメージの例を次に示します。Here is an example of a chart image returned with the default parameters.

既定値の高さと幅の Excel グラフのイメージです。

イメージの表示をカスタマイズする場合は、高さ、幅、自動調整モードを指定します。If you want to customize the display of the image, specify a height, width, and a fitting mode. これらのパラメーターを使用してグラフ イメージを取得する場合、どのように表示されるかを次に示します。Image(width=500,height=500,fittingMode='Fill')Here is what the same chart image looks like if you retrieve it with these parameters: Image(width=500,height=500,fittingMode='Fill').

既定値の高さと幅の Excel グラフのイメージです。