Add a color filter in an Excel worksheet

This REST API indicates to add a color filter on an Excel Worksheet.

RSET API

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

The request parameters are:

Parameter Name	Type	Path/Query String/HTTPBody	Description
name	string	path
sheetName	string	path
range	string	query
fieldIndex	integer	query
colorFilter		body
matchBlanks	boolean	query
refresh	boolean	query
folder	string	query
storageName	string	query	storage name.

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

You can use cURL command-line tool to access Aspose.Cells web services easily. The following example shows how to make calls to 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 the development. An SDK takes care of 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:

	namespace Aspose.Cells.Cloud.SDK.Tests.Api.Example
	{
	using Microsoft.VisualStudio.TestTools.UnitTesting;
	using Aspose.Cells.Cloud.SDK.Request;
	using System.Collections.Generic;
	using Aspose.Cells.Cloud.SDK.Model;
	using Aspose.Cells.Cloud.SDK.Api;
	using System;
	using System.IO;

	[TestClass]
	public class CellsApiExample
	{
	string CellsCloudClientId ="....";//get from https://dashboard.aspose.cloud/#/applications
	string CellsCloudClientSecret="...";//get from https://dashboard.aspose.cloud/#/applications
	private readonly string remoteFolder = "TestData/In";
	string localName = "Book1.xlsx";
	string remoteName = "remote_book1.xlsx";
	string localPath = "D:/TestData/CellsCloud";
	[TestCategory("Cells")]
	[TestMethod]
	public void Example()
	{


	UploadFileRequest uploadFileRequest = new UploadFileRequest();
	System.IO.FileInfo fileInfo = new System.IO.FileInfo(localPath + "/" + localName);
	uploadFileRequest.path = remoteFolder + "/" + remoteName;
	uploadFileRequest.storageName = "";
	uploadFileRequest.UploadFiles = new Dictionary<string, Stream>() { { localName, File.OpenRead(localPath +"/"+ localName) } };
	cellsApi.UploadFile(uploadFileRequest);



	ColorFilterRequest colorFilter = new ColorFilterRequest();
	Color color = new Color();//0, 255, 245, 2
	color.R = 255;
	color.A = 245;
	color.B = 245;
	color.G = 0;

	colorFilter.ForegroundColor = new CellsColor();
	colorFilter.ForegroundColor.Color = color;
	colorFilter.ForegroundColor.ThemeColor = new ThemeColor();
	colorFilter.ForegroundColor.ThemeColor.ColorType = "Text2";
	colorFilter.ForegroundColor.ThemeColor.Tint = 1;
	colorFilter.ForegroundColor.Type = "Automatic";
	colorFilter.BackgroundColor = new CellsColor();
	colorFilter.BackgroundColor.Color = new Color();
	colorFilter.BackgroundColor.Color.A = 255;
	colorFilter.BackgroundColor.Color.R = 255;
	colorFilter.BackgroundColor.Color.B = 0;
	colorFilter.BackgroundColor.Color.G = 0;
	colorFilter.BackgroundColor.ThemeColor = new ThemeColor();
	colorFilter.BackgroundColor.ThemeColor.ColorType = "Text2";
	colorFilter.BackgroundColor.ThemeColor.Tint = 1;
	colorFilter.BackgroundColor.Type = "Automatic";
	colorFilter.Pattern = "Solid";
	PutWorksheetColorFilterRequest request = new PutWorksheetColorFilterRequest
	{
	name = remoteName,
	sheetName = "Sheet1",
	fieldIndex = 0,
	colorFilter = colorFilter,
	matchBlanks = true,
	range = "A1:C10",
	refresh = true,
	folder = remoteFolder
	};
	cellsApi.PutWorksheetColorFilter(request);














	}


	}
	}

view raw Examples-DotNet-CSharp-Worksheet-FilterListUsingColorFilter-1.cs hosted with ❤ by GitHub

PHP

	<?php
	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-php
	require_once('vendor\autoload.php');
	use \Aspose\Cells\Cloud\Api\CellsApi;
	use \Aspose\Cells\Cloud\Request\PutWorksheetColorFilterRequest;

	class FilterData {

	public $instance;

	public function __construct() {
	$this->instance = new CellsApi(getenv("CellsCloudClientId"),getenv("CellsCloudClientSecret"),"v3.0",getenv("CellsCloudApiBaseUrl"));
	}

	public function putWorksheetColorFilter() {
	$remoteFolder = "TestData/In";

	$localName = "Book1.xlsx";
	$remoteName = "Book1.xlsx";

	$colorFilterForegroundColorColor = new \Aspose\Cells\Cloud\Model\Color();
	$colorFilterForegroundColorColor->setR(48 );
	$colorFilterForegroundColorColor->setG(48 );
	$colorFilterForegroundColorColor->setB(48 );
	$colorFilterForegroundColor = new \Aspose\Cells\Cloud\Model\CellsColor();
	$colorFilterForegroundColor->setType("Automatic" );
	$colorFilterForegroundColor->setColor($colorFilterForegroundColorColor );
	$colorFilter = new \Aspose\Cells\Cloud\Model\ColorFilterRequest();
	$colorFilter->setPattern("Solid" );
	$colorFilter->setForegroundColor($colorFilterForegroundColor );


	$request = new PutWorksheetColorFilterRequest();
	$request->setName( $remoteName);
	$request->setSheetName( "Sheet1");
	$request->setRange( "A1:B1");
	$request->setFieldIndex( 0);
	$request->setColorFilter( $colorFilter);
	$request->setMatchBlanks( 'true');
	$request->setRefresh( 'true');
	$request->setFolder( $remoteFolder);
	$request->setStorageName( "");
	$this->instance->putWorksheetColorFilter($request);
	}
	}

	$instance = new FilterData();
	$instance->putWorksheetColorFilter();

	?>

view raw Examples-PHP-AutoFilter-PutWorksheetColorFilter-.php hosted with ❤ by GitHub

Ruby

	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-ruby
	require 'aspose_cells_cloud'

	class Cell

	include AsposeCellsCloud


	def initialize
	#Get client_id and client_secret from https://cloud.aspose.com

	@instance = AsposeCellsCloud::CellsApi.new($client_id,$client_secret,$api_version,$baseurl)
	end

	# Clear cells contents.
	def put_worksheet_color_filter
	name = $BOOK1
	sheet_name = $SHEET1
	range = $RANGE
	field_index = 0
	color = AsposeCellsCloud::Color.new({:A=>255,:B=>255,:R=>0,:G=>255})
	themeColor = AsposeCellsCloud::ThemeColor.new({:Tint=>'1.0',:ColorType=>'Text2'})
	foregroundcolor = AsposeCellsCloud::CellsColor.new({:Color=>color,:Type=>'Automatic',:ThemeColor=>themeColor})

	color1 = AsposeCellsCloud::Color.new({:A=>0,:B=>0,:R=>255,:G=>255})
	themeColor1 = AsposeCellsCloud::ThemeColor.new({:Tint=>'1.0',:ColorType=>'Text2'})
	backgroundcolor = AsposeCellsCloud::CellsColor.new({:Color=>color1,:Type=>'Automatic',:ThemeColor=>themeColor1})

	color_filter = AsposeCellsCloud::ColorFilterRequest.new({:ForegroundColor=>foregroundcolor,:Pattern=>'Solid',:BackgroundColor=>backgroundcolor})
	match_blanks = true
	refresh = true
	folder = $TEMPFOLDER
	result = @instance.upload_file( folder+"/"+name, ::File.open(File.expand_path("data/"+name),"r") {\|io\| io.read(io.size) })
	expect(result.uploaded.size).to be > 0
	result = @instance.cells_auto_filter_put_worksheet_color_filter(name, sheet_name, range, field_index, { :color_filter=>color_filter, :match_blanks=>match_blanks, :refresh=>refresh,:folder=>folder})
	expect(result.code).to eql(200)
	end

	end

	cell = Cell.new()
	puts cell.put_worksheet_color_filter

view raw Examples-Ruby-AutoFilter-put_worksheet_color_filter-.rb hosted with ❤ by GitHub

Node.js

	const { CellsApi, UploadFileRequest, CellsAutoFilter_PutWorksheetColorFilterRequest,ColorFilterRequest,Color ,ThemeColor,CellsColor } = require("asposecellscloud");
	const clientId = process.env.CellsCloudClientId;
	const clientSecret = process.env.CellsCloudClientSecret;
	const ApiURL = process.env.CellsCloudApiBaseUrl;
	const fs = require('fs');
	const path = require('path');
	const cellsApi = new CellsApi(clientId, clientSecret,"v3.0",ApiURL);
	const localPath = "D:/aspose-cells-cloud-node/TestData/"

	const filename = "Book1.xlsx";
	const data =fs.createReadStream(path.join(localPath, filename));

	const req = new UploadFileRequest({
	path: "Temp/" + filename,
	file: data
	});
	cellsApi.uploadFile(req)
	.then((result) => {

	const req = new CellsAutoFilter_PutWorksheetColorFilterRequest();
	req.name = filename;
	req.sheetName = "Sheet1";
	req.range = "A1:C10";
	req.fieldIndex = 0;
	req.folder = "Temp";
	const colorFilter = new ColorFilterRequest();
	req.colorFilter = colorFilter;
	const color = new Color();//0, 255, 245, 2
	color.A = 255;
	color.B = 255;
	color.R = 0;
	color.G = 245;
	const themeColor = new ThemeColor();
	themeColor.colorType ='Text2';
	themeColor.tint = 1.0;
	colorFilter.foregroundColor = new CellsColor();
	colorFilter.foregroundColor.color = color;
	colorFilter.foregroundColor.themeColor = themeColor;
	colorFilter.foregroundColor.type ='Automatic';


	const color1 = new Color();//0, 255, 245, 2
	color1.A = 255;
	color1.B = 255;
	color1.R = 0;
	color1.G = 245;
	const themeColor1 = new ThemeColor();
	themeColor1.colorType ='Text2';
	themeColor1.tint = 1.0;
	colorFilter.backgroundColor = new CellsColor();
	colorFilter.backgroundColor.color = color1;
	colorFilter.backgroundColor.themeColor = themeColor1;
	colorFilter.backgroundColor.type ='Automatic';

	colorFilter.pattern = "Solid";
	req.matchBlanks = true;
	req.refresh = true;
	cellsApi.cellsAutoFilterPutWorksheetColorFilter(req)
	.then((result) => {
	console.log("successful")

	}).catch((error) => {
	console.error('Unhandled Promise Rejection:', error);
	})
	})

view raw Examples-Node.js-SDK-Worksheet-FilterListUsingColorFilter-1.js hosted with ❤ by GitHub

Perl

	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-perl/
	use strict;
	use warnings;
	use utf8;
	use File::Slurp;
	use MIME::Base64;
	use AsposeCellsCloud::CellsApi;
	my $config = AsposeCellsCloud::Configuration->new( client_id => $ENV{'ProductClientId'}, client_secret => $ENV{'ProductClientSecret'});
	my $instance = AsposeCellsCloud::CellsApi->new(AsposeCellsCloud::ApiClient->new( $config));

	my $remoteFolder = 'TestData/In';
	my $remoteName = 'Book1.xlsx';
	my $color_filter_foreground_color_color = AsposeCellsCloud::Object::Color->new();
	$color_filter_foreground_color_color->{r} = 48 ;
	$color_filter_foreground_color_color->{g} = 48 ;
	$color_filter_foreground_color_color->{b} = 48 ;
	my $color_filter_foreground_color = AsposeCellsCloud::Object::CellsColor->new();
	$color_filter_foreground_color->{type} = 'Automatic' ;
	$color_filter_foreground_color->{color} = $color_filter_foreground_color_color ;
	my $color_filter = AsposeCellsCloud::Object::ColorFilterRequest->new();
	$color_filter->{pattern} = 'Solid' ;
	$color_filter->{foreground_color} = $color_filter_foreground_color ;

	my $request = AsposeCellsCloud::Request::PutWorksheetColorFilterRequest->new();
	$request->{name} = $remoteName;
	$request->{sheet_name} = 'Sheet1';
	$request->{range} = 'A1:B1';
	$request->{field_index} = 0;
	$request->{color_filter} = $color_filter;
	$request->{match_blanks} = 'true';
	$request->{refresh} = 'true';
	$request->{folder} = $remoteFolder;
	$request->{storage_name} = '';
	my $result = $api->put_worksheet_color_filter(request=> $request);

view raw Examples-Perl-Worksheet-FilterListUsingColorFilter-1.pl hosted with ❤ by GitHub

Add a filter in an Excel worksheet Delete a Date Filter