Accedere al foglio dell'origine dati esistente e modificarlo. Per creare un nuovo foglio dell'origine dati, utilizza Spreadsheet.insertDataSourceSheet(spec)
.
Utilizza questa classe solo con dati collegati a un database.
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
addFilter(columnName, filterCriteria) | DataSourceSheet | Aggiunge un filtro applicato al foglio dell'origine dati. |
asSheet() | Sheet | Restituisce il foglio dell'origine dati come un normale oggetto del foglio. |
autoResizeColumn(columnName) | DataSourceSheet | Ridimensiona automaticamente la larghezza della colonna specificata. |
autoResizeColumns(columnNames) | DataSourceSheet | Ridimensiona automaticamente la larghezza delle colonne specificate. |
cancelDataRefresh() | DataSourceSheet | Annulla l'aggiornamento dei dati associato all'oggetto se è attualmente in esecuzione. |
forceRefreshData() | DataSourceSheet | Aggiorna i dati dell'oggetto indipendentemente dallo stato attuale. |
getColumnWidth(columnName) | Integer | Restituisce la larghezza della colonna specificata. |
getDataSource() | DataSource | Recupera l'origine dati a cui è collegato l'oggetto. |
getFilters() | DataSourceSheetFilter[] | Restituisce tutti i filtri applicati al foglio dell'origine dati. |
getSheetValues(columnName) | Object[] | Restituisce tutti i valori del foglio dell'origine dati per il nome della colonna fornito. |
getSheetValues(columnName, startRow, numRows) | Object[] | Restituisce tutti i valori del foglio dell'origine dati per il nome della colonna fornito a partire dal
riga iniziale (in base-1) e fino al valore numRows specificato. |
getSortSpecs() | SortSpec[] | Ottiene tutte le specifiche di ordinamento nel foglio dell'origine dati. |
getStatus() | DataExecutionStatus | Restituisce lo stato di esecuzione dei dati dell'oggetto. |
refreshData() | DataSourceSheet | Aggiorna i dati dell'oggetto. |
removeFilters(columnName) | DataSourceSheet | Rimuove tutti i filtri applicati alla colonna del foglio dell'origine dati. |
removeSortSpec(columnName) | DataSourceSheet | Rimuove la specifica di ordinamento in una colonna nel foglio dell'origine dati. |
setColumnWidth(columnName, width) | DataSourceSheet | Imposta la larghezza della colonna specificata. |
setColumnWidths(columnNames, width) | DataSourceSheet | Imposta la larghezza delle colonne specificate. |
setSortSpec(columnName, ascending) | DataSourceSheet | Imposta la specifica di ordinamento su una colonna nel foglio dell'origine dati. |
setSortSpec(columnName, sortOrder) | DataSourceSheet | Imposta la specifica di ordinamento su una colonna nel foglio dell'origine dati. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Attende il completamento dell'esecuzione corrente, con timeout dopo il numero di secondi specificato. |
Documentazione dettagliata
addFilter(columnName, filterCriteria)
Aggiunge un filtro applicato al foglio dell'origine dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna a cui applicare questo filtro. |
filterCriteria | FilterCriteria | I criteri di filtro da applicare. |
Invio
DataSourceSheet
: foglio dell'origine dati per il concatenamento 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
asSheet()
Restituisce il foglio dell'origine dati come un normale oggetto del foglio.
Invio
Sheet
: il foglio normale.
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(columnName)
Ridimensiona automaticamente la larghezza della colonna specificata.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna. |
Invio
DataSourceSheet
: foglio dell'origine dati per il concatenamento.
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(columnNames)
Ridimensiona automaticamente la larghezza delle colonne specificate.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnNames | String[] | L'elenco dei nomi delle colonne da aggiornare. |
Invio
DataSourceSheet
: foglio dell'origine dati per il concatenamento.
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
cancelDataRefresh()
Annulla l'aggiornamento dei dati associato all'oggetto se è attualmente in esecuzione.
Questo esempio mostra come annullare un aggiornamento della formula.
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
Genera un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi
SpreadsheetApp#enable...Execution()
per attivare l'esecuzione dei dati per un'origine dati specifica
di testo.
Invio
DataSourceSheet
: l'oggetto 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
forceRefreshData()
Aggiorna i dati dell'oggetto indipendentemente dallo stato attuale. Vedi refreshData()
per
ulteriori dettagli. Se vuoi annullare un aggiornamento attualmente in esecuzione di questo oggetto, consulta cancelDataRefresh()
.
Genera un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution()
per attivare l'esecuzione dei dati per un'origine dati specifica
di testo.
Invio
DataSourceSheet
: l'oggetto 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
getColumnWidth(columnName)
Restituisce la larghezza della colonna specificata.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna. |
Invio
Integer
: la larghezza della colonna o null
se la colonna utilizza la larghezza predefinita.
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
getDataSource()
Recupera l'origine dati a cui è collegato l'oggetto.
Invio
DataSource
: l'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
getFilters()
Restituisce tutti i filtri applicati al foglio dell'origine dati.
Invio
DataSourceSheetFilter[]
: un array di tutti i filtri applicati al foglio 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
getSheetValues(columnName)
Restituisce tutti i valori del foglio dell'origine dati per il nome della colonna fornito.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna dell'origine dati per cui recuperare i valori. |
Invio
Object[]
: un array di valori unidimensionale.
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(columnName, startRow, numRows)
Restituisce tutti i valori del foglio dell'origine dati per il nome della colonna fornito a partire dal
riga iniziale (in base-1) e fino al valore numRows
specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna dell'origine dati per cui recuperare i valori. |
startRow | Integer | La posizione della riga da cui iniziare a recuperare i valori. |
numRows | Integer | Il numero di righe da recuperare. |
Invio
Object[]
: un array di valori unidimensionale.
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
getSortSpecs()
Ottiene tutte le specifiche di ordinamento nel foglio dell'origine dati.
Invio
SortSpec[]
: un elenco di specifiche di ordinamento.
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
getStatus()
Restituisce lo stato di esecuzione dei dati dell'oggetto.
Invio
DataExecutionStatus
: lo stato di esecuzione dei 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
refreshData()
Aggiorna i dati dell'oggetto.
Genera un'eccezione se attualmente è nello stato error
. Utilizza DataSource#updateSpec()
per aggiornare la specifica. Il metodo è
preferito rispetto a forceRefreshData()
per evitare modifiche impreviste all'origine dati.
Genera un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution()
per attivare l'esecuzione dei dati per un'origine dati specifica
di testo.
Invio
DataSourceSheet
: l'oggetto 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
removeFilters(columnName)
Rimuove tutti i filtri applicati alla colonna del foglio dell'origine dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna da cui rimuovere i filtri. |
Invio
DataSourceSheet
: foglio dell'origine dati per il concatenamento 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
removeSortSpec(columnName)
Rimuove la specifica di ordinamento in una colonna nel foglio dell'origine dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna. |
Invio
DataSourceSheet
: il foglio dell'origine dati, per il concatenamento.
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(columnName, width)
Imposta la larghezza della colonna specificata.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna. |
width | Integer | La nuova larghezza della colonna. |
Invio
DataSourceSheet
: foglio dell'origine dati per il concatenamento.
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(columnNames, width)
Imposta la larghezza delle colonne specificate.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnNames | String[] | L'elenco dei nomi delle colonne da aggiornare. |
width | Integer | La nuova larghezza delle colonne. |
Invio
DataSourceSheet
: foglio dell'origine dati per il concatenamento.
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
setSortSpec(columnName, ascending)
Imposta la specifica di ordinamento su una colonna nel foglio dell'origine dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna da ordinare. |
ascending | Boolean | Se true , ordina la colonna in ordine crescente; se false , ordina
la colonna in ordine decrescente. |
Invio
DataSourceSheet
: il foglio dell'origine dati, per il concatenamento.
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
setSortSpec(columnName, sortOrder)
Imposta la specifica di ordinamento su una colonna nel foglio dell'origine dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna da ordinare. |
sortOrder | SortOrder | L'ordinamento. |
Invio
DataSourceSheet
: il foglio dell'origine dati, per il concatenamento.
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
waitForCompletion(timeoutInSeconds)
Attende il completamento dell'esecuzione corrente, con timeout dopo il numero di secondi specificato. Genera un'eccezione se l'esecuzione non viene completata in caso di timeout, ma non annulla l'evento nell'esecuzione dei dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
timeoutInSeconds | Integer | Il tempo di attesa dell'esecuzione dei dati, in secondi. Il numero massimo è 300 secondi. |
Invio
DataExecutionStatus
: lo stato di esecuzione dei 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