इस पेज का अनुवाद Cloud Translation API से किया गया है.

Class Filter

इस क्लास का इस्तेमाल करके, Grid शीट पर मौजूद फ़िल्टर में बदलाव करें. यह शीट का डिफ़ॉल्ट टाइप है. ग्रिड शीट, डेटा वाली ऐसी सामान्य शीट होती हैं जो किसी डेटाबेस से कनेक्ट नहीं होती.

अगर शीट में अब तक कोई फ़िल्टर मौजूद नहीं है, तो Range.createFilter() का इस्तेमाल करके एक फ़िल्टर बनाएं.

इस क्लास का इस्तेमाल करने के लिए, आपको पहले Range.getFilter() या Sheet.getFilter() का इस्तेमाल करके ग्रिड शीट के फ़िल्टर को ऐक्सेस करना होगा.

सामान्य इस्तेमाल

फ़िल्टर को हटाने का तरीका

नीचे दिए गए सैंपल में, ऐक्टिव शीट पर फ़िल्टर लगाया गया है और उसे हटा दिया गया है.

let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Removes the filter from the active sheet.
filter.remove();

उस रेंज के नतीजे देखें जिस पर फ़िल्टर लागू होता है

नीचे दिए गए सैंपल में, चालू शीट पर फ़िल्टर मौजूद है. इसके बाद, जिस रेंज पर फ़िल्टर लागू होता है उसे लॉग करने के लिए, इस क्लास के getRange() तरीके का इस्तेमाल करता है.

let ss = SpreadsheetApp.getActiveSheet();
// Gets the existing filter on the active sheet.
let filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

तरीके

तरीका	रिटर्न टाइप	संक्षिप्त विवरण
`getColumnFilterCriteria(columnPosition)`	`FilterCriteria`	तय किए गए कॉलम पर फ़िल्टर की शर्तें दिखाता है. अगर कॉलम पर कोई फ़िल्टर लागू नहीं किया गया है, तो `null`.
`getRange()`	`Range`	उस रेंज पर ले जाता है जिस पर यह फ़िल्टर लागू होता है.
`remove()`	`void`	इस फ़िल्टर को हटा देता है.
`removeColumnFilterCriteria(columnPosition)`	`Filter`	दिए गए कॉलम से फ़िल्टर की शर्तों को हटाता है.
`setColumnFilterCriteria(columnPosition, filterCriteria)`	`Filter`	तय कॉलम पर फ़िल्टर की शर्तें सेट करता है.
`sort(columnPosition, ascending)`	`Filter`	फ़िल्टर की गई रेंज को बताए गए कॉलम के हिसाब से क्रम में लगाता है. इसमें पहली पंक्ति (हेडर पंक्ति) को उस रेंज में शामिल नहीं किया जाता जिस पर यह फ़िल्टर लागू होता है.

ज़्यादा जानकारी के साथ दस्तावेज़

`getColumnFilterCriteria(columnPosition)`

तय किए गए कॉलम पर फ़िल्टर की शर्तें दिखाता है. अगर कॉलम पर कोई फ़िल्टर लागू नहीं किया गया है, तो null.

फ़िल्टर की ज़रूरी शर्तों के बारे में ज़्यादा जानकारी पाने के लिए, इस तरीके को FilterCriteria क्लास के तरीकों से चेन करें.

let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
  // Gets the filter criteria applied to column B of the active sheet
  // and logs the hidden values.
let filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
console.log(filterCriteria);

पैरामीटर

नाम	Type	ब्यौरा
`columnPosition`	`Integer`	कॉलम की 1-इंडेक्स की गई स्थिति. उदाहरण के लिए, कॉलम B का इंडेक्स 2 है.

रिटर्न

FilterCriteria — फ़िल्टर करने की शर्तें.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या ज़्यादा स्कोप से अनुमति देने की ज़रूरत होती है:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getRange()`

उस रेंज पर ले जाता है जिस पर यह फ़िल्टर लागू होता है.

// Gets the existing filter on the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

रिटर्न

Range — फ़िल्टर की रेंज. A1 नोटेशन में रेंज पाने के लिए, इस तरीके को Range.getA1Notation() से जोड़ें.

अनुमति देना

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`remove()`

इस फ़िल्टर को हटा देता है.

// Removes the filter from the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.remove();

अनुमति देना

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`removeColumnFilterCriteria(columnPosition)`

दिए गए कॉलम से फ़िल्टर की शर्तों को हटाता है.

// Removes the filter criteria from column B.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.removeColumnFilterCriteria(2);

पैरामीटर

नाम	Type	ब्यौरा
`columnPosition`	`Integer`	कॉलम की 1-इंडेक्स की गई स्थिति. उदाहरण के लिए, कॉलम B का इंडेक्स 2 है.

रिटर्न

Filter — चेन फ़िल्टर करने के लिए फ़िल्टर.

अनुमति देना

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`setColumnFilterCriteria(columnPosition, filterCriteria)`

तय कॉलम पर फ़िल्टर की शर्तें सेट करता है. सबसे पहले, SpreadsheetApp.newFilterCriteria() का इस्तेमाल करके फ़िल्टर मानदंड बनाएं. इसके बाद, FilterCriteriaBuilder क्लास का इस्तेमाल करके बिल्डर में शर्तें जोड़ें. शर्तें तय करने के बाद, इसे इस तरीके के लिए filterCriteria पैरामीटर के तौर पर सेट करें.

let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Builds the filter criteria to use as a parameter for setColumnFilterCriteria.
const criteria = SpreadsheetApp.newFilterCriteria()
                             .setHiddenValues(["Hello", "World"])
                             .build();
// Sets the filter criteria for column C.
filter.setColumnFilterCriteria(3, criteria);

पैरामीटर

नाम	Type	ब्यौरा
`columnPosition`	`Integer`	कॉलम की 1-इंडेक्स की गई स्थिति. उदाहरण के लिए, कॉलम B का इंडेक्स 2 है.
`filterCriteria`	`FilterCriteria`	सेट करने के लिए फ़िल्टर की शर्तें. अगर शर्त को `null` पर सेट किया जाता है, तो तय किए गए कॉलम से फ़िल्टर हटा दिया जाता है. `removeColumnFilterCriteria(columnPosition)` का भी इस्तेमाल किया जा सकता है.

रिटर्न

Filter — चेन फ़िल्टर करने के लिए फ़िल्टर.

अनुमति देना

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`sort(columnPosition, ascending)`

फ़िल्टर की गई रेंज को बताए गए कॉलम के हिसाब से क्रम में लगाता है. इसमें पहली पंक्ति (हेडर पंक्ति) को उस रेंज में शामिल नहीं किया जाता जिस पर यह फ़िल्टर लागू होता है.

// Gets the existing filter and sorts it by column B in ascending order.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.sort(2, true);

पैरामीटर

नाम	Type	ब्यौरा
`columnPosition`	`Integer`	कॉलम की 1-इंडेक्स की गई स्थिति. उदाहरण के लिए, कॉलम B का इंडेक्स 2 है.
`ascending`	`Boolean`	अगर `true` है, तो फ़िल्टर की गई रेंज को बढ़ते क्रम में लगाया जाता है. अगर `false` है, तो फ़िल्टर की गई रेंज को घटते क्रम में लगाया जाता है.

रिटर्न

Filter — चेन फ़िल्टर करने के लिए फ़िल्टर.

अनुमति देना

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets