Show Chart Legend in a Worksheet

This REST API enables you to display the legend—the explanatory box that identifies data series—in a chart that resides in a worksheet of an Excel workbook.

REST API

PUT http://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/legend

Request parameters

Parameter Name	Type	Location	Description
name	string	path	The workbook filename.
sheetName	string	path	The worksheet name that contains the chart.
chartIndex	integer	path	The zero‑based index of the chart.
folder	string	query	The folder that contains the workbook.
storageName	string	query	The name of the storage service.

The OpenAPI Specification defines a publicly accessible programming interface and lets you perform REST interactions directly from a web browser.

Authentication is performed with a Bearer JWT token supplied in the Authorization header.

You can use the cURL command‑line tool to access Aspose.Cells web services easily. The following example shows how to make the call with cURL.

Request

curl -v "http://api.aspose.cloud/v3.0/cells/Sample_Test_Book.xls/worksheets/Sheet5/charts/0/legend" \
-X PUT \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"

Response

{
  "Code": 200,
  "Status": "OK"
}

The API can return the following HTTP status codes:

200 OK – The legend was displayed successfully.
400 Bad Request – Invalid parameters.
401 Unauthorized – Authentication failed.
404 Not Found – The specified workbook, worksheet, or chart does not exist.
500 Internal Server Error – An unexpected server error occurred.

Cloud SDK Family

Using an SDK is the best way to speed up development. An SDK handles low‑level details and lets you focus on your project tasks. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to make calls to Aspose.Cells web services using various SDKs:

Get Chart Legend from a Worksheet Hide Chart Legend in an Excel Worksheet – Aspose.Cells Cloud API