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

getControlIndex()

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

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

getDepth()

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

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

getRange()

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

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

isCollapsed()

اگر این گروه از هم پاشیده شود، 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

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