Add a Color Filter in an Excel Worksheet using Aspose.Cells Cloud API
REST API
This REST API adds a color filter to an Excel worksheet.
PUT https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/autoFilter/colorFilter
Security and Authentication
The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.
Request Parameters:
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| name | string | path | The name of the Excel file. |
| sheetName | string | path | The name of the worksheet that contains the data to be filtered. |
| range | string | query | The cell range to which the filter is applied (e.g., A1:B10). |
| fieldIndex | integer | query | Zero‑based index of the column on which the color filter is applied. |
| colorFilter | object | body | JSON object that defines the foreground and background colors to filter. |
| matchBlanks | boolean | query | Whether rows with blank cells should be included in the filter results. |
| refresh | boolean | query | If true, the worksheet is refreshed after applying the filter. |
| folder | string | query | The folder in storage where the Excel file is located. |
| storageName | string | query | The name of the storage service (e.g., Aspose Cloud Storage). |
colorFilter JSON schema
| Property | Type | Description | Required |
|---|---|---|---|
| Pattern | string | Filter pattern (e.g., "Solid"). |
Yes |
| ForegroundColor | object | Defines the foreground color. Contains sub‑properties such as Color, ColorIndex, IsShapeColor, ThemeColor, and Type. |
No |
| BackgroundColor | object | Defines the background color. Same sub‑properties as ForegroundColor. |
No |
Response
{
"Status":"OK",
"Code":200
}
Http Status Codes
| Code | Meaning | Description |
|---|---|---|
| 200 | OK | Compression succeeded; response contains compressed file details. |
| 400 | Bad Request | Missing or invalid parameters (e.g., unsupported file type). |
| 401 | Unauthorized | Invalid or missing JWT token. |
| 413 | Payload Too Large | Uploaded file exceeds size limit. |
| 500 | Internal Server Error | Unexpected server error. |
How to Use the PutWorksheetColorFilter API with SDKs
PutWorksheetColorFilter API Specification
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 calls to the Cloud API with cURL.
Use Aspose.Cells Cloud SDKs
Using an SDK is the best way to speed up development. An SDK abstracts low‑level details so you can 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: