workbookChart resource type
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents a chart object in a workbook.
Methods
Method | Return Type | Description |
---|---|---|
Get Chart | workbookChart | Read properties and relationships of chart object. |
Create ChartSeries | workbookChartSeries | Create a new ChartSeries by posting to the series collection. |
List series | workbookChartSeries collection | Get a ChartSeries object collection. |
Update | workbookChart | Update Chart object. |
Image | Image base64 encoded string | Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. |
Delete | None | Deletes the chart object. |
Setdata | None | Resets the source data for the chart. |
Setposition | None | Positions the chart relative to cells on the worksheet. |
List | workbookChart collection | Get chart object collection. |
Itemat | workbookChart | Gets a chart based on its position in the collection. |
Add | workbookChart | Creates a new chart. |
Properties
Property | Type | Description |
---|---|---|
height | double | Represents the height, in points, of the chart object. |
id | string | Gets a chart based on its position in the collection. Read-only. |
left | double | The distance, in points, from the left side of the chart to the worksheet origin. |
name | string | Represents the name of a chart object. |
top | double | Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). |
width | double | Represents the width, in points, of the chart object. |
Relationships
Relationship | Type | Description |
---|---|---|
axes | workbookChartAxes | Represents chart axes. Read-only. |
dataLabels | workbookChartDataLabels | Represents the datalabels on the chart. Read-only. |
format | workbookChartAreaFormat | Encapsulates the format properties for the chart area. Read-only. |
legend | workbookChartLegend | Represents the legend for the chart. Read-only. |
series | workbookChartSeries collection | Represents either a single series or collection of series in the chart. Read-only. |
title | workbookChartTitle | Represents the title of the specified chart, including the text, visibility, position and formating of the title. Read-only. |
worksheet | workbookWorksheet | The worksheet containing the current chart. Read-only. |
JSON representation
The following JSON representation shows the resource type.
{
"height": 1024,
"id": "string",
"left": 1024,
"name": "string",
"top": 1024,
"width": 1024
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for