Set background on an Excel worksheet

This REST API adds a background image to a worksheet.

Prerequisite: The workbook must already exist in Aspose Cloud storage, and you need a valid JWT access token. Obtain a token through the OAuth2 /connect/token endpoint (see the authentication guide).

REST API

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

The request parameters are:

Parameter name	Type	Location	Description
name	string	path	Name of the Excel workbook.
sheetName	string	path	Name of the worksheet to which the image is applied.
imageFile	file	body	Binary image file (PNG, JPEG, BMP, etc.) to set as background.
folder	string	query	Folder in storage where the workbook is located.
storageName	string	query	Name of the Aspose Cloud storage.

Supported formats & limits

Accepted image extensions: PNG, JPEG, BMP, GIF.
Maximum file size: 5 MB.
The image is tiled to fill the entire worksheet background.

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

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

Request

curl -v "https://api.aspose.cloud/v3.0/cells/myWorkbook.xlsx/worksheets/Sheet1/background" \
  -X PUT \
  -F "imageFile=@Creative.jpg" \
  -H "Content-Type: multipart/form-data" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

Response

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

Possible error responses

HTTP Code	Description
400	Bad request – missing or invalid parameters.
401	Unauthorized – invalid or expired JWT token.
404	Not found – workbook or worksheet does not exist.
500	Internal server error – unexpected condition on the server.

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 call Aspose.Cells web services using various SDKs:

Delete background on an Excel worksheet