Class Sheet

Foglio

Accedere e modificare i fogli di lavoro. Le operazioni comuni sono la ridenominazione di un foglio e l'accesso agli oggetti intervallo dal foglio.

Metodi

MetodoTipo restituitoBreve descrizione
activate()SheetAttiva questo foglio.
addDeveloperMetadata(key)SheetAggiunge al foglio i metadati dello sviluppatore con la chiave specificata.
addDeveloperMetadata(key, visibility)SheetAggiunge al foglio i metadati dello sviluppatore con la chiave e la visibilità specificate.
addDeveloperMetadata(key, value)SheetAggiunge al foglio i metadati dello sviluppatore con la chiave e il valore specificati.
addDeveloperMetadata(key, value, visibility)SheetAggiunge al foglio i metadati dello sviluppatore con la chiave, il valore e la visibilità specificati.
appendRow(rowContents)SheetAggiunge una riga alla parte inferiore dell'area dati corrente nel foglio.
asDataSourceSheet()DataSourceSheetRestituisce il foglio come DataSourceSheet se è di tipo SheetType.DATASOURCE o null in caso contrario.
autoResizeColumn(columnPosition)SheetImposta la larghezza della colonna in modo che si adatti ai relativi contenuti.
autoResizeColumns(startColumn, numColumns)SheetImposta la larghezza di tutte le colonne a partire dalla posizione specificata in modo che si adatti ai relativi contenuti.
autoResizeRows(startRow, numRows)SheetImposta l'altezza di tutte le righe a partire dalla posizione specificata in modo che si adatti ai relativi contenuti.
clear()SheetCancella il foglio di contenuti e informazioni sulla formattazione.
clear(options)SheetCancella il sommario e/o il formato, come specificato con le opzioni avanzate fornite.
clearConditionalFormatRules()voidRimuove tutte le regole di formattazione condizionale dal foglio.
clearContents()SheetCancella il foglio di contenuti, conservando le informazioni sulla formattazione.
clearFormats()SheetCancella la formattazione del foglio, conservando i contenuti.
clearNotes()SheetCancella tutte le note dal foglio.
collapseAllColumnGroups()SheetComprimi tutti i gruppi di colonne del foglio.
collapseAllRowGroups()SheetComprimi tutti i gruppi di righe del foglio.
copyTo(spreadsheet)SheetCopia il foglio in un determinato foglio di lavoro, che può essere lo stesso della fonte.
createDeveloperMetadataFinder()DeveloperMetadataFinderRestituisce un DeveloperMetadataFinder per trovare i metadati dello sviluppatore nell'ambito di questo foglio.
createTextFinder(findText)TextFinderCrea un cercatore di testo per il foglio, che può trovare e sostituire il testo all'interno del foglio.
deleteColumn(columnPosition)SheetElimina la colonna nella posizione specificata.
deleteColumns(columnPosition, howMany)voidConsente di eliminare un numero di colonne a partire dalla posizione specificata.
deleteRow(rowPosition)SheetConsente di eliminare la riga nella posizione specificata.
deleteRows(rowPosition, howMany)voidConsente di eliminare un numero di righe a partire dalla posizione specificata.
expandAllColumnGroups()SheetEspande tutti i gruppi di colonne del foglio.
expandAllRowGroups()SheetEspande tutti i gruppi di righe del foglio.
expandColumnGroupsUpToDepth(groupDepth)SheetEspande tutti i gruppi di colonne fino alla profondità specificata e comprime tutti gli altri.
expandRowGroupsUpToDepth(groupDepth)SheetEspande tutti i gruppi di righe fino alla profondità specificata e comprime tutti gli altri.
getActiveCell()RangeRestituisce la cella attiva in questo foglio.
getActiveRange()RangeRestituisce l'intervallo selezionato nel foglio attivo o null se non è presente alcun intervallo attivo.
getActiveRangeList()RangeListRestituisce l'elenco degli intervalli attivi nel foglio attivo o null se non sono presenti intervalli attivi.
getBandings()Banding[]Restituisce tutte le fasce in questo foglio.
getCharts()EmbeddedChart[]Restituisce un array di grafici in questo foglio.
getColumnGroup(columnIndex, groupDepth)GroupRestituisce il gruppo di colonne all'indice e alla profondità del gruppo specificati.
getColumnGroupControlPosition()GroupControlTogglePositionRestituisce il valore GroupControlTogglePosition per tutti i gruppi di colonne del foglio.
getColumnGroupDepth(columnIndex)IntegerRestituisce la profondità del gruppo della colonna all'indice specificato.
getColumnWidth(columnPosition)IntegerRestituisce la larghezza in pixel della colonna specificata.
getConditionalFormatRules()ConditionalFormatRule[]Visualizza tutte le regole di formattazione condizionale in questo foglio.
getCurrentCell()RangeRestituisce la cella corrente nel foglio attivo o null se non esiste una cella corrente.
getDataRange()RangeRestituisce un Range corrispondente alle dimensioni in cui sono presenti i dati.
getDataSourceFormulas()DataSourceFormula[]Recupera tutte le formule dell'origine dati.
getDataSourcePivotTables()DataSourcePivotTable[]Recupera tutte le tabelle pivot dell'origine dati.
getDataSourceTables()DataSourceTable[]Recupera tutte le tabelle dell'origine dati.
getDeveloperMetadata()DeveloperMetadata[]Visualizza tutti i metadati dello sviluppatore associati a questo foglio.
getDrawings()Drawing[]Restituisce un array di disegni nel foglio.
getFilter()FilterRestituisce il filtro in questo foglio o null se non è presente alcun filtro.
getFormUrl()StringRestituisce l'URL del modulo che invia le risposte a questo foglio o null se questo foglio non ha un modulo associato.
getFrozenColumns()IntegerRestituisce il numero di colonne bloccate.
getFrozenRows()IntegerRestituisce il numero di righe bloccate.
getImages()OverGridImage[]Restituisce tutte le immagini fuori griglia nel foglio.
getIndex()IntegerRecupera la posizione del foglio nel foglio di lavoro principale.
getLastColumn()IntegerRestituisce la posizione dell'ultima colonna contenente contenuti.
getLastRow()IntegerRestituisce la posizione dell'ultima riga contenente contenuti.
getMaxColumns()IntegerRestituisce il numero corrente di colonne nel foglio, indipendentemente dai contenuti.
getMaxRows()IntegerRestituisce il numero corrente di righe nel foglio, indipendentemente dai contenuti.
getName()StringRestituisce il nome del foglio.
getNamedRanges()NamedRange[]Recupera tutti gli intervalli denominati in questo foglio.
getParent()SpreadsheetRestituisce il Spreadsheet contenente questo foglio.
getPivotTables()PivotTable[]Restituisce tutte le tabelle pivot in questo foglio.
getProtections(type)Protection[]Restituisce un array di oggetti che rappresentano tutti gli intervalli protetti nel foglio o un array di un solo elemento che rappresenta la protezione sul foglio stesso.
getRange(row, column)RangeRestituisce l'intervallo con la cella in alto a sinistra alle coordinate specificate.
getRange(row, column, numRows)RangeRestituisce l'intervallo con la cella in alto a sinistra alle coordinate specificate e con il numero specificato di righe.
getRange(row, column, numRows, numColumns)RangeRestituisce l'intervallo con la cella in alto a sinistra alle coordinate specificate con il numero specificato di righe e colonne.
getRange(a1Notation)RangeRestituisce l'intervallo specificato nella notazione A1 o R1C1.
getRangeList(a1Notations)RangeListRestituisce la raccolta RangeList che rappresenta gli intervalli nello stesso foglio specificati da un elenco non vuoto di notazioni A1 o R1C1.
getRowGroup(rowIndex, groupDepth)GroupRestituisce il gruppo di righe nell'indice e nella profondità del gruppo specificati.
getRowGroupControlPosition()GroupControlTogglePositionRestituisce il valore GroupControlTogglePosition per tutti i gruppi di righe del foglio.
getRowGroupDepth(rowIndex)IntegerRestituisce la profondità del gruppo della riga nell'indice specificato.
getRowHeight(rowPosition)IntegerRestituisce l'altezza in pixel della riga specificata.
getSelection()SelectionRestituisce il Selection corrente nel foglio di lavoro.
getSheetId()IntegerRestituisce l'ID del foglio rappresentato da questo oggetto.
getSheetName()StringRestituisce il nome del foglio.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Restituisce la griglia rettangolare di valori per questo intervallo a partire dalle coordinate specificate.
getSlicers()Slicer[]Restituisce un array di slicer nel foglio.
getTabColorObject()ColorRestituisce il colore della scheda del foglio o null se la scheda del foglio non ha colore.
getType()SheetTypeRestituisce il tipo di foglio.
hasHiddenGridlines()BooleanRestituisce true se le linee di griglia del foglio sono nascoste; in caso contrario, restituisce false.
hideColumn(column)voidNasconde la colonna o le colonne nell'intervallo specificato.
hideColumns(columnIndex)voidNasconde una singola colonna nell'indice specificato.
hideColumns(columnIndex, numColumns)voidNasconde una o più colonne consecutive a partire dall'indice specificato.
hideRow(row)voidNasconde le righe nell'intervallo specificato.
hideRows(rowIndex)voidNasconde la riga nell'indice specificato.
hideRows(rowIndex, numRows)voidNasconde una o più righe consecutive a partire dall'indice specificato.
hideSheet()SheetNasconde questo foglio.
insertChart(chart)voidAggiunge un nuovo grafico a questo foglio.
insertColumnAfter(afterPosition)SheetInserisce una colonna dopo la posizione della colonna specificata.
insertColumnBefore(beforePosition)SheetInserisce una colonna prima della posizione della colonna specificata.
insertColumns(columnIndex)voidInserisce una colonna vuota in un foglio nella posizione specificata.
insertColumns(columnIndex, numColumns)voidInserisce una o più colonne vuote consecutive in un foglio a partire dalla posizione specificata.
insertColumnsAfter(afterPosition, howMany)SheetInserisce un determinato numero di colonne dopo la posizione della colonna specificata.
insertColumnsBefore(beforePosition, howMany)SheetInserisce un numero di colonne prima della posizione della colonna specificata.
insertImage(blobSource, column, row)OverGridImageInserisce un BlobSource come immagine nel documento in una determinata riga e colonna.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageInserisce un BlobSource come immagine nel documento in una determinata riga e colonna, con un offset in pixel.
insertImage(url, column, row)OverGridImageInserisce un'immagine nel documento in una determinata riga e colonna.
insertImage(url, column, row, offsetX, offsetY)OverGridImageInserisce un'immagine nel documento in una determinata riga e colonna, con uno spostamento in pixel.
insertRowAfter(afterPosition)SheetInserisce una riga dopo la posizione della riga specificata.
insertRowBefore(beforePosition)SheetInserisce una riga prima della posizione della riga specificata.
insertRows(rowIndex)voidInserisce una riga vuota in un foglio nella posizione specificata.
insertRows(rowIndex, numRows)voidInserisce una o più righe vuote consecutive in un foglio a partire dalla posizione specificata.
insertRowsAfter(afterPosition, howMany)SheetInserisce un numero di righe dopo la posizione della riga specificata.
insertRowsBefore(beforePosition, howMany)SheetInserisce un numero di righe prima della posizione della riga specificata.
insertSlicer(range, anchorRowPos, anchorColPos)SlicerAggiunge un nuovo selettore a questo foglio.
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)SlicerAggiunge un nuovo selettore a questo foglio.
isColumnHiddenByUser(columnPosition)BooleanRestituisce se la colonna specificata è nascosta dall'utente.
isRightToLeft()BooleanRestituisce true se il layout del foglio è da destra a sinistra.
isRowHiddenByFilter(rowPosition)BooleanRestituisce se la riga specificata è nascosta da un filtro (non da una visualizzazione filtrata).
isRowHiddenByUser(rowPosition)BooleanRestituisce se la riga specificata è nascosta dall'utente.
isSheetHidden()BooleanRestituisce true se il foglio è attualmente nascosto.
moveColumns(columnSpec, destinationIndex)voidSposta le colonne selezionate dall'intervallo specificato nella posizione indicata da destinationIndex.
moveRows(rowSpec, destinationIndex)voidSposta le righe selezionate dall'intervallo specificato nella posizione indicata da destinationIndex.
newChart()EmbeddedChartBuilderRestituisce un generatore per creare un nuovo grafico per questo foglio.
protect()ProtectionCrea un oggetto che può impedire la modifica del foglio, tranne che per gli utenti che dispongono dell'autorizzazione.
removeChart(chart)voidRimuove un grafico dal foglio principale.
setActiveRange(range)RangeImposta l'intervallo specificato come active range nel foglio attivo, con la cella in alto a sinistra dell'intervallo come current cell.
setActiveRangeList(rangeList)RangeListImposta l'elenco di intervalli specificato come active ranges nel foglio attivo.
setActiveSelection(range)RangeImposta la regione di selezione attiva per questo foglio.
setActiveSelection(a1Notation)RangeImposta la selezione attiva, come specificato nella notazione A1 o R1C1.
setColumnGroupControlPosition(position)SheetImposta la posizione del pulsante di attivazione/disattivazione del controllo del gruppo di colonne nel foglio.
setColumnWidth(columnPosition, width)SheetImposta la larghezza della colonna specificata in pixel.
setColumnWidths(startColumn, numColumns, width)SheetImposta la larghezza delle colonne specificate in pixel.
setConditionalFormatRules(rules)voidSostituisce tutte le regole di formattazione condizionale attualmente esistenti nel foglio con le regole di immissione.
setCurrentCell(cell)RangeImposta la cella specificata come current cell.
setFrozenColumns(columns)voidBlocca il numero specificato di colonne.
setFrozenRows(rows)voidBlocca il numero specificato di righe.
setHiddenGridlines(hideGridlines)SheetNasconde o mostra le linee della griglia del foglio.
setName(name)SheetImposta il nome del foglio.
setRightToLeft(rightToLeft)SheetImposta o annulla l'impostazione del layout del foglio da destra a sinistra.
setRowGroupControlPosition(position)SheetImposta la posizione del pulsante di attivazione/disattivazione del controllo del gruppo di righe nel foglio.
setRowHeight(rowPosition, height)SheetImposta l'altezza della riga in pixel.
setRowHeights(startRow, numRows, height)SheetImposta l'altezza delle righe specificate in pixel.
setRowHeightsForced(startRow, numRows, height)SheetImposta l'altezza delle righe specificate in pixel.
setTabColor(color)SheetImposta il colore della scheda del foglio.
setTabColorObject(color)SheetImposta il colore della scheda del foglio.
showColumns(columnIndex)voidMostra la colonna all'indice specificato.
showColumns(columnIndex, numColumns)voidMostra una o più colonne consecutive a partire dall'indice specificato.
showRows(rowIndex)voidMostra la riga nell'indice specificato.
showRows(rowIndex, numRows)voidMostra una o più righe consecutive a partire dall'indice specificato.
showSheet()SheetRende visibile il foglio.
sort(columnPosition)SheetOrdina un foglio per colonna in ordine crescente.
sort(columnPosition, ascending)SheetOrdina un foglio per colonna.
unhideColumn(column)voidMostra la colonna nell'intervallo specificato.
unhideRow(row)voidMostra la riga nell'intervallo specificato.
updateChart(chart)voidAggiorna il grafico in questo foglio.

Documentazione dettagliata

activate()

Attiva questo foglio. Non modifica il foglio stesso, ma solo la percezione del foglio attivo da parte del foglio principale.

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

Invio

Sheet: il foglio appena attivato.


addDeveloperMetadata(key)

Aggiunge al foglio i metadati dello sviluppatore con la chiave specificata.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = 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());

Parametri

NomeTipoDescrizione
keyStringLa chiave per i nuovi metadati dello sviluppatore.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addDeveloperMetadata(key, visibility)

Aggiunge al foglio i metadati dello sviluppatore con la chiave e la visibilità specificate.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = 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.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getVisibility().toString());

Parametri

NomeTipoDescrizione
keyStringLa chiave per i nuovi metadati dello sviluppatore.
visibilityDeveloperMetadataVisibilityLa visibilità dei nuovi metadati dello sviluppatore.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addDeveloperMetadata(key, value)

Aggiunge al foglio i metadati dello sviluppatore con la chiave e il valore specificati.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = 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.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());

Parametri

NomeTipoDescrizione
keyStringLa chiave per i nuovi metadati dello sviluppatore.
valueStringIl valore per i nuovi metadati dello sviluppatore.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addDeveloperMetadata(key, value, visibility)

Aggiunge al foglio i metadati dello sviluppatore con la chiave, il valore e la visibilità specificati.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = 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.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

Parametri

NomeTipoDescrizione
keyStringLa chiave per i nuovi metadati dello sviluppatore.
valueStringIl valore per i nuovi metadati dello sviluppatore.
visibilityDeveloperMetadataVisibilityLa visibilità dei nuovi metadati dello sviluppatore.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

appendRow(rowContents)

Aggiunge una riga alla parte inferiore dell'area dati corrente nel foglio. Se i contenuti di una cella iniziano con =, vengono interpretati come una formula.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = 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']);

Parametri

NomeTipoDescrizione
rowContentsObject[]Un array di valori da inserire dopo l'ultima riga del foglio.

Invio

Sheet: il foglio, utile per l'accodamento dei metodi.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

asDataSourceSheet()

Restituisce il foglio come DataSourceSheet se è di tipo SheetType.DATASOURCE o null in caso contrario.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the data source sheet value if the sheet is of type
// SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value.
const dataSourceSheet = sheet.asDataSourceSheet();

// Gets the data source sheet value and logs it to the console.
console.log(dataSourceSheet);
console.log(sheet.getType().toString());

Invio

DataSourceSheet: un foglio di origine dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

autoResizeColumn(columnPosition)

Imposta la larghezza della colonna in modo che si adatti ai relativi contenuti.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = 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 text
sheet.autoResizeColumn(1);

Parametri

NomeTipoDescrizione
columnPositionIntegerLa posizione della colonna da ridimensionare.

Invio

Sheet: il foglio, utile per l'accodamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

autoResizeColumns(startColumn, numColumns)

Imposta la larghezza di tutte le colonne a partire dalla posizione specificata in modo che si adatti ai relativi contenuti.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first 15 columns to a width that fits their text.
sheet.autoResizeColumns(1, 15);

Parametri

NomeTipoDescrizione
startColumnIntegerLa colonna iniziale da ridimensionare automaticamente.
numColumnsIntegerIl numero di colonne da ridimensionare automaticamente.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

autoResizeRows(startRow, numRows)

Imposta l'altezza di tutte le righe a partire dalla posizione specificata in modo che si adatti ai relativi contenuti.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first 15 rows to a height that fits their text.
sheet.autoResizeRows(1, 15);

Parametri

NomeTipoDescrizione
startRowIntegerLa riga iniziale da ridimensionare automaticamente.
numRowsIntegerIl numero di righe da ridimensionare automaticamente.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

clear()

Cancella il foglio di contenuti e informazioni sulla formattazione.

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

Invio

Sheet: il foglio vuoto.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

clear(options)

Cancella il sommario e/o il formato, come specificato con le opzioni avanzate fornite.

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

Parametri

NomeTipoDescrizione
optionsObjectUna mappa JavaScript contenente le opzioni avanzate elencate di seguito.

Parametri avanzati

NomeTipoDescrizione
contentsOnlyBooleanSe cancellare i contenuti.
formatOnlyBooleanIndica se cancellare la formattazione.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

clearConditionalFormatRules()

Rimuove tutte le regole di formattazione condizionale dal foglio. Equivalente alla chiamata di setConditionalFormatRules(rules) con un array vuoto come input.

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

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

clearContents()

Cancella il foglio di contenuti, conservando le informazioni sulla formattazione.

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

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

clearFormats()

Cancella la formattazione del foglio, conservando i contenuti.

La formattazione si riferisce al modo in cui i dati vengono formattati come consentito dalle scelte nel menu "Formato" (ad es. grassetto, corsivo, formattazione condizionale) e non alla larghezza o all'altezza delle celle.

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

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

clearNotes()

Cancella tutte le note dal foglio.

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

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

collapseAllColumnGroups()

Comprimi tutti i gruppi di colonne del foglio.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All column groups on the sheet are collapsed.
sheet.collapseAllColumnGroups();

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

collapseAllRowGroups()

Comprimi tutti i gruppi di righe del foglio.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All row groups on the sheet are collapsed.
sheet.collapseAllRowGroups();

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

copyTo(spreadsheet)

Copia il foglio in un determinato foglio di lavoro, che può essere lo stesso della fonte. Il foglio copiato viene denominato "Copia di [nome originale]".

const source = SpreadsheetApp.getActiveSpreadsheet();
const sheet = source.getSheets()[0];

const destination = SpreadsheetApp.openById('ID_GOES HERE');
sheet.copyTo(destination);

Parametri

NomeTipoDescrizione
spreadsheetSpreadsheetIl foglio di lavoro in cui copiare questo foglio, che può essere lo stesso foglio di lavoro di origine.

Invio

Sheet: il nuovo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

createDeveloperMetadataFinder()

Restituisce un DeveloperMetadataFinder per trovare i metadati dello sviluppatore nell'ambito di questo foglio. I metadati rientrano nell'ambito di un determinato foglio se sono associati al foglio stesso o a una riga, una colonna o un intervallo del foglio.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Creates the developer metadata finder.
const metadatafinder = sheet.createDeveloperMetadataFinder();

// Finds the metadata with value 'PARIS' and displays its key in the console.
console.log(metadatafinder.withValue('PARIS').find()[0].getKey());

Invio

DeveloperMetadataFinder: uno strumento per la ricerca dei metadati dello sviluppatore per cercare i metadati nell'ambito di questo foglio.


createTextFinder(findText)

Crea un cercatore di testo per il foglio, che può trovare e sostituire il testo all'interno del foglio.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Creates  a text finder.
const textFinder = sheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the sheet.
const firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
const numOccurrencesReplaced = firstOccurrence.replaceWith('cat');

Parametri

NomeTipoDescrizione
findTextStringIl testo da cercare.

Invio

TextFinder: il TextFinder per il foglio.


deleteColumn(columnPosition)

Elimina la colonna nella posizione specificata.

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

Parametri

NomeTipoDescrizione
columnPositionIntegerLa posizione della colonna, che inizia da 1 per la prima colonna.

Invio

Sheet: il foglio, utile per l'accodamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

deleteColumns(columnPosition, howMany)

Consente di eliminare un numero di colonne a partire dalla posizione specificata.

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

Parametri

NomeTipoDescrizione
columnPositionIntegerLa posizione della prima colonna da eliminare.
howManyIntegerIl numero di colonne da eliminare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

deleteRow(rowPosition)

Consente di eliminare la riga nella posizione specificata.

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

Parametri

NomeTipoDescrizione
rowPositionIntegerLa posizione della riga, che inizia da 1 per la prima riga.

Invio

Sheet: il foglio, utile per l'accodamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

deleteRows(rowPosition, howMany)

Consente di eliminare un numero di righe a partire dalla posizione specificata.

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

Parametri

NomeTipoDescrizione
rowPositionIntegerLa posizione della prima riga da eliminare.
howManyIntegerIl numero di righe da eliminare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

expandAllColumnGroups()

Espande tutti i gruppi di colonne del foglio. Questo metodo richiede almeno un gruppo di colonne.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All column groups on the sheet are expanded.
sheet.expandAllColumnGroups();

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

expandAllRowGroups()

Espande tutti i gruppi di righe del foglio. Questo metodo richiede almeno un gruppo di righe.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All row groups on the sheet are expanded.
sheet.expandAllRowGroups();

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

expandColumnGroupsUpToDepth(groupDepth)

Espande tutti i gruppi di colonne fino alla profondità specificata e comprime tutti gli altri.

const sheet = 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);

Parametri

NomeTipoDescrizione
groupDepthIntegerLa profondità del gruppo fino alla quale espandere i gruppi di colonne.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

expandRowGroupsUpToDepth(groupDepth)

Espande tutti i gruppi di righe fino alla profondità specificata e comprime tutti gli altri.

const sheet = 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);

Parametri

NomeTipoDescrizione
groupDepthIntegerLa profondità del gruppo fino alla quale espandere i gruppi di righe.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getActiveCell()

Restituisce la cella attiva in questo foglio.

Nota:è preferibile utilizzare getCurrentCell(), che restituisce la cella attualmente evidenziata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Returns the active cell
const cell = sheet.getActiveCell();

Invio

Range: la cella attiva corrente

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getActiveRange()

Restituisce l'intervallo selezionato nel foglio attivo o null se non è presente alcun intervallo attivo. Se sono selezionati più intervalli, questo metodo restituisce solo l'ultimo intervallo selezionato.

Il termine "intervallo attivo" si riferisce all'intervallo selezionato da un utente nel foglio attivo, ma in una funzione personalizzata si riferisce alla cella in fase di ricalcolo attivo.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const activeRange = sheet.getActiveRange();

Invio

Range: l'intervallo attivo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Vedi anche


getActiveRangeList()

Restituisce l'elenco degli intervalli attivi nel foglio attivo o null se non sono presenti intervalli attivi.

Se è selezionato un singolo intervallo, il comportamento è simile a una chiamata getActiveRange().

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

Invio

RangeList: l'elenco degli intervalli attivi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Vedi anche


getBandings()

Restituisce tutte le fasce in questo foglio.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the banding info for the sheet.
const bandings = sheet.getBandings();

// Gets info on the bandings' second row color and logs it to the console.
for (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

Invio

Banding[]: tutte le fasce in questo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getCharts()

Restituisce un array di grafici in questo foglio.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const charts = sheet.getCharts();

for (const i in charts) {
  const chart = charts[i];
  // Do something with the chart
}

Invio

EmbeddedChart[]: un array di grafici.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getColumnGroup(columnIndex, groupDepth)

Restituisce il gruppo di colonne all'indice e alla profondità del gruppo specificati.

const sheet = 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.
const columnGroup = sheet.getColumnGroup(2, 1);

Parametri

NomeTipoDescrizione
columnIndexIntegerL'indice della colonna del pulsante di attivazione/disattivazione del controllo gruppo o un indice all'interno del gruppo.
groupDepthIntegerLa profondità del gruppo.

Invio

Group: il gruppo di colonne nell'indice e nella profondità del controllo oppure viene lanciata un'eccezione se il gruppo non esiste.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getColumnGroupControlPosition()

Restituisce il valore GroupControlTogglePosition per tutti i gruppi di colonne del foglio.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// GroupControlTogglePosition.AFTER if the column grouping control toggle is
// shown after the group.
const columnGroupControlPosition = sheet.getColumnGroupControlPosition();

Invio

GroupControlTogglePosition - true se l'opzione di controllo del raggruppamento delle colonne viene visualizzata dopo il gruppo in questo foglio e false in caso contrario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getColumnGroupDepth(columnIndex)

Restituisce la profondità del gruppo della colonna all'indice specificato.

La profondità del gruppo indica quanti gruppi si sovrappongono alla colonna. Può variare da zero a otto.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// 1 if there is a group over columns 1 through 3
const groupDepth = sheet.getColumnGroupDepth(1);

Parametri

NomeTipoDescrizione
columnIndexIntegerL'indice della colonna.

Invio

Integer: la profondità del gruppo della colonna nell'indice specificato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getColumnWidth(columnPosition)

Restituisce la larghezza in pixel della colonna specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

Parametri

NomeTipoDescrizione
columnPositionIntegerLa posizione della colonna da esaminare.

Invio

Integer: larghezza della colonna in pixel

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getConditionalFormatRules()

Visualizza tutte le regole di formattazione condizionale in questo foglio.

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

Invio

ConditionalFormatRule[]: un array di tutte le regole nel foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getCurrentCell()

Restituisce la cella corrente nel foglio attivo o null se non esiste una cella corrente. La cella corrente è la cella attiva nell'interfaccia utente di Fogli Google ed è evidenziata da un bordi scuro. Non esiste mai più di una cella corrente. Quando un utente seleziona uno o più intervalli di celle, una delle celle nella selezione è la cella corrente.

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

Invio

Range: la cella corrente

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDataRange()

Restituisce un Range corrispondente alle dimensioni in cui sono presenti i dati.

Questo è funzionalmente equivalente alla creazione di un intervallo delimitato da A1 e (Sheet.getLastColumn(), Sheet.getLastRow()).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This represents ALL the data
const range = sheet.getDataRange();
const values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (let i = 0; i < values.length; i++) {
  let row = '';
  for (let j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = `${row},`;
  }
  Logger.log(row);
}

Invio

Range: un intervallo costituito da tutti i dati del foglio di lavoro

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDataSourceFormulas()

Recupera tutte le formule dell'origine dati.

// 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.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = 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'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

Invio

DataSourceFormula[]: un elenco di formule dell'origine dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDataSourcePivotTables()

Recupera tutte le tabelle pivot dell'origine dati.

// 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.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = 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'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

Invio

DataSourcePivotTable[]: un elenco di tabelle pivot dell'origine dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDataSourceTables()

Recupera tutte le tabelle dell'origine dati.

// 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.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = 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'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

Invio

DataSourceTable[]: un elenco di tabelle di origini dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDeveloperMetadata()

Visualizza tutti i metadati dello sviluppatore associati a questo foglio.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Gets all the developer metadata for the sheet.
const developerMetaDataList = sheet.getDeveloperMetadata();

// Logs the developer metadata to the console.
for (const developerMetaData of developerMetaDataList) {
  console.log(developerMetaData.getKey());
}

Invio

DeveloperMetadata[]: i metadati dello sviluppatore associati a questo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDrawings()

Restituisce un array di disegni nel foglio.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the drawings from the sheet.
const allDrawings = sheet.getDrawings();

// Logs the number of drawings present on the sheet.
console.log(allDrawings.length);

Invio

Drawing[]: l'elenco dei disegni in questo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getFilter()

Restituisce il filtro in questo foglio o null se non è presente alcun filtro.

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

Invio

Filter: il filtro.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getFormUrl()

Restituisce l'URL del modulo che invia le risposte a questo foglio oppure null se questo foglio non ha un modulo associato. Viene lanciata un'eccezione se l'utente non dispone dell'autorizzazione per modificare il foglio di lavoro.

const sheet = SpreadsheetApp.getActiveSheet();
const url = sheet.getFormUrl();

Invio

String: l'URL del modulo che inserisce le risposte in questo foglio oppure null se questo foglio non ha un modulo associato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getFrozenColumns()

Restituisce il numero di colonne bloccate.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log('Number of frozen columns: %s', sheet.getFrozenColumns());

Invio

Integer: il numero di colonne bloccate

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getFrozenRows()

Restituisce il numero di righe bloccate.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log('Number of frozen rows: %s', sheet.getFrozenRows());

Invio

Integer: il numero di righe bloccate

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getImages()

Restituisce tutte le immagini fuori griglia nel foglio.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = 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.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
  console.log(image.getAnchorCell().getA1Notation());
}

Invio

OverGridImage[]: un array di immagini sopra la griglia.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getIndex()

Recupera la posizione del foglio nel foglio di lavoro principale. Inizia da 1.

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

Invio

Integer: la posizione del foglio nel foglio di lavoro principale.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getLastColumn()

Restituisce la posizione dell'ultima colonna contenente contenuti.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Invio

Integer: l'ultima colonna del foglio contenente contenuti

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getLastRow()

Restituisce la posizione dell'ultima riga contenente contenuti.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Invio

Integer: l'ultima riga del foglio contenente contenuti

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getMaxColumns()

Restituisce il numero corrente di colonne nel foglio, indipendentemente dai contenuti.

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

Invio

Integer: la larghezza massima del foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getMaxRows()

Restituisce il numero corrente di righe nel foglio, indipendentemente dai contenuti.

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

Invio

Integer: l'altezza massima del foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getName()

Restituisce il nome del foglio.

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

Invio

String: il nome del foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getNamedRanges()

Recupera tutti gli intervalli denominati in questo foglio.

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

Invio

NamedRange[]: un array di tutti gli intervalli denominati nel foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getParent()

Restituisce il Spreadsheet contenente questo foglio.

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

Invio

Spreadsheet: il foglio di lavoro principale.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getPivotTables()

Restituisce tutte le tabelle pivot in questo foglio.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the pivot table info for the sheet.
const pivotTables = sheet.getPivotTables();

// Logs the pivot tables to the console.
for (const pivotTable of pivotTables) {
  console.log(pivotTable.getSourceDataRange().getValues());
}

Invio

PivotTable[]: le tabelle pivot in questo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getProtections(type)

Restituisce un array di oggetti che rappresentano tutti gli intervalli protetti nel foglio o un array di un solo elemento che rappresenta la protezione sul foglio stesso.

// Remove all range protections in the spreadsheet that the user has permission
// to edit.
const sheet = SpreadsheetApp.getActiveSheet();
const protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (let i = 0; i < protections.length; i++) {
  const protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove sheet protection from the active sheet, if the user has permission to
// edit it.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection?.canEdit()) {
  protection.remove();
}

Parametri

NomeTipoDescrizione
typeProtectionTypeIl tipo di area protetta, SpreadsheetApp.ProtectionType.RANGE o SpreadsheetApp.ProtectionType.SHEET.

Invio

Protection[]: un array di oggetti che rappresentano tutti gli intervalli protetti nel foglio o un array di un solo elemento che rappresenta la protezione sul foglio stesso.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRange(row, column)

Restituisce l'intervallo con la cella in alto a sinistra alle coordinate specificate.

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

Parametri

NomeTipoDescrizione
rowIntegerL'indice di riga della cella da restituire. L'indice di riga inizia con 1.
columnIntegerL'indice della colonna della cella da restituire. L'indice di colonna inizia con 1.

Invio

Range: un intervallo contenente solo questa cella.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRange(row, column, numRows)

Restituisce l'intervallo con la cella in alto a sinistra alle coordinate specificate e con il numero specificato di righe.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// When the "numRows" argument is used, only a single column of data is
// returned.
const range = sheet.getRange(1, 1, 3);
const values = range.getValues();

// Prints 3 values from the first column, starting from row 1.
for (const row in values) {
  for (const col in values[row]) {
    Logger.log(values[row][col]);
  }
}

Parametri

NomeTipoDescrizione
rowIntegerL'indice di riga iniziale dell'intervallo. L'indice di riga inizia con 1.
columnIntegerL'indice della colonna dell'intervallo. L'indice della colonna inizia da 1.
numRowsIntegerIl numero di righe da restituire.

Invio

Range: un intervallo contenente una singola colonna di dati con il numero di righe specificato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRange(row, column, numRows, numColumns)

Restituisce l'intervallo con la cella in alto a sinistra alle coordinate specificate con il numero specificato di righe e colonne.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange(1, 1, 3, 3);
const values = range.getValues();

// Print values from a 3x3 box.
for (const row in values) {
  for (const col in values[row]) {
    Logger.log(values[row][col]);
  }
}

Parametri

NomeTipoDescrizione
rowIntegerL'indice di riga iniziale dell'intervallo. L'indice di riga inizia con 1.
columnIntegerL'indice della colonna iniziale dell'intervallo. L'indice della colonna inizia con 1.
numRowsIntegerIl numero di righe da restituire.
numColumnsIntegerIl numero di colonne da restituire.

Invio

Range: un intervallo corrispondente all'area specificata.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRange(a1Notation)

Restituisce l'intervallo specificato nella notazione A1 o R1C1.

// Get a range A1:D4 on sheet titled "Invoices"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const range = ss.getRange('Invoices!A1:D4');

// Get cell A1 on the first sheet
const sheet = ss.getSheets()[0];
const cell = sheet.getRange('A1');

Parametri

NomeTipoDescrizione
a1NotationStringL'intervallo da restituire, come specificato nella notazione A1 o R1C1.

Invio

Range: l'intervallo nella località designata

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRangeList(a1Notations)

Restituisce la raccolta RangeList che rappresenta gli intervalli nello stesso foglio specificati da un elenco non vuoto di notazioni A1 o R1C1.

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

Parametri

NomeTipoDescrizione
a1NotationsString[]L'elenco degli intervalli da restituire, come specificato nella notazione A1 o R1C1.

Invio

RangeList: l'elenco di intervalli nella posizione designata

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRowGroup(rowIndex, groupDepth)

Restituisce il gruppo di righe nell'indice e nella profondità del gruppo specificati.

const sheet = 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.
const rowGroup = sheet.getRowGroup(2, 1);

Parametri

NomeTipoDescrizione
rowIndexIntegerL'indice di riga dell'opzione di controllo del gruppo o un indice all'interno del gruppo.
groupDepthIntegerLa profondità del gruppo.

Invio

Group: il gruppo di righe nell'indice e nella profondità del controllo oppure viene lanciata un'eccezione se il gruppo non esiste.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRowGroupControlPosition()

Restituisce il valore GroupControlTogglePosition per tutti i gruppi di righe del foglio.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// GroupControlTogglePosition.AFTER if the row grouping control toggle is shown
// after the group.
const rowGroupControlPosition = sheet.getRowGroupControlPosition();

Invio

GroupControlTogglePosition - true se l'opzione di controllo del raggruppamento delle righe viene visualizzata dopo il gruppo in questo foglio e false in caso contrario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRowGroupDepth(rowIndex)

Restituisce la profondità del gruppo della riga nell'indice specificato.

La profondità del gruppo indica quanti gruppi si sovrappongono alla riga. Può variare da zero a otto.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// 1 if there is a group over rows 1 through 3
const groupDepth = sheet.getRowGroupDepth(1);

Parametri

NomeTipoDescrizione
rowIndexIntegerL'indice della riga.

Invio

Integer: la profondità del gruppo della riga nell'indice specificato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRowHeight(rowPosition)

Restituisce l'altezza in pixel della riga specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

Parametri

NomeTipoDescrizione
rowPositionIntegerLa posizione della riga da esaminare.

Invio

Integer: altezza riga in pixel

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getSelection()

Restituisce il Selection corrente nel foglio di lavoro.

const selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
const currentCell = selection.getCurrentCell();

Invio

Selection: la selezione corrente

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getSheetId()

Restituisce l'ID del foglio rappresentato da questo oggetto.

Si tratta di un ID del foglio univoco per il foglio di lavoro. L'ID è un numero intero monotonicamente crescente assegnato al momento della creazione del foglio ed è indipendente dalla posizione del foglio. Questo è utile in combinazione con metodi come Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) che accettano un parametro gridId anziché un'istanza Sheet.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetId());

Invio

Integer: un ID per il foglio univoco per il foglio di lavoro

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getSheetName()

Restituisce il nome del foglio.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

Invio

String: il nome del foglio

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getSheetValues(startRow, startColumn, numRows, numColumns)

Restituisce la griglia rettangolare di valori per questo intervallo a partire dalle coordinate specificate. Un valore -1 fornito come posizione della riga o della colonna è equivalente all'ultima riga o colonna con dati nel foglio.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// The two samples below produce the same output
let values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

const range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

Parametri

NomeTipoDescrizione
startRowIntegerLa posizione della riga iniziale.
startColumnIntegerLa posizione della colonna iniziale.
numRowsIntegerIl numero di righe per cui restituire i valori.
numColumnsIntegerIl numero di colonne per cui restituire i valori.

Invio

Object[][]: un array bidimensionale di valori

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getSlicers()

Restituisce un array di slicer nel foglio.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all slicers in the spreadsheet.
const slicers = sheet.getSlicers();

// Logs the slicer titles to the console.
for (const slicer of slicers) {
  console.log(slicer.getTitle());
}

Invio

Slicer[]: l'elenco degli slicer in questo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getTabColorObject()

Restituisce il colore della scheda del foglio o null se la scheda del foglio non ha colore.

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

Invio

Color: il colore della scheda del foglio o null se la scheda non ha colore.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getType()

Restituisce il tipo di foglio.

Il tipo di foglio predefinito è SheetType.GRID. Un foglio che contiene un singolo oggetto incorporato, ad esempio un EmbeddedChart, è un foglio SheetType.OBJECT.

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

Invio

SheetType: il tipo di foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hasHiddenGridlines()

Restituisce true se le linee di griglia del foglio sono nascoste; in caso contrario, restituisce false. Le linee della griglia sono visibili per impostazione predefinita.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if the spreadsheet has hidden gridelines and logs the result to the
// console.
console.log(sheet.hasHiddenGridlines());

Invio

Boolean: true se le linee della griglia sono nascoste; false in caso contrario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hideColumn(column)

Nasconde la colonna o le colonne nell'intervallo specificato.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange('A1');
sheet.hideColumn(range);

// This hides the first 3 columns
range = sheet.getRange('A:C');
sheet.hideColumn(range);

Parametri

NomeTipoDescrizione
columnRangeL'intervallo di colonne da nascondere.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hideColumns(columnIndex)

Nasconde una singola colonna nell'indice specificato. Utilizza l'indice 1 per questo metodo.

Per nascondere più di una colonna utilizzando un indice, utilizza hideColumns(columnIndex, numColumns).

Per nascondere più colonne utilizzando un intervallo, utilizza hideColumn().

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first column
sheet.hideColumns(1);

Parametri

NomeTipoDescrizione
columnIndexIntegerL'indice della colonna da nascondere.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hideColumns(columnIndex, numColumns)

Nasconde una o più colonne consecutive a partire dall'indice specificato. Utilizza l'indice 1 per questo metodo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first three columns
sheet.hideColumns(1, 3);

Parametri

NomeTipoDescrizione
columnIndexIntegerL'indice iniziale delle colonne da nascondere.
numColumnsIntegerIl numero di colonne da nascondere.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hideRow(row)

Nasconde le righe nell'intervallo specificato.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This hides the first row
const range = sheet.getRange('A1');
sheet.hideRow(range);

Parametri

NomeTipoDescrizione
rowRangeL'intervallo di righe da nascondere.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hideRows(rowIndex)

Nasconde la riga nell'indice specificato.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first row
sheet.hideRows(1);

Parametri

NomeTipoDescrizione
rowIndexIntegerL'indice della riga da nascondere.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hideRows(rowIndex, numRows)

Nasconde una o più righe consecutive a partire dall'indice specificato.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first three rows
sheet.hideRows(1, 3);

Parametri

NomeTipoDescrizione
rowIndexIntegerL'indice iniziale delle righe da nascondere.
numRowsIntegerIl numero di righe da nascondere.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hideSheet()

Nasconde questo foglio. Non ha alcun effetto se il foglio è già nascosto. Se questo metodo viene chiamato sul solo foglio visibile, viene generata un'eccezione.

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

Invio

Sheet: il foglio corrente.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertChart(chart)

Aggiunge un nuovo grafico a questo foglio.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
const chart = sheet.newChart()
                  .setChartType(Charts.ChartType.BAR)
                  .addRange(sheet.getRange('A1:B4'))
                  .setPosition(5, 5, 0, 0)
                  .setOption('title', 'Dynamic Chart')
                  .build();
sheet.insertChart(chart);

Parametri

NomeTipoDescrizione
chartEmbeddedChartIl grafico da inserire.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertColumnAfter(afterPosition)

Inserisce una colonna dopo la posizione della colonna specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

Parametri

NomeTipoDescrizione
afterPositionIntegerLa colonna dopo la quale deve essere aggiunta la nuova colonna.

Invio

Sheet: il foglio, utile per l'accodamento di metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertColumnBefore(beforePosition)

Inserisce una colonna prima della posizione della colonna specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

Parametri

NomeTipoDescrizione
beforePositionIntegerLa colonna prima della quale deve essere aggiunta la nuova colonna.

Invio

Sheet: il foglio, utile per l'accodamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertColumns(columnIndex)

Inserisce una colonna vuota in un foglio nella posizione specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all columns by one
sheet.insertColumns(1);

Parametri

NomeTipoDescrizione
columnIndexIntegerL'indice che indica dove inserire una colonna.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertColumns(columnIndex, numColumns)

Inserisce una o più colonne vuote consecutive in un foglio a partire dalla posizione specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all columns by three
sheet.insertColumns(1, 3);

Parametri

NomeTipoDescrizione
columnIndexIntegerL'indice che indica dove inserire una colonna.
numColumnsIntegerIl numero di colonne da inserire.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertColumnsAfter(afterPosition, howMany)

Inserisce un determinato numero di colonne dopo la posizione della colonna specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Inserts two columns after the first column on the first sheet of the
// spreadsheet.
sheet.insertColumnsAfter(1, 2);

Parametri

NomeTipoDescrizione
afterPositionIntegerLa colonna dopo la quale deve essere aggiunta la nuova colonna.
howManyIntegerIl numero di colonne da inserire.

Invio

Sheet: il foglio, utile per l'accodamento di metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertColumnsBefore(beforePosition, howMany)

Inserisce un numero di colonne prima della posizione della colonna specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

Parametri

NomeTipoDescrizione
beforePositionIntegerLa colonna prima della quale deve essere aggiunta la nuova colonna.
howManyIntegerIl numero di colonne da inserire.

Invio

Sheet: il foglio, utile per l'accodamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertImage(blobSource, column, row)

Inserisce un BlobSource come immagine nel documento in una determinata riga e colonna. Le dimensioni dell'immagine vengono recuperate dai contenuti del blob. Il limite massimo per le dimensioni del blob supportate è 2 MB.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Parametri

NomeTipoDescrizione
blobSourceBlobSourceIl blob contenente i contenuti dell'immagine, il tipo MIME e (facoltativamente) il nome.
columnIntegerLa posizione della colonna.
rowIntegerLa posizione della riga.

Invio

OverGridImage: l'immagine inserita.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertImage(blobSource, column, row, offsetX, offsetY)

Inserisce un BlobSource come immagine nel documento in una determinata riga e colonna, con un offset in pixel. Le dimensioni dell'immagine vengono recuperate dai contenuti del blob. La dimensione massima supportata per i blob è 2 MB.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Parametri

NomeTipoDescrizione
blobSourceBlobSourceIl blob contenente i contenuti dell'immagine, il tipo MIME e (facoltativamente) il nome.
columnIntegerLa posizione della colonna.
rowIntegerLa posizione della riga.
offsetXIntegerLo scostamento orizzontale dall'angolo della cella in pixel.
offsetYIntegerLo scostamento verticale dall'angolo della cella in pixel.

Invio

OverGridImage: l'immagine inserita.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertImage(url, column, row)

Inserisce un'immagine nel documento in una determinata riga e colonna.

L'URL fornito deve essere accessibile pubblicamente.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.insertImage('https://www.google.com/images/srpr/logo3w.png', 1, 1);

Parametri

NomeTipoDescrizione
urlStringL'URL dell'immagine.
columnIntegerLa posizione della colonna della griglia.
rowIntegerLa posizione della riga della griglia.

Invio

OverGridImage: l'immagine inserita.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertImage(url, column, row, offsetX, offsetY)

Inserisce un'immagine nel documento in una determinata riga e colonna, con uno spostamento in pixel.

L'URL fornito deve essere accessibile pubblicamente.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.insertImage(
    'https://www.google.com/images/srpr/logo3w.png',
    1,
    1,
    10,
    10,
);

Parametri

NomeTipoDescrizione
urlStringL'URL dell'immagine.
columnIntegerLa posizione della colonna.
rowIntegerLa posizione della riga.
offsetXIntegerLo scostamento orizzontale dall'angolo della cella in pixel.
offsetYIntegerLo scostamento verticale dall'angolo della cella in pixel.

Invio

OverGridImage: l'immagine inserita.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertRowAfter(afterPosition)

Inserisce una riga dopo la posizione della riga specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

Parametri

NomeTipoDescrizione
afterPositionIntegerLa riga dopo la quale deve essere aggiunta la nuova riga.

Invio

Sheet: il foglio, utile per l'accodamento di metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertRowBefore(beforePosition)

Inserisce una riga prima della posizione della riga specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

Parametri

NomeTipoDescrizione
beforePositionIntegerLa riga prima della quale deve essere aggiunta la nuova riga.

Invio

Sheet: il foglio, utile per l'accodamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertRows(rowIndex)

Inserisce una riga vuota in un foglio nella posizione specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all rows down by one
sheet.insertRows(1);

Parametri

NomeTipoDescrizione
rowIndexIntegerL'indice che indica dove inserire una riga.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertRows(rowIndex, numRows)

Inserisce una o più righe vuote consecutive in un foglio a partire dalla posizione specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all rows down by three
sheet.insertRows(1, 3);

Parametri

NomeTipoDescrizione
rowIndexIntegerL'indice che indica dove inserire una riga.
numRowsIntegerIl numero di righe da inserire.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertRowsAfter(afterPosition, howMany)

Inserisce un numero di righe dopo la posizione della riga specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

Parametri

NomeTipoDescrizione
afterPositionIntegerLa riga dopo la quale devono essere aggiunte le nuove righe.
howManyIntegerIl numero di righe da inserire.

Invio

Sheet: il foglio, utile per l'accodamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertRowsBefore(beforePosition, howMany)

Inserisce un numero di righe prima della posizione della riga specificata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

Parametri

NomeTipoDescrizione
beforePositionIntegerLa riga prima della quale devono essere aggiunte le nuove righe.
howManyIntegerIl numero di righe da inserire.

Invio

Sheet: il foglio, utile per l'accodamento di metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertSlicer(range, anchorRowPos, anchorColPos)

Aggiunge un nuovo selettore a questo foglio.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range of the sheet.
const range = sheet.getRange('A1:D10');

// Inserts the slicer with a random range into the sheet.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

Parametri

NomeTipoDescrizione
rangeRangeL'intervallo su cui viene creato il controllo filtro.
anchorRowPosIntegerIl lato superiore del selettore è ancorato a questa riga.
anchorColPosIntegerIl lato superiore dell'ellisse è ancorato in questa colonna.

Invio

Slicer: il controllo filtro appena inserito.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)

Aggiunge un nuovo selettore a questo foglio.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range.
const range = sheet.getRange('A1:D10');

// Inserts a slicer using the random range function.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

Parametri

NomeTipoDescrizione
rangeRangeL'intervallo su cui viene creato il controllo filtro.
anchorRowPosIntegerIl lato superiore del selettore è ancorato a questa riga.
anchorColPosIntegerIl lato superiore del selettore è ancorato in questa colonna.
offsetXIntegerLo scostamento orizzontale dall'angolo della cella in pixel.
offsetYIntegerLo scostamento verticale dall'angolo della cella in pixel.

Invio

Slicer: il controllo filtro appena inserito.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

isColumnHiddenByUser(columnPosition)

Restituisce se la colonna specificata è nascosta dall'utente.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

Parametri

NomeTipoDescrizione
columnPositionIntegerLa posizione della colonna da esaminare.

Invio

Boolean: true se la colonna è nascosta, false in caso contrario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

isRightToLeft()

Restituisce true se il layout del foglio è da destra a sinistra. Restituisce false se il foglio utilizza il layout predefinito da sinistra a destra.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if a spreadsheet is ordered from right to left and logs the result to
// the console.
console.log(sheet.isRightToLeft());

Invio

Boolean: true se da destra a sinistra; false in caso contrario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

isRowHiddenByFilter(rowPosition)

Restituisce se la riga specificata è nascosta da un filtro (non da una visualizzazione filtrata).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

Parametri

NomeTipoDescrizione
rowPositionIntegerLa posizione della riga da esaminare.

Invio

Boolean - true se la riga è nascosta, false in caso contrario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

isRowHiddenByUser(rowPosition)

Restituisce se la riga specificata è nascosta dall'utente.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

Parametri

NomeTipoDescrizione
rowPositionIntegerLa posizione della riga da esaminare.

Invio

Boolean - true se la riga è nascosta, false in caso contrario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

isSheetHidden()

Restituisce true se il foglio è attualmente nascosto.

const sheet = SpreadsheetApp.getActiveSheet();
if (sheet.isSheetHidden()) {
  // do something...
}

Invio

Boolean: true se il foglio è nascosto, false in caso contrario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

moveColumns(columnSpec, destinationIndex)

Sposta le colonne selezionate dall'intervallo specificato nella posizione indicata da destinationIndex. Il simbolo columnSpec non deve necessariamente rappresentare esattamente un'intera colonna o un gruppo di colonne da spostare, ma seleziona tutte le colonne che interessano l'intervallo.

// The code below moves rows A-B to destination index 5.
// This results in those columns becoming columns C-D.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
const columnSpec = sheet.getRange('A1:B1');
sheet.moveColumns(columnSpec, 5);

Parametri

NomeTipoDescrizione
columnSpecRangeUn intervallo che comprende le colonne da spostare.
destinationIndexIntegerL'indice in cui devono essere spostate le colonne. Tieni presente che questo indice si basa sulle coordinate prima del trasferimento delle colonne. I dati esistenti vengono spostati verso destra per fare spazio alle colonne spostate, mentre le colonne di origine vengono rimosse dalla griglia. Di conseguenza, i dati potrebbero finire in un indice diverso da quello specificato inizialmente.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

moveRows(rowSpec, destinationIndex)

Sposta le righe selezionate dall'intervallo specificato nella posizione indicata da destinationIndex. Il carattere rowSpec non deve necessariamente rappresentare esattamente un'intera riga o un gruppo di righe da spostare, ma seleziona tutte le righe che comprende l'intervallo.

// The code below moves rows 1-2 to destination index 5.
// This results in those rows becoming rows 3-4.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
const rowSpec = sheet.getRange('A1:A2');
sheet.moveRows(rowSpec, 5);

Parametri

NomeTipoDescrizione
rowSpecRangeUn intervallo che comprende le righe da spostare.
destinationIndexIntegerL'indice in cui devono essere spostate le righe. Tieni presente che questo indice si basa sulle coordinate prima del trasferimento delle righe. I dati esistenti vengono spostati verso il basso per fare spazio alle righe spostate, mentre le righe di origine vengono rimosse dalla griglia. Pertanto, i dati possono finire in un indice diverso da quello specificato inizialmente.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

newChart()

Restituisce un generatore per creare un nuovo grafico per questo foglio.

Questo esempio mostra come creare un nuovo grafico:

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B8');
const chartBuilder = sheet.newChart();
chartBuilder.addRange(range)
    .setChartType(Charts.ChartType.LINE)
    .setPosition(2, 2, 0, 0)
    .setOption('title', 'My Line Chart!');
sheet.insertChart(chartBuilder.build());

Invio

EmbeddedChartBuilder: uno strumento per creare un nuovo grafico.


protect()

Crea un oggetto che può impedire la modifica del foglio, tranne che per gli utenti che dispongono dell'autorizzazione. Fino a quando lo script non modifica effettivamente l'elenco degli editor del foglio (chiamando Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user), Protection.addEditors(emailAddresses) o impostando un nuovo valore per Protection.setDomainEdit(editable)), le autorizzazioni rispecchiano quelle del foglio di lavoro stesso, il che significa che il foglio rimane non protetto. Se il foglio è già protetto, questo metodo restituisce un oggetto che rappresenta le impostazioni di protezione esistenti. Un foglio protetto può includere regioni non protette.

// Protect the active sheet, then remove all other users from the list of
// editors.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.protect().setDescription('Sample protected sheet');

// Ensure the current user is an editor before removing others. Otherwise, if
// the user's edit permission comes from a group, the script throws an exception
// upon removing the group.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Invio

Protection: un oggetto che rappresenta le impostazioni di protezione.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

removeChart(chart)

Rimuove un grafico dal foglio principale.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This removes all the embedded charts from the spreadsheet
const charts = sheet.getCharts();
for (const i in charts) {
  sheet.removeChart(charts[i]);
}

Parametri

NomeTipoDescrizione
chartEmbeddedChartIl grafico da rimuovere.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setActiveRange(range)

Imposta l'intervallo specificato come active range nel foglio attivo, con la cella in alto a sinistra dell'intervallo come current cell.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

const selection = sheet.getSelection();
// Current cell: A1
const currentCell = selection.getCurrentCell();
// Active Range: A1:D4
const activeRange = selection.getActiveRange();

Parametri

NomeTipoDescrizione
rangeRangeL'intervallo da impostare come intervallo attivo.

Invio

Range: l'intervallo appena attivato

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setActiveRangeList(rangeList)

Imposta l'elenco di intervalli specificato come active ranges nel foglio attivo. L'ultimo intervallo nell'elenco è impostato come active range.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

const selection = sheet.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

Parametri

NomeTipoDescrizione
rangeListRangeListL'elenco di intervalli da selezionare.

Invio

RangeList: l'elenco di intervalli appena selezionato

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setActiveSelection(range)

Imposta la regione di selezione attiva per questo foglio.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const range = sheet.getRange('A1:D4');
sheet.setActiveSelection(range);

Parametri

NomeTipoDescrizione
rangeRangeL'intervallo da impostare come selezione attiva.

Invio

Range: l'intervallo appena attivato

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setActiveSelection(a1Notation)

Imposta la selezione attiva, come specificato nella notazione A1 o R1C1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.setActiveSelection('A1:D4');

Parametri

NomeTipoDescrizione
a1NotationStringL'intervallo da impostare come attivo, come specificato nella notazione A1 o R1C1.

Invio

Range: l'intervallo appena attivato

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setColumnGroupControlPosition(position)

Imposta la posizione del pulsante di attivazione/disattivazione del controllo del gruppo di colonne nel foglio.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setColumnGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

Parametri

NomeTipoDescrizione
positionGroupControlTogglePositionLa posizione del pulsante di attivazione/disattivazione del controllo del gruppo di colonne.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setColumnWidth(columnPosition, width)

Imposta la larghezza della colonna specificata in pixel.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Parametri

NomeTipoDescrizione
columnPositionIntegerLa posizione della colonna da impostare.
widthIntegerLa larghezza in pixel da impostare.

Invio

Sheet: il foglio, utile per l'accodamento di metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setColumnWidths(startColumn, numColumns, width)

Imposta la larghezza delle colonne specificate in pixel.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three columns to a width of 200 pixels
sheet.setColumnWidths(1, 3, 200);

Parametri

NomeTipoDescrizione
startColumnIntegerLa posizione della colonna iniziale da modificare.
numColumnsIntegerIl numero di colonne da modificare.
widthIntegerLa larghezza in pixel da impostare.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setConditionalFormatRules(rules)

Sostituisce tutte le regole di formattazione condizionale attualmente esistenti nel foglio con le regole di immissione. Le regole vengono valutate nell'ordine in cui sono inserite.

// Remove one of the existing conditional format rules.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
rules.splice(1, 1);  // Deletes the 2nd format rule.
sheet.setConditionalFormatRules(rules);

Parametri

NomeTipoDescrizione
rulesConditionalFormatRule[]Le nuove regole di formattazione condizionale.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setCurrentCell(cell)

Imposta la cella specificata come current cell.

Se la cella specificata è presente in un intervallo già selezionato, questo diventa l'intervallo attivo con la cella come cella corrente.

Se la cella specificata non è presente in nessun intervallo selezionato, tutte le selezioni esistenti vengono rimosse e la cella diventa la cella corrente e l'intervallo attivo.

Nota: Range specificato deve essere costituito da una cella, altrimenti viene generata un'eccezione.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

const selection = sheet.getSelection();
// Current cell: B5
const currentCell = selection.getCurrentCell();

Parametri

NomeTipoDescrizione
cellRangeLa cella da impostare come cella corrente.

Invio

Range: la cella corrente appena impostata

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setFrozenColumns(columns)

Blocca il numero specificato di colonne. Se è pari a zero, nessuna colonna è bloccata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

Parametri

NomeTipoDescrizione
columnsIntegerIl numero di colonne da bloccare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setFrozenRows(rows)

Blocca il numero specificato di righe. Se è pari a zero, nessuna riga viene bloccata.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

Parametri

NomeTipoDescrizione
rowsIntegerIl numero di righe da bloccare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setHiddenGridlines(hideGridlines)

Nasconde o mostra le linee della griglia del foglio.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can us eSpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Hides the gridlines in the sheet.
sheet.setHiddenGridlines(true);

Parametri

NomeTipoDescrizione
hideGridlinesBooleanSe true, nascondi le linee della griglia in questo foglio; altrimenti mostrale.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setName(name)

Imposta il nome del foglio.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setName('not first anymore');

Parametri

NomeTipoDescrizione
nameStringIl nuovo nome del foglio.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setRightToLeft(rightToLeft)

Imposta o annulla l'impostazione del layout del foglio da destra a sinistra.

// 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.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the sheet layout, so that the sheet is ordered from right to left.
sheet.setRightToLeft(true);

Parametri

NomeTipoDescrizione
rightToLeftBooleanSe true, il layout del foglio è impostato su da destra a sinistra, con la cella A1 nell'angolo in alto a destra. Se false, il layout del foglio è impostato su da sinistra a destra per impostazione predefinita, con la cella A1 in alto a sinistra.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setRowGroupControlPosition(position)

Imposta la posizione del pulsante di attivazione/disattivazione del controllo del gruppo di righe nel foglio.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

Parametri

NomeTipoDescrizione
positionGroupControlTogglePositionLa posizione del pulsante di attivazione/disattivazione del controllo del gruppo di righe.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setRowHeight(rowPosition, height)

Imposta l'altezza della riga specificata in pixel. Per impostazione predefinita, le righe aumentano in base ai contenuti delle celle. Se vuoi forzare le righe a un'altezza specificata, utilizza setRowHeightsForced(startRow, numRows, height).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Parametri

NomeTipoDescrizione
rowPositionIntegerLa posizione della riga da modificare.
heightIntegerL'altezza in pixel da impostare.

Invio

Sheet: il foglio, utile per l'accodamento dei metodi.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setRowHeights(startRow, numRows, height)

Imposta l'altezza delle righe specificate in pixel. Per impostazione predefinita, le righe aumentano in base ai contenuti delle celle. Se vuoi forzare le righe a un'altezza specificata, utilizza setRowHeightsForced(startRow, numRows, height).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three rows to a height of 20 pixels
sheet.setRowHeights(1, 3, 20);

Parametri

NomeTipoDescrizione
startRowIntegerLa posizione della riga iniziale da modificare.
numRowsIntegerIl numero di righe da modificare.
heightIntegerL'altezza in pixel da impostare.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setRowHeightsForced(startRow, numRows, height)

Imposta l'altezza delle righe specificate in pixel. Per impostazione predefinita, le righe aumentano in base ai contenuti delle celle. Quando utilizzi setRowHeightsForced, le righe vengono forzate all'altezza specificata anche se i contenuti delle celle sono più alti dell'altezza della riga.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three rows to a height of 5 pixels.
sheet.setRowHeightsForced(1, 3, 5);

Parametri

NomeTipoDescrizione
startRowIntegerLa posizione della riga iniziale da modificare.
numRowsIntegerIl numero di righe da modificare.
heightIntegerL'altezza in pixel da impostare.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setTabColor(color)

Imposta il colore della scheda del foglio.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setTabColor('ff0000');  // Set the color to red.
first.setTabColor(null);      // Unset the color.

Parametri

NomeTipoDescrizione
colorStringUn codice colore in notazione CSS (ad esempio '#ffffff' o 'white') oppure null per reimpostare il colore della scheda.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setTabColorObject(color)

Imposta il colore della scheda del foglio.

// This example assumes there is a sheet named "Sheet1"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const color = SpreadsheetApp.newColor()
                  .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                  .build();
first.setTabColorObject(color);  // Set the color to theme accent 1.
first.setTabColorObject(null);   // Unset the color.

Parametri

NomeTipoDescrizione
colorColorIl colore della scheda del foglio da impostare.

Invio

Sheet: questo foglio, per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

showColumns(columnIndex)

Mostra la colonna all'indice specificato.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first column
sheet.showColumns(1);

Parametri

NomeTipoDescrizione
columnIndexIntegerL'indice della colonna da mostrare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

showColumns(columnIndex, numColumns)

Mostra una o più colonne consecutive a partire dall'indice specificato.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three columns
sheet.showColumns(1, 3);

Parametri

NomeTipoDescrizione
columnIndexIntegerL'indice iniziale delle colonne da mostrare.
numColumnsIntegerIl numero di colonne da mostrare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

showRows(rowIndex)

Mostra la riga nell'indice specificato.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first row
sheet.showRows(1);

Parametri

NomeTipoDescrizione
rowIndexIntegerL'indice della riga da mostrare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

showRows(rowIndex, numRows)

Mostra una o più righe consecutive a partire dall'indice specificato.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three rows
sheet.showRows(1, 3);

Parametri

NomeTipoDescrizione
rowIndexIntegerL'indice iniziale delle righe da mostrare.
numRowsIntegerIl numero di righe da mostrare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

showSheet()

Rende visibile il foglio. Non ha alcun effetto se il foglio è già visibile.

const sheet = SpreadsheetApp.getActiveSheet();
sheet.showSheet();

Invio

Sheet: il foglio corrente.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

sort(columnPosition)

Ordina un foglio per colonna in ordine crescente.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Parametri

NomeTipoDescrizione
columnPositionIntegerLa colonna in base alla quale eseguire l'ordinamento.

Invio

Sheet: il foglio, utile per l'accodamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

sort(columnPosition, ascending)

Ordina un foglio per colonna. Accetta un parametro per specificare crescente o decrescente.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Parametri

NomeTipoDescrizione
columnPositionIntegerLa colonna in base alla quale eseguire l'ordinamento.
ascendingBooleantrue per l'ordinamento crescente, false per quello decrescente.

Invio

Sheet: il foglio, utile per l'accodamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

unhideColumn(column)

Mostra la colonna nell'intervallo specificato.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideColumn(range);

Parametri

NomeTipoDescrizione
columnRangeL'intervallo da mostrare, se nascosto.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

unhideRow(row)

Mostra la riga nell'intervallo specificato.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideRow(range);

Parametri

NomeTipoDescrizione
rowRangeL'intervallo da mostrare, se nascosto.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

updateChart(chart)

Aggiorna il grafico in questo foglio.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This code is going to loop through all the charts and change them to
// column charts
const charts = sheet.getCharts();
for (const i in charts) {
  const chart = charts[i];
  const newChart = chart.modify().setChartType(Charts.ChartType.COLUMN).build();
  sheet.updateChart(newChart);
}

Parametri

NomeTipoDescrizione
chartEmbeddedChartIl grafico da aggiornare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Metodi ritirati