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 दिखाता है.
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);

पैरामीटर

नाम	टाइप	ब्यौरा
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.
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);

पैरामीटर

नाम	टाइप	ब्यौरा
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 पैरामीटर के तौर पर सेट करें.

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

पैरामीटर

नाम	टाइप	ब्यौरा
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.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.sort(2, true);

पैरामीटर

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

वापसी का टिकट

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

अनुमति देना

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

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