Activates this sheet. Does not alter the sheet itself, only the parent's notion of the activesheet.

// This example assumes there is a sheet named "first"constss=SpreadsheetApp.getActiveSpreadsheet();constfirst=ss.getSheetByName('first');first.activate();

Return

Sheet — The newly active sheet.

Adds developer metadata with the specified key to the sheet.

// Opens the spreadsheet file by its URL. If you created your script from within// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()// instead.// TODO(developer): Replace the URL with your own.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets a sheet by its name.constsheet=ss.getSheetByName('Sheet1');// Adds the key 'NAME' to the developer metadata for the sheet.sheet.addDeveloperMetadata('NAME');// Gets the updated metadata info and logs it to the console.console.log(sheet.getDeveloperMetadata()[0].getKey());

Parameters

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Adds developer metadata with the specified key and visibility to the sheet.

// Opens the spreadsheet file by its URL. If you created your script from within// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()// instead.// TODO(developer): Replace the URL with your own.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets a sheet by its name.constsheet=ss.getSheetByName('Sheet1');// Adds the key 'NAME' and sets the developer metadata visibility to PROJECT// for the sheet.sheet.addDeveloperMetadata('NAME',SpreadsheetApp.DeveloperMetadataVisibility.PROJECT,);// Gets the updated metadata info and logs it to the console.constdeveloperMetaData=sheet.getDeveloperMetadata()[0];console.log(developerMetaData.getKey());console.log(developerMetaData.getVisibility().toString());

Parameters

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Adds developer metadata with the specified key and value to the sheet.

// Opens the spreadsheet file by its URL. If you created your script from within// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()// instead.// TODO(developer): Replace the URL with your own.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets a sheet by its name.constsheet=ss.getSheetByName('Sheet1');// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for// the sheet.sheet.addDeveloperMetadata('COMPANY','TECH');// Gets the updated metadata info and logs it to the console.constdeveloperMetaData=sheet.getDeveloperMetadata()[0];console.log(developerMetaData.getKey());console.log(developerMetaData.getValue());

Parameters

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Adds developer metadata with the specified key, value, and visibility to the sheet.

// Opens the spreadsheet file by its URL. If you created your script from within// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()// instead.// TODO(developer): Replace the URL with your own.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets a sheet by its name.constsheet=ss.getSheetByName('Sheet1');// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and// sets the visibility to DOCUMENT for the sheet.sheet.addDeveloperMetadata('COMPANY','TECH',SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT,);// Gets the updated metadata info and logs it to the console.constdeveloperMetaData=sheet.getDeveloperMetadata()[0];console.log(developerMetaData.getKey());console.log(developerMetaData.getValue());console.log(developerMetaData.getVisibility().toString());

Parameters

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Appends a row to the bottom of the current data region in the sheet. If a cell's content beginswith=, it's interpreted as a formula.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Appends a new row with 3 columns to the bottom of the current// data region in the sheet containing the values in the array.sheet.appendRow(['a man','a plan','panama']);

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the sheet as aDataSourceSheet if the sheet is of typeSheetType.DATASOURCE, ornull otherwise.

// Opens the spreadsheet file by its URL. If you created your script from within// a Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet()// instead.// TODO(developer): Replace the URL with your own.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets a sheet by its name.constsheet=ss.getSheetByName('Sheet1');// Gets the data source sheet value if the sheet is of type// SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value.constdataSourceSheet=sheet.asDataSourceSheet();// Gets the data source sheet value and logs it to the console.console.log(dataSourceSheet);console.log(sheet.getType().toString());

Return

DataSourceSheet|null — A data source sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the width of the given column to fit its contents.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...');// Sets the first column to a width which fits the textsheet.autoResizeColumn(1);

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the width of all columns starting at the given column position to fit their contents.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Sets the first 15 columns to a width that fits their text.sheet.autoResizeColumns(1,15);

Parameters

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the height of all rows starting at the given row position to fit their contents.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Sets the first 15 rows to a height that fits their text.sheet.autoResizeRows(1,15);

Parameters

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Clears the sheet of content and formatting information.

// This example assumes there is a sheet named "first"constss=SpreadsheetApp.getActiveSpreadsheet();constfirst=ss.getSheetByName('first');first.clear();

Return

Sheet — The cleared sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Clears the sheet of contents and/or format, as specified with the given advanced options.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];sheet.clear({formatOnly:true,contentsOnly:true});

Parameters

Advanced parameters

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Removes all conditional format rules from the sheet. Equivalent to callingsetConditionalFormatRules(rules) with an empty array as input.

constsheet=SpreadsheetApp.getActiveSheet();sheet.clearConditionalFormatRules();

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Clears the sheet of contents, while preserving formatting information.

// This example assumes there is a sheet named "first"constss=SpreadsheetApp.getActiveSpreadsheet();constfirst=ss.getSheetByName('first');first.clearContents();

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Clears the sheet of formatting, while preserving contents.

Formatting refers to how data is formatted as allowed by choices under the "Format" menu(ex: bold, italics, conditional formatting) and not width or height of cells.

// This example assumes there is a sheet named "first"constss=SpreadsheetApp.getActiveSpreadsheet();constfirst=ss.getSheetByName('first');first.clearFormats();

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Clears the sheet of all notes.

// This example assumes there is a sheet named "first"constss=SpreadsheetApp.getActiveSpreadsheet();constfirst=ss.getSheetByName('first');first.clearNotes();

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Collapses all column groups on the sheet.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];// All column groups on the sheet are collapsed.sheet.collapseAllColumnGroups();

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Collapses all row groups on the sheet.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];// All row groups on the sheet are collapsed.sheet.collapseAllRowGroups();

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Copies the sheet to a given spreadsheet, which can be the same spreadsheet as the source. Thecopied sheet is named "Copy of [original name]".

constsource=SpreadsheetApp.getActiveSpreadsheet();constsheet=source.getSheets()[0];constdestination=SpreadsheetApp.openById('ID_GOES HERE');sheet.copyTo(destination);

Parameters

Return

Sheet — The new sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns aDeveloperMetadataFinder for finding developer metadata within the scope ofthis sheet. Metadata is in the scope of a particular sheet if it is either associated with thesheet itself, or associated with a row, column, or range on that sheet.

// Opens the spreadsheet file by its URL. If you created your script from within// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()// instead.// TODO(developer): Replace the URL with your own.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets a sheet by its name.constsheet=ss.getSheetByName('Sheet1');// Adds developer metadata for testing.sheet.addDeveloperMetadata('CITY','PARIS');// Creates the developer metadata finder.constmetadatafinder=sheet.createDeveloperMetadataFinder();// Finds the metadata with value 'PARIS' and displays its key in the console.console.log(metadatafinder.withValue('PARIS').find()[0].getKey());

Return

DeveloperMetadataFinder — A developer metadata finder to search for metadata in the scope of this sheet.

Creates a text finder for the sheet, which can find and replace text within the sheet.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];// Creates  a text finder.consttextFinder=sheet.createTextFinder('dog');// Returns the first occurrence of 'dog' in the sheet.constfirstOccurrence=textFinder.findNext();// Replaces the last found occurrence of 'dog' with 'cat' and returns the number// of occurrences replaced.constnumOccurrencesReplaced=firstOccurrence.replaceWith('cat');

Parameters

Return

TextFinder — TheTextFinder for the sheet.

Deletes the column at the given column position.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Columns start at "1" - this deletes the first columnsheet.deleteColumn(1);

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Deletes a number of columns starting at the given column position.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Columns start at "1" - this deletes the first two columnssheet.deleteColumns(1,2);

Parameters

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Deletes the row at the given row position.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Rows start at "1" - this deletes the first rowsheet.deleteRow(1);

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Deletes a number of rows starting at the given row position.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Rows start at "1" - this deletes the first two rowssheet.deleteRows(1,2);

Parameters

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Expands all column groups on the sheet. This method requires at least one column group.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];// All column groups on the sheet are expanded.sheet.expandAllColumnGroups();

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Expands all row groups on the sheet. This method requires at least one row group.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];// All row groups on the sheet are expanded.sheet.expandAllRowGroups();

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Expands all column groups up to the given depth, and collapses all others.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];// All column groups of depth 2 and lower are expanded, and groups with depth// 3 and higher are collapsed.sheet.expandColumnGroupsUpToDepth(2);

Parameters

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Expands all row groups up to the given depth, and collapses all others.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];// All row groups of depth 2 and lower are expanded, and groups with depth// 3 and higher are collapsed.sheet.expandRowGroupsUpToDepth(2);

Parameters

Return

Sheet — This sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the active cell in this sheet.

Note: It's preferable to usegetCurrentCell(), which returns the currenthighlighted cell.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Returns the active cellconstcell=sheet.getActiveCell();

Return

Range — The current active cell.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the selected range in the active sheet, ornull if there is no active range. Ifmultiple ranges are selected this method returns only the last selected range.

The term "active range" refers to the range that a user has selected in the active sheet,but in a custom function it refers to the cell being actively recalculated.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();constactiveRange=sheet.getActiveRange();

Return

Range — The active range.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

See also

• setActiveRange(range)

Returns the list of active ranges in the active sheet ornull if there are no activeranges.

If there is a single range selected, this behaves as agetActiveRange() call.

constsheet=SpreadsheetApp.getActiveSheet();// Returns the list of active ranges.constactiveRangeList=sheet.getActiveRangeList();

Return

RangeList|null — The list of active ranges.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

See also

• setActiveRangeList(rangeList)

Returns all the bandings in this sheet.

// Opens the spreadsheet file by its URL. If you created your script from within// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()// instead.// TODO(developer): Replace the URL with your own.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets a sheet by its name.constsheet=ss.getSheetByName('Sheet1');// Gets the banding info for the sheet.constbandings=sheet.getBandings();// Gets info on the bandings' second row color and logs it to the console.for(constbandingofbandings){console.log(banding.getSecondRowColor());}

Return

Banding[] — All the bandings in this sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns an array of charts on this sheet.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constcharts=sheet.getCharts();for(constiincharts){constchart=charts[i];// Do something with the chart}

Return

EmbeddedChart[] — An array of charts.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the column group at the given index and group depth.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];// Returns the group whose control index is at column 2 and has a depth of 1, or// null if the group doesn’t exist.constcolumnGroup=sheet.getColumnGroup(2,1);

Parameters

Return

Group|null — The column group at the control index and depth, or throws an exception if the group doesn’t exist.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns theGroupControlTogglePosition for all column groups on the sheet.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];// GroupControlTogglePosition.AFTER if the column grouping control toggle is// shown after the group.constcolumnGroupControlPosition=sheet.getColumnGroupControlPosition();

Return

GroupControlTogglePosition —true if the column grouping control toggle is shown after the group on this sheet andfalse otherwise.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the group depth of the column at the given index.

The group depth indicates how many groups overlap with the column. This can range betweenzero and eight.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];// 1 if there is a group over columns 1 through 3constgroupDepth=sheet.getColumnGroupDepth(1);

Parameters

Return

Integer — The group depth of the column at the given index.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Gets the width in pixels of the given column.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Columns start at 1Logger.log(sheet.getColumnWidth(1));

Parameters

Return

Integer — Column width in pixels.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Get all conditional format rules in this sheet.

// Logs the conditional format rules in a sheet.construles=SpreadsheetApp.getActiveSheet().getConditionalFormatRules();for(leti=0;i <rules.length;i++){construle=rules[i];Logger.log(rule);}

Return

ConditionalFormatRule[] — An array of all rules in the sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the current cell in the active sheet ornull if there is no current cell. Thecurrent cell is the cell that has focus in the Google Sheets UI, and is highlighted by a darkborder. There is never more than one current cell. When a user selects one or more cell ranges,one of the cells in the selection is the current cell.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();// Returns the current highlighted cell in the one of the active ranges.constcurrentCell=sheet.getCurrentCell();

Return

Range|null — The current cell.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns aRange corresponding to the dimensions in which data is present.

This is functionally equivalent to creating a Range bounded by A1 and(Sheet.getLastColumn(), Sheet.getLastRow()).

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This represents ALL the dataconstrange=sheet.getDataRange();constvalues=range.getValues();// This logs the spreadsheet in CSV format with a trailing commafor(leti=0;i <values.length;i++){letrow='';for(letj=0;j <values[i].length;j++){if(values[i][j]){row=row+values[i][j];}row=`${row},`;}Logger.log(row);}

Return

Range — A range consisting of all the data in the spreadsheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Gets all the data source formulas.

// Opens the spreadsheet by its ID. If you created your script from within a// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().// TODO(developer): Replace the ID with your own.constss=SpreadsheetApp.openById('abc123456');// Gets Sheet1 by its name.constsheet=ss.getSheetByName('Sheet1');// Gets an array of the data source formulas on Sheet1.// To get an array of data source formulas for the entire spreadsheet,// replace 'sheet' with 'ss'.constdataSourceFormulas=sheet.getDataSourceFormulas();// Logs the first data source formula in the array.console.log(dataSourceFormulas[0].getFormula());

Return

DataSourceFormula[] — A list of data source formulas.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Gets all the data source pivot tables.

// Opens the spreadsheet file by its ID. If you created your script from a// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().// TODO(developer): Replace the ID with your own.constss=SpreadsheetApp.openById('abc123456');// Gets Sheet1 by its name.constsheet=ss.getSheetByName('Sheet1');// Gets an array of the data source pivot tables on Sheet1.// To get an array of data source pivot tables for the entire// spreadsheet, replace 'sheet' with 'ss'.constdataSourcePivotTables=sheet.getDataSourcePivotTables();// Logs the last time that the first pivot table in the array was refreshed.console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

Return

DataSourcePivotTable[] — A list of data source pivot tables.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Gets all the data source tables.

// Opens the spreadsheet file by its ID. If you created your script from a// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().// TODO(developer): Replace the ID with your own.constss=SpreadsheetApp.openById('abc123456');// Gets Sheet1 by its name.constsheet=ss.getSheetByName('Sheet1');// Gets an array of data source tables on Sheet1.// To get an array of data source tables for the entire spreadsheet,// replace 'sheet' with 'ss'.constdataSourceTables=sheet.getDataSourceTables();// Logs the last completed data execution time on the first data source table.console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

Return

DataSourceTable[] — A list of data source tables.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Get all developer metadata associated with this sheet.

// Opens the spreadsheet file by its URL. If you created your script from within// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()// instead.// TODO(developer): Replace the URL with your own.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets a sheet by its name.constsheet=ss.getSheetByName('Sheet1');// Adds developer metadata for testing.sheet.addDeveloperMetadata('CITY','PARIS');// Gets all the developer metadata for the sheet.constdeveloperMetaDataList=sheet.getDeveloperMetadata();// Logs the developer metadata to the console.for(constdeveloperMetaDataofdeveloperMetaDataList){console.log(developerMetaData.getKey());}

Return

DeveloperMetadata[] — The developer metadata associated with this sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns an array of drawings on the sheet.

// Opens the spreadsheet file by its URL. If you created your script from within// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()// instead.// TODO(developer): Replace the URL with your own.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets a sheet by its name.constsheet=ss.getSheetByName('Sheet1');// Gets all the drawings from the sheet.constallDrawings=sheet.getDrawings();// Logs the number of drawings present on the sheet.console.log(allDrawings.length);

Return

Drawing[] — The list of drawings on this sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the filter in this sheet, ornull if there is no filter.

// Gets the filter on the active sheet.constss=SpreadsheetApp.getActiveSheet();constfilter=ss.getFilter();

Return

Filter|null — The filter.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the URL for the form that sends its responses to this sheet, ornull if thissheet has no associated form. Throws an exception if the user does not have permission to editthe spreadsheet.

constsheet=SpreadsheetApp.getActiveSheet();consturl=sheet.getFormUrl();

Return

String|null — The URL for the form that places its responses in this sheet, ornull if this sheet doesn't have an associated form.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the number of frozen columns.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];Logger.log('Number of frozen columns: %s',sheet.getFrozenColumns());

Return

Integer — The number of frozen columns.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the number of frozen rows.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];Logger.log('Number of frozen rows: %s',sheet.getFrozenRows());

Return

Integer — The number of frozen rows.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns all over-the-grid images on the sheet.

// Opens the spreadsheet file by its URL. If you created your script from within// a Google Sheets spreadsheet, you can use// SpreadsheetApp.getActiveSpreadsheet() instead.// TODO(developer): Replace the URL with your own.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets Sheet1 by its name.constsheet=ss.getSheetByName('Sheet1');// Gets the over-the-grid images from Sheet1.// To get the over-the-grid images from the entire spreadsheet, use// ss.getImages() instead.constimages=sheet.getImages();// For each image, logs the anchor cell in A1 notation.for(constimageofimages){console.log(image.getAnchorCell().getA1Notation());}

Return

OverGridImage[] — An array of over-the-grid images.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Gets the position of the sheet in its parent spreadsheet. Starts at 1.

constss=SpreadsheetApp.getActiveSpreadsheet();// Note that the JavaScript index is 0, but this logs 1constsheet=ss.getSheets()[0];// ... because spreadsheets are 1-indexedLogger.log(sheet.getIndex());

Return

Integer — The position of the sheet in its parent spreadsheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the position of the last column that has content.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This logs the value in the very last cell of this sheetconstlastRow=sheet.getLastRow();constlastColumn=sheet.getLastColumn();constlastCell=sheet.getRange(lastRow,lastColumn);Logger.log(lastCell.getValue());

Return

Integer — The last column of the sheet that contains content.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the position of the last row that has content.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This logs the value in the very last cell of this sheetconstlastRow=sheet.getLastRow();constlastColumn=sheet.getLastColumn();constlastCell=sheet.getRange(lastRow,lastColumn);Logger.log(lastCell.getValue());

Return

Integer — The last row of the sheet that contains content.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the current number of columns in the sheet, regardless of content.

// This example assumes there is a sheet named "first"constss=SpreadsheetApp.getActiveSpreadsheet();constfirst=ss.getSheetByName('first');Logger.log(first.getMaxColumns());

Return

Integer — The maximum width of the sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the current number of rows in the sheet, regardless of content.

// This example assumes there is a sheet named "first"constss=SpreadsheetApp.getActiveSpreadsheet();constfirst=ss.getSheetByName('first');Logger.log(first.getMaxRows());

Return

Integer — The maximum height of the sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the name of the sheet.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];Logger.log(sheet.getName());

Return

String — The name of the sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Gets all the named ranges in this sheet.

// The code below logs the name of the first named range.constnamedRanges=SpreadsheetApp.getActiveSheet().getNamedRanges();if(namedRanges.length >1){Logger.log(namedRanges[0].getName());}

Return

NamedRange[] — An array of all the named ranges in the sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns theSpreadsheet that contains this sheet.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// parent is identical to ssconstparent=sheet.getParent();

Return

Spreadsheet — The parent spreadsheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns all the pivot tables on this sheet.

// Opens the spreadsheet file by its URL. If you created your script from within// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()// instead.// TODO(developer): Replace the URL with your own.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets a sheet by its name.constsheet=ss.getSheetByName('Sheet1');// Gets all the pivot table info for the sheet.constpivotTables=sheet.getPivotTables();// Logs the pivot tables to the console.for(constpivotTableofpivotTables){console.log(pivotTable.getSourceDataRange().getValues());}

Return

PivotTable[] — The pivot tables on this sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Gets an array of objects representing all protected ranges in the sheet, or a single-elementarray representing the protection on the sheet itself.

// Remove all range protections in the spreadsheet that the user has permission// to edit.constsheet=SpreadsheetApp.getActiveSheet();constprotections=sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);for(leti=0;i <protections.length;i++){constprotection=protections[i];if(protection.canEdit()){protection.remove();}}

// Remove sheet protection from the active sheet, if the user has permission to// edit it.constsheet=SpreadsheetApp.getActiveSheet();constprotection=sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];if(protection?.canEdit()){protection.remove();}

Parameters

Return

Protection[] — An array of objects representing all protected ranges in the sheet, or a single-element array representing the protection on the sheet itself.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the range with the top left cell at the given coordinates.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Passing only two arguments returns a "range" with a single cell.constrange=sheet.getRange(1,1);constvalues=range.getValues();Logger.log(values[0][0]);

Parameters

Return

Range — A range containing only this cell.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the range with the top left cell at the given coordinates, and with the given number ofrows.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// When the "numRows" argument is used, only a single column of data is// returned.constrange=sheet.getRange(1,1,3);constvalues=range.getValues();// Prints 3 values from the first column, starting from row 1.for(constrowinvalues){for(constcolinvalues[row]){Logger.log(values[row][col]);}}

Parameters

Return

Range — A range containing a single column of data with the number of rows specified.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the range with the top left cell at the given coordinates with the given number of rowsand columns.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constrange=sheet.getRange(1,1,3,3);constvalues=range.getValues();// Print values from a 3x3 box.for(constrowinvalues){for(constcolinvalues[row]){Logger.log(values[row][col]);}}

Parameters

Return

Range — A range corresponding to the area specified.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the range as specified in A1 notation or R1C1 notation.

// Get a range A1:D4 on sheet titled "Invoices"constss=SpreadsheetApp.getActiveSpreadsheet();constrange=ss.getRange('Invoices!A1:D4');// Get cell A1 on the first sheetconstsheet=ss.getSheets()[0];constcell=sheet.getRange('A1');

Parameters

Return

Range — The range at the location designated.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns theRangeList collection representing the ranges in the same sheet specifiedby a non-empty list of A1 notations or R1C1 notations.

// Get a list of ranges A1:D4, F1:H4.constsheet=SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();constrangeList=sheet.getRangeList(['A1:D4','F1:H4']);

Parameters

Return

RangeList — The range list at the location designated.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the row group at the given index and group depth.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];// Returns the group whose control index is at row 2 and has a depth of 1, or// null if the group doesn’t exist.constrowGroup=sheet.getRowGroup(2,1);

Parameters

Return

Group|null — The row group at the control index and depth, or throws an exception if the group doesn’t exist.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns theGroupControlTogglePosition for all row groups on the sheet.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];// GroupControlTogglePosition.AFTER if the row grouping control toggle is shown// after the group.constrowGroupControlPosition=sheet.getRowGroupControlPosition();

Return

GroupControlTogglePosition —true if the row grouping control toggle is shown after the group on this sheet andfalse otherwise.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the group depth of the row at the given index.

The group depth indicates how many groups overlap with the row. This can range between zeroand eight.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];// 1 if there is a group over rows 1 through 3constgroupDepth=sheet.getRowGroupDepth(1);

Parameters

Return

Integer — The group depth of the row at the given index.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Gets the height in pixels of the given row.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Rows start at 1Logger.log(sheet.getRowHeight(1));

Parameters

Return

Integer — Row height in pixels.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the currentSelection in the spreadsheet.

constselection=SpreadsheetApp.getActiveSpreadsheet().getSelection();constcurrentCell=selection.getCurrentCell();

Return

Selection — The current selection.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the ID of the sheet represented by this object.

This is an ID for the sheet that is unique to the spreadsheet. The ID is a monotonicallyincreasing integer assigned at sheet creation time that is independent of sheet position. Thisis useful in conjunction with methods such asRange.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) that take agridId parameter rather than aSheet instance.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];Logger.log(sheet.getSheetId());

Return

Integer — An ID for the sheet unique to the spreadsheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the sheet name.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];Logger.log(sheet.getSheetName());

Return

String — The name of the sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the rectangular grid of values for this range starting at the given coordinates. A -1value given as the row or column position is equivalent to getting the very last row or columnthat has data in the sheet.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// The two samples below produce the same outputletvalues=sheet.getSheetValues(1,1,3,3);Logger.log(values);constrange=sheet.getRange(1,1,3,3);values=range.getValues();Logger.log(values);

Parameters

Return

Object[][] — A two-dimensional array of values.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns an array of slicers on the sheet.

// Opens the spreadsheet file by its URL. If you created your script from within// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()// instead.// TODO(developer): Replace the URL with your own.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets a sheet by its name.constsheet=ss.getSheetByName('Sheet1');// Gets all slicers in the spreadsheet.constslicers=sheet.getSlicers();// Logs the slicer titles to the console.for(constslicerofslicers){console.log(slicer.getTitle());}

Return

Slicer[] — The list of slicers on this sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Gets the sheet tab color, ornull if the sheet tab has no color.

// This example assumes there is a sheet named "Sheet1"constss=SpreadsheetApp.getActiveSpreadsheet();constfirst=ss.getSheetByName('Sheet1');constcolor=first.getTabColorObject();

Return

Color|null — The sheet tab color, ornull if the sheet tab has no color.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returns the type of the sheet.

The default type of sheet isSheetType.GRID. A sheet that contains a single embeddedobject such as anEmbeddedChart is anSheetType.OBJECT sheet.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];Logger.log(sheet.getType());

Return

SheetType — The type of the sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Returnstrue if the sheet's gridlines are hidden; otherwise returnsfalse.Gridlines are visible by default.

// Opens the spreadsheet file by its URL. If you created your script from within// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()// instead.// TODO(developer): Replace the URL with your own.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets a sheet by its name.constsheet=ss.getSheetByName('Sheet1');// Checks if the spreadsheet has hidden gridelines and logs the result to the// console.console.log(sheet.hasHiddenGridlines());

Return

Boolean —true if gridlines are hidden;false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Hides the column or columns in the given range.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This hides the first columnletrange=sheet.getRange('A1');sheet.hideColumn(range);// This hides the first 3 columnsrange=sheet.getRange('A:C');sheet.hideColumn(range);

Parameters

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Hides a single column at the given index. Use 1-index for this method.

To hide more than one column using an index, usehideColumns(columnIndex, numColumns).

To hide more than one column using a range, usehideColumn().

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Hides the first columnsheet.hideColumns(1);

Parameters

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Hides one or more consecutive columns starting at the given index. Use 1-index for this method.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Hides the first three columnssheet.hideColumns(1,3);

Parameters

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Hides the rows in the given range.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This hides the first rowconstrange=sheet.getRange('A1');sheet.hideRow(range);

Parameters

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Hides the row at the given index.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Hides the first rowsheet.hideRows(1);

Parameters

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Hides one or more consecutive rows starting at the given index.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Hides the first three rowssheet.hideRows(1,3);

Parameters

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Hides this sheet. Has no effect if the sheet is already hidden. If this method is called on theonly visible sheet, it throws an exception.

constsheet=SpreadsheetApp.getActiveSheet();sheet.hideSheet();

Return

Sheet — The current sheet.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Adds a new chart to this sheet.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This creates a simple bar chart from the first three rows// of the first two columns of the spreadsheetconstchart=sheet.newChart().setChartType(Charts.ChartType.BAR).addRange(sheet.getRange('A1:B4')).setPosition(5,5,0,0).setOption('title','Dynamic Chart').build();sheet.insertChart(chart);

Parameters

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Inserts a column after the given column position.