Class Group

گروه

دسترسی و اصلاح گروه های صفحه گسترده گروه‌ها ارتباطی بین فاصله‌ای از ردیف‌ها یا ستون‌های به هم پیوسته هستند که می‌توانند به عنوان یک واحد بزرگ یا جمع شوند تا سطرها یا ستون‌ها را پنهان یا نشان دهند. هر گروه یک کلید کنترلی روی سطر یا ستون مستقیماً قبل یا بعد از گروه (بسته به تنظیمات) دارد که می‌تواند کل گروه را گسترش یا جمع کند.

عمق یک گروه به موقعیت تودرتوی گروه و تعداد گروه های بزرگتر شامل گروه اشاره دارد. حالت فروپاشی یک گروه به این اشاره دارد که آیا گروه باید پس از گسترش یک گروه والد، فروپاشیده باقی بماند یا گسترش یابد. علاوه بر این، در زمانی که یک گروه جمع می‌شود یا گسترش می‌یابد، ردیف‌ها یا ستون‌های درون گروه پنهان یا قابل مشاهده هستند، اگرچه ردیف‌ها یا ستون‌های مجزا را می‌توان بدون توجه به وضعیت جمع‌شده پنهان یا قابل مشاهده کرد.

روش ها

روش نوع برگشت شرح مختصر
collapse() Group این گروه را جمع می کند.
expand() Group این گروه را گسترش می دهد.
get Control Index() Integer نمایه تغییر حالت کنترل این گروه را برمی‌گرداند.
get Depth() Integer عمق این گروه را برمی‌گرداند.
get Range() Range محدوده ای را که این گروه در آن وجود دارد را برمی گرداند.
is Collapsed() Boolean اگر این گروه جمع شود، true برمی‌گردد.
remove() void این گروه را از صفحه حذف می کند و عمق گروه range را یک بار کاهش می دهد.

مستندات دقیق

collapse()

این گروه را جمع می کند. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Collapses this group.
group.collapse();

بازگشت

Group - این گروه، برای زنجیر کردن

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

expand()

این گروه را گسترش می دهد. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Expands this group.
group.expand();

بازگشت

Group - این گروه، برای زنجیر کردن

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Control Index()

نمایه تغییر حالت کنترل این گروه را برمی‌گرداند. هنگامی که کلید کنترل قبل از گروه نشان داده می شود، این شاخص درست قبل از محدوده است، یا در غیر این صورت، ایندکس درست بعد از محدوده است. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlAfter(true);
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Returns 4
const controlIndex = group.getControlIndex();

بازگشت

Integer - شاخص تغییر وضعیت کنترلی این گروه

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Depth()

عمق این گروه را برمی‌گرداند. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Returns 1 if the group is at depth 1.
const depth = group.getDepth();

بازگشت

Integer - عمق این گروه

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Range()

محدوده ای را که این گروه در آن وجود دارد را برمی گرداند. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
let range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(1, 1);

// Returns the range 2:3 if the group is over rows 2:3
range = group.getRange();

بازگشت

Range - محدوده ای که گروه در آن وجود دارد

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

is Collapsed()

اگر این گروه جمع شود، true برمی‌گردد. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Returns true if the group is collapsed.
const isCollapsed = group.isCollapsed();

بازگشت

Boolean - اگر این گروه جمع شود true . در غیر این صورت false برمی گرداند

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

remove()

این گروه را از صفحه حذف می کند و عمق گروه range را یک بار کاهش می دهد. این ممکن است گروه های دیگر را تغییر دهد. پس از فراخوانی این، شی گروه برای استفاده نامعتبر می شود. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
let range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Removes this group
range = group.remove();

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

همچنین ببینید