Add a color filter in an Excel worksheet

This REST API adds a color filter to an Excel worksheet.

REST API

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

The request parameters are:

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).

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.

Request

curl -v "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/autoFilter/colorFilter?range=A1%3AB1&fieldIndex=0" \
-X PUT \
-d "{ \"Pattern\": \"Solid\", \"ForegroundColor\": { \"Color\": { \"A\": 255, \"R\": 0, \"G\": 255, \"B\": 255 }, \"ColorIndex\": 0, \"IsShapeColor\": true, \"ThemeColor\": { \"ColorType\": \"Text2\", \"Tint\": 1 }, \"Type\": \"Automatic\" }, \"BackgroundColor\": { \"Color\": { \"A\": 255, \"R\": 0, \"G\": 255, \"B\": 255 }, \"ColorIndex\": 0, \"IsShapeColor\": true, \"ThemeColor\": { \"ColorType\": \"Text2\", \"Tint\": 0 }, \"Type\": \"Automatic\" }}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"

Response

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

Cloud SDK Family

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:

Add a filter in an Excel worksheet Delete a Date Filter