Class FilterCriteria

FilterCriteria

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

सामान्य इस्तेमाल

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

नीचे दिए गए सैंपल में, A1:C20 रेंज पर लागू होने वाला फ़िल्टर शामिल किया गया है. साथ ही, यह कॉलम C पर लागू होने वाली शर्तें लागू करता है और शर्तों को कॉलम B में कॉपी करता है.
let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Copies the filter criteria applied to column C.
let filter = range.getFilter();
let 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 से उन वैल्यू को लॉग करता है जिन्हें फ़िल्टर छिपा देता है.
let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
let 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()

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

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

let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Makes a copy of the filter criteria applied to column C.
let 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 दिखाता है.

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

रिटर्न

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


getCriteriaValues()

बूलियन मानदंड के लिए तर्कों का ऐरे दिखाता है. कुछ बूलियन मानदंड टाइप में तर्क नहीं होते हैं और यह खाली अरे देते हैं, जैसे CELL_NOT_EMPTY.

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

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

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

    let ss = SpreadsheetApp.getActiveSheet();
    let 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.
    let criteriaValues = filter.getColumnFilterCriteria(2).getCriteriaValues();
    console.log(criteriaValues);

    रिटर्न

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


getHiddenValues()

वे वैल्यू दिखाता है जिन्हें फ़िल्टर छिपाता है.

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

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

रिटर्न

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


getVisibleBackgroundColor()

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

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

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

रिटर्न

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


getVisibleForegroundColor()

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

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

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

रिटर्न

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


getVisibleValues()

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

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

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

रिटर्न

String[] — पिवट टेबल फ़िल्टर से मिलने वाली वैल्यू का कलेक्शन.