Class Filter

फ़िल्टर करें

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

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

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

सामान्य तौर पर क्वेरी की सूची का इस्तेमाल इस तरह किया जाता है

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

नीचे दिए गए उदाहरण में, चालू शीट पर मौजूद फ़िल्टर को पाने और उसे हटाने का तरीका बताया गया है. 
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Removes the filter from the active sheet.
filter.remove();

वह रेंज पाएं जिस पर फ़िल्टर लागू होता है

नीचे दिए गए सैंपल में, ऐक्टिव शीट पर मौजूद फ़िल्टर की जानकारी मिलती है. इसके बाद, यह क्लास से getRange() तरीके का इस्तेमाल करके, उस रेंज को लॉग करती है जिस पर फ़िल्टर लागू होता है. 
const ss = SpreadsheetApp.getActiveSheet();
// Gets the existing filter on the active sheet.
const filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

तरीके

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

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

getColumnFilterCriteria(columnPosition)

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

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

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

पैरामीटर

नामटाइपब्यौरा
columnPositionIntegerकॉलम की इंडेक्स की गई पोज़िशन. उदाहरण के लिए, कॉलम B का इंडेक्स 2 है.

वापसी का टिकट

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

अनुमति देना

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

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

getRange()

इस फ़िल्टर के लिए लागू होने वाली रेंज मिलती है. 

// Gets the existing filter on the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const 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.
const ss = SpreadsheetApp.getActiveSheet();
const 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.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.removeColumnFilterCriteria(2);

पैरामीटर

नामटाइपब्यौरा
columnPositionIntegerकॉलम की इंडेक्स की गई पोज़िशन. उदाहरण के लिए, कॉलम B का इंडेक्स 2 है.

वापसी का टिकट

Filter — यह फ़िल्टर, चेन बनाने के लिए होता है.

अनुमति देना

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

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

setColumnFilterCriteria(columnPosition, filterCriteria)

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

const ss = SpreadsheetApp.getActiveSheet();
const 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);

पैरामीटर

नामटाइपब्यौरा
columnPositionIntegerकॉलम की इंडेक्स की गई पोज़िशन. उदाहरण के लिए, कॉलम B का इंडेक्स 2 है.
filterCriteriaFilterCriteriaफ़िल्टर करने की शर्त सेट करें. अगर आपने मानदंड को 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.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.sort(2, true);

पैरामीटर

नामटाइपब्यौरा
columnPositionIntegerकॉलम की इंडेक्स की गई पोज़िशन. उदाहरण के लिए, कॉलम B का इंडेक्स 2 है.
ascendingBooleanअगर true है, तो फ़िल्टर की गई रेंज को बढ़ते क्रम में लगाता है; अगर false है, तो फ़िल्टर की गई रेंज को घटते क्रम में लगाता है.

वापसी का टिकट

Filter — यह फ़िल्टर, चेन बनाने के लिए होता है.

अनुमति देना

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

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