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

पैरामीटर

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

पैरामीटर

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

पैरामीटर

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

पैरामीटर

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

वापसी का टिकट

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

अनुमति देना

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

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