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|nullयह मानदंड के बूलियन टाइप को दिखाता है. उदाहरण के लिए, CELL_EMPTY.
getCriteriaValues()Object[]यह फ़ंक्शन, बूलियन शर्तों के लिए आर्ग्युमेंट की एक सरणी दिखाता है.
getHiddenValues()String[]यह फ़ंक्शन, उन वैल्यू को दिखाता है जिन्हें फ़िल्टर छिपा देता है.
getVisibleBackgroundColor()Color|nullयह फ़िल्टर के मानदंड के तौर पर इस्तेमाल किए गए बैकग्राउंड के रंग को दिखाता है.
getVisibleForegroundColor()Color|nullयह फ़ंक्शन, फ़िल्टर करने की शर्त के तौर पर इस्तेमाल किए गए फ़ोरग्राउंड कलर को दिखाता है.
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 — बूलियन मानदंड का टाइप या 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|null — फ़िल्टर के मानदंड के तौर पर इस्तेमाल किया गया बैकग्राउंड कलर.

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|null — फ़ोरग्राउंड कलर, जिसका इस्तेमाल फ़िल्टर के तौर पर किया जाता है.

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[] — वैल्यू का ऐसा कलेक्शन जिसे पिवट टेबल फ़िल्टर दिखाता है.