Class FilterCriteria

फ़िल्टरशर्तें

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

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

शर्तें कॉपी करना

नीचे दिए गए सैंपल में, रेंज A1:C20 पर लागू होने वाला फ़िल्टर मिलता है. साथ ही, कॉलम C पर लागू की गई शर्तें मिलती हैं और कॉलम B में शर्तें कॉपी की जाती हैं. 
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Copies the filter criteria applied to column C.
const filter = range.getFilter();
const criteria = filter.getColumnFilterCriteria(3).copy().build();
// Applies the copied criteria to column B. The copied criteria overwrites any
// existing criteria on column B.
filter.setColumnFilterCriteria(2, criteria);

फ़िल्टर की वजह से छिपी हुई वैल्यू पाना

यहां दिए गए सैंपल में, दी गई रेंज पर लागू होने वाला फ़िल्टर मिलता है. साथ ही, कॉलम B की उन वैल्यू को लॉग किया जाता है जिन्हें फ़िल्टर छिपा देता है. 
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
const filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
// Logs the hidden values.
console.log(filterCriteria);

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
copy()FilterCriteriaBuilderयह फ़िल्टर की शर्तों को कॉपी करता है और एक शर्त बिल्डर बनाता है. इस शर्त बिल्डर को किसी दूसरे फ़िल्टर पर लागू किया जा सकता है.
getCriteriaType()BooleanCriteriaशर्त का बूलियन टाइप दिखाता है, जैसे कि CELL_EMPTY.
getCriteriaValues()Object[]बूलियन शर्तों के लिए, आर्ग्युमेंट का ऐरे दिखाता है.
getHiddenValues()String[]फ़िल्टर की गई वैल्यू दिखाता है.
getVisibleBackgroundColor()Colorफ़िल्टर की शर्त के तौर पर इस्तेमाल किए गए बैकग्राउंड का रंग दिखाता है.
getVisibleForegroundColor()Colorफ़िल्टर की शर्त के तौर पर इस्तेमाल किया गया फ़ोरग्राउंड कलर दिखाता है.
getVisibleValues()String[]पिवट टेबल फ़िल्टर से दिखने वाली वैल्यू दिखाता है.

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

copy()

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

इस तरीके का इस्तेमाल, किसी भी तरह के फ़िल्टर के साथ किया जा सकता है. अगर शीट फ़िल्टर का इस्तेमाल किया जा रहा है, तो शर्तों को किसी दूसरे कॉलम में कॉपी किया जा सकता है. 

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Makes a copy of the filter criteria applied to column C.
const criteria = filter.getColumnFilterCriteria(3).copy().build();
// Applies the copied criteria to column B. The copied criteria overwrites any
// existing criteria on column B.
filter.setColumnFilterCriteria(2, criteria);

वापसी का टिकट

FilterCriteriaBuilder — फ़िल्टर करने की इस शर्त के आधार पर, फ़िल्टर करने की शर्त बनाने वाला टूल.

getCriteriaType()

शर्त का बूलियन टाइप दिखाता है, जैसे कि CELL_EMPTY. बूलियन शर्तों के टाइप के बारे में जानने के लिए, BooleanCriteria enum देखें.

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

  • शर्तों के लिए आर्ग्युमेंट पाने के लिए, getCriteriaValues() का इस्तेमाल करें.
  • फ़िल्टर की शर्तें बनाने या उनमें बदलाव करने के लिए, शर्तों के टाइप और शर्तों की वैल्यू का इस्तेमाल करने के बारे में जानने के लिए, FilterCriteriaBuilder.withCriteria(criteria, args) देखें.

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

const ss = SpreadsheetApp.getActiveSheet();
// Gets the filter on the active sheet.
const filter = ss.getFilter();
// Gets the criteria type and returns a string representing the criteria type
// object.
const criteriaType =
    filter.getColumnFilterCriteria(2).getCriteriaType().toString();
// Logs the criteria type.
console.log(criteriaType);

वापसी का टिकट

BooleanCriteria — बूलियन शर्त का टाइप या null, अगर शर्त बूलियन शर्त नहीं है.

getCriteriaValues()

बूलियन शर्तों के लिए, आर्ग्युमेंट का ऐरे दिखाता है. कुछ बूलियन शर्तों के टाइप में आर्ग्युमेंट नहीं होते और वे खाली कलेक्शन दिखाते हैं. उदाहरण के लिए, CELL_NOT_EMPTY.

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

  • बुलियन शर्त का टाइप पाने के लिए, getCriteriaType() का इस्तेमाल करें.
  • फ़िल्टर की शर्त बनाने या उसमें बदलाव करने के लिए, शर्त के टाइप और शर्त की वैल्यू का इस्तेमाल करने के बारे में जानने के लिए, FilterCriteriaBuilder.withCriteria(criteria, args) देखें.

    इस तरीके का इस्तेमाल, किसी भी तरह के फ़िल्टर के लिए किया जा सकता है. 

    const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Gets the values of the boolean criteria and logs them. For example, if the
// boolean condition is whenNumberGreaterThan(10), then the logged value is 10.
const criteriaValues = filter.getColumnFilterCriteria(2).getCriteriaValues();
console.log(criteriaValues);

    वापसी का टिकट

    Object[] — बूलियन शर्त के टाइप के हिसाब से आर्ग्युमेंट का कलेक्शन. ऑर्ग्युमेंट की संख्या और उनका टाइप, FilterCriteriaBuilder क्लास के when...() तरीके से मेल खाता हो.

getHiddenValues()

फ़िल्टर की गई वैल्यू दिखाता है.

इस शर्त का इस्तेमाल, Grid शीट पर फ़िल्टर के साथ करें. यह शीट का डिफ़ॉल्ट टाइप है. अगर इस तरीके को दूसरे तरह के फ़िल्टर के लिए कॉल किया जाता है, तो यह null दिखाता है. 

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
const filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
// Logs the hidden values.
console.log(filterCriteria);

वापसी का टिकट

String[] — वैल्यू का एक कलेक्शन, जिसे फ़िल्टर छिपा देता है.

getVisibleBackgroundColor()

फ़िल्टर की शर्त के तौर पर इस्तेमाल किए गए बैकग्राउंड का रंग दिखाता है. इस बैकग्राउंड रंग वाली सेल दिखती रहेंगी.

इस शर्त का इस्तेमाल, Grid शीट पर फ़िल्टर के साथ करें. यह शीट का डिफ़ॉल्ट टाइप है. अगर इस तरीके को दूसरे तरह के फ़िल्टर के लिए कॉल किया जाता है, तो यह null दिखाता है. 

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Logs the background color that column B is filtered by as a hexadecimal
// string.
const filter = range.getFilter();
const color = filter.getColumnFilterCriteria(2)
                  .getVisibleBackgroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

वापसी का टिकट

Color — फ़िल्टर की शर्त के तौर पर इस्तेमाल किया जाने वाला बैकग्राउंड कलर.

getVisibleForegroundColor()

फ़िल्टर की शर्त के तौर पर इस्तेमाल किया गया फ़ोरग्राउंड कलर दिखाता है. इस फ़ोरग्राउंड रंग वाली सेल दिखती रहेंगी.

इस शर्त का इस्तेमाल, Grid शीट पर फ़िल्टर के साथ करें. यह शीट का डिफ़ॉल्ट टाइप है. अगर इस तरीके को दूसरे तरह के फ़िल्टर के लिए कॉल किया जाता है, तो यह null दिखाता है. 

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Logs the foreground color that column B is filtered by as a hexadecimal
// string.
const filter = range.getFilter();
const color = filter.getColumnFilterCriteria(2)
                  .getVisibleForegroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

वापसी का टिकट

Color — फ़िल्टर की शर्त के तौर पर इस्तेमाल किया जाने वाला फ़ोरग्राउंड रंग.

getVisibleValues()

पिवट टेबल फ़िल्टर से दिखने वाली वैल्यू दिखाता है.

यह शर्त सिर्फ़ उन पिवट टेबल के फ़िल्टर के लिए है जो किसी डेटाबेस से कनेक्ट नहीं हैं. अन्य टाइप के फ़िल्टर के लिए, खाली कलेक्शन दिखाता है. 

const ss = SpreadsheetApp.getActiveSheet();
// Gets the first pivot table on the sheet, then gets the visible values of its
// first filter.
const pivotTable = ss.getPivotTables()[0];
const pivotFilterValues =
    pivotTable.getFilters()[0].getFilterCriteria().getVisibleValues();
// Logs the visible values.
console.log(pivotFilterValues);

वापसी का टिकट

String[] — वैल्यू का एक कलेक्शन, जो पिवट टेबल फ़िल्टर दिखाता है.