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

পদ্ধতি

পদ্ধতি রিটার্ন টাইপ সংক্ষিপ্ত বিবরণ
get Column Filter Criteria(columnPosition) Filter Criteria |null নির্দিষ্ট কলামের ফিল্টার শর্তাবলী পাওয়া যায়, অথবা কলামটিতে কোনো ফিল্টার শর্তাবলী প্রয়োগ করা না থাকলে null যায়।
get Range() Range এই ফিল্টারটি যে পরিসরের উপর প্রযোজ্য, তা পাওয়া যায়।
remove() void এই ফিল্টারটি সরিয়ে দেয়।
remove Column Filter Criteria(columnPosition) Filter নির্দিষ্ট কলাম থেকে ফিল্টার শর্তটি মুছে দেয়।
set Column Filter Criteria(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);

প্যারামিটার

নাম প্রকার বর্ণনা
column Position Integer কলামটির ১-সূচক অবস্থান। উদাহরণস্বরূপ, কলাম B-এর সূচক হলো ২।

ফেরত

FilterCriteria |null — ফিল্টারের মানদণ্ড।

অনুমোদন

যে স্ক্রিপ্টগুলো এই পদ্ধতি ব্যবহার করে, সেগুলোর জন্য নিম্নলিখিত এক বা একাধিক স্কোপের মাধ্যমে অনুমোদনের প্রয়োজন হয়:

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

প্যারামিটার

নাম প্রকার বর্ণনা
column Position Integer কলামটির ১-সূচক অবস্থান। উদাহরণস্বরূপ, কলাম B-এর সূচক হলো ২।

ফেরত

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

প্যারামিটার

নাম প্রকার বর্ণনা
column Position Integer কলামটির ১-সূচক অবস্থান। উদাহরণস্বরূপ, কলাম B-এর সূচক হলো ২।
filter Criteria Filter Criteria যে ফিল্টার ক্রাইটেরিয়া সেট করতে হবে। যদি আপনি ক্রাইটেরিয়াটি null সেট করেন, তাহলে এটি নির্দিষ্ট কলাম থেকে ফিল্টার ক্রাইটেরিয়া সরিয়ে দেবে। আপনি remove Column Filter Criteria(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);

প্যারামিটার

নাম প্রকার বর্ণনা
column Position Integer কলামটির ১-সূচক অবস্থান। উদাহরণস্বরূপ, কলাম B-এর সূচক হলো ২।
ascending Boolean যদি true , তাহলে ফিল্টার করা পরিসরটি আরোহী ক্রমে সাজানো হয়; যদি false , তাহলে ফিল্টার করা পরিসরটি অবরোহী ক্রমে সাজানো হয়।

ফেরত

Filter — চেইনিং-এর জন্য ব্যবহৃত ফিল্টার।

অনুমোদন

যে স্ক্রিপ্টগুলো এই পদ্ধতি ব্যবহার করে, সেগুলোর জন্য নিম্নলিখিত এক বা একাধিক স্কোপের মাধ্যমে অনুমোদনের প্রয়োজন হয়:

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