Class NamedRange
Stay organized with collections
Save and categorize content based on your preferences.
AI-generated Key Takeaways
-
Named ranges provide string aliases for cell ranges within a spreadsheet, enhancing readability and simplifying formulas.
-
You can manage named ranges through the Sheets UI under "Data > Named ranges..." or programmatically using Apps Script methods.
-
Apps Script offers methods to create, access, modify, and delete named ranges, including
getName(),getRange(),remove(),setName(), andsetRange(). -
These methods enable you to retrieve and update the name and range associated with a named range, as well as delete it entirely.
-
Authorization is required to utilize these methods, necessitating specific scopes like
https://www.googleapis.com/auth/spreadsheets.
Create, access and modify named ranges in a spreadsheet. Named ranges are ranges that have associated string aliases. They can be viewed and edited via the Sheets UI under the Data > Named ranges... menu.
Methods
| Method | Return type | Brief description |
|---|---|---|
get | String | Gets the name of this named range. |
get | Range | Gets the range referenced by this named range. |
remove() | void | Deletes this named range. |
set | Named | Sets/updates the name of the named range. |
set | Named | Sets/updates the range for this named range. |
Detailed documentation
getName()
Gets the name of this named range.
Return
String — the name of this named range
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getRange()
Gets the range referenced by this named range.
Return
Range — the spreadsheet range that is associated with this named range
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
remove()
Deletes this named range.
// The code below deletes all the named ranges in the spreadsheet. constnamedRanges=SpreadsheetApp.getActive().getNamedRanges(); for(leti=0;i < namedRanges.length;i++){ namedRanges[i].remove(); }
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setName(name)
Sets/updates the name of the named range.
// The code below updates the name for the first named range. constnamedRanges=SpreadsheetApp.getActiveSpreadsheet().getNamedRanges(); if(namedRanges.length > 1){ namedRanges[0].setName('UpdatedNamedRange'); }
Parameters
| Name | Type | Description |
|---|---|---|
name | String | The new name of the named range. |
Return
Named — the range whose name was set by the call
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setRange(range)
Sets/updates the range for this named range.
Parameters
| Name | Type | Description |
|---|---|---|
range | Range | The spreadsheet range to associate with this named range. |
Return
Named — the named range for which the spreadsheet range was set
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets