workbookChart resource type
Namespace: microsoft.graph
Represents a chart object in a workbook.
Methods
| Method | Return Type | Description |
|---|---|---|
| List | workbookChart collection | Get the list of chart objects. |
| Get | workbookChart | Read the properties and relationships of chart object. |
| Update | workbookChart | Update a chart object. |
| Delete | None | Delete the chart object. |
| List chart series | workbookChartSeries collection | Get the list of chart series. |
| Create chart series | workbookChartSeries | Create a new chart series in the chart series. |
| Add chart | workbookChart | Creates a new chart. |
| Get chart at | workbookChart | Gets a chart based on its position in the collection. |
| Get chart image | Image base64 encoded string | Get a base64-encoded image of the chart that is scaled to fit the specified dimensions. |
| Reset data | None | Resets the source data for the chart. |
| Set position data | None | Positions the chart relative to cells on the worksheet. |
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 data labels 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 formatting 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
}