Class DataSourceSheet

DataSourceSheet

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 i dati connessi a un database.

Metodi

MetodoTipo restituitoBreve descrizione
addFilter(columnName, filterCriteria)DataSourceSheetAggiunge un filtro applicato al foglio dell'origine dati.
asSheet()SheetRestituisce il foglio dell'origine dati come un normale oggetto foglio.
autoResizeColumn(columnName)DataSourceSheetRidimensiona automaticamente la larghezza della colonna specificata.
autoResizeColumns(columnNames)DataSourceSheetRidimensiona automaticamente la larghezza delle colonne specificate.
cancelDataRefresh()DataSourceSheetAnnulla l'aggiornamento dei dati associato a questo oggetto, se è attualmente in esecuzione.
forceRefreshData()DataSourceSheetAggiorna i dati di questo oggetto indipendentemente dallo stato attuale.
getColumnWidth(columnName)Integer|nullRestituisce la larghezza della colonna specificata.
getDataSource()DataSourceRecupera 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 dalla riga iniziale fornita (in base a 1) fino al numRows fornito.
getSortSpecs()SortSpec[]Recupera tutte le specifiche di ordinamento nel foglio dell'origine dati.
getStatus()DataExecutionStatusRecupera lo stato di esecuzione dei dati dell'oggetto.
refreshData()DataSourceSheetAggiorna i dati dell'oggetto.
removeFilters(columnName)DataSourceSheetRimuove tutti i filtri applicati alla colonna del foglio dell'origine dati.
removeSortSpec(columnName)DataSourceSheetRimuove la specifica di ordinamento di una colonna nel foglio dell'origine dati.
setColumnWidth(columnName, width)DataSourceSheetImposta la larghezza della colonna specificata.
setColumnWidths(columnNames, width)DataSourceSheetImposta la larghezza delle colonne specificate.
setSortSpec(columnName, ascending)DataSourceSheetImposta la specifica di ordinamento su una colonna nel foglio dell'origine dati.
setSortSpec(columnName, sortOrder)DataSourceSheetImposta la specifica di ordinamento su una colonna nel foglio dell'origine dati.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAttende il completamento dell'esecuzione corrente, con timeout dopo il numero di secondi fornito.

Documentazione dettagliata

addFilter(columnName, filterCriteria)

Aggiunge un filtro applicato al foglio dell'origine dati.

Parametri

NomeTipoDescrizione
columnNameStringIl nome della colonna a cui applicare questo filtro.
filterCriteriaFilterCriteriaI criteri di filtro da applicare.

Indietro

DataSourceSheet: il 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 foglio.

Indietro

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

NomeTipoDescrizione
columnNameStringIl nome della colonna.

Indietro

DataSourceSheet: questo 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

NomeTipoDescrizione
columnNamesString[]L'elenco dei nomi delle colonne da aggiornare.

Indietro

DataSourceSheet: questo 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 a questo oggetto, se è attualmente in esecuzione.

Questo esempio mostra come annullare l'aggiornamento di una 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 tipo specifico di origine dati.

Indietro

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 di questo oggetto indipendentemente dallo stato attuale. Per maggiori dettagli, consulta refreshData(). Se vuoi annullare un aggiornamento in corso 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 tipo specifico di origine dati.

Indietro

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

NomeTipoDescrizione
columnNameStringIl nome della colonna.

Indietro

Integer|null: 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.

Indietro

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.

Indietro

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

NomeTipoDescrizione
columnNameStringIl nome della colonna dell'origine dati da cui recuperare i valori.

Indietro

Object[]: una matrice unidimensionale 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

getSheetValues(columnName, startRow, numRows)

Restituisce tutti i valori del foglio dell'origine dati per il nome della colonna fornito dalla riga iniziale fornita (in base a 1) fino al numRows fornito.

Parametri

NomeTipoDescrizione
columnNameStringIl nome della colonna dell'origine dati da cui recuperare i valori.
startRowIntegerLa posizione della riga da cui iniziare a recuperare i valori.
numRowsIntegerIl numero di righe da recuperare.

Indietro

Object[]: una matrice unidimensionale 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

getSortSpecs()

Recupera tutte le specifiche di ordinamento nel foglio dell'origine dati.

Indietro

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()

Recupera lo stato di esecuzione dei dati dell'oggetto.

Indietro

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 si trova nello stato error. Utilizza DataSource#updateSpec() per aggiornare la specifica. Questo metodo è preferibile 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 tipo specifico di origine dati.

Indietro

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

NomeTipoDescrizione
columnNameStringIl nome della colonna da cui rimuovere i filtri.

Indietro

DataSourceSheet: il 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 di una colonna nel foglio dell'origine dati.

Parametri

NomeTipoDescrizione
columnNameStringIl nome della colonna.

Indietro

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

NomeTipoDescrizione
columnNameStringIl nome della colonna.
widthIntegerLa nuova larghezza della colonna.

Indietro

DataSourceSheet: questo 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

NomeTipoDescrizione
columnNamesString[]L'elenco dei nomi delle colonne da aggiornare.
widthIntegerLa nuova larghezza delle colonne.

Indietro

DataSourceSheet: questo 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

NomeTipoDescrizione
columnNameStringIl nome della colonna da ordinare.
ascendingBooleanSe true, ordina la colonna in ordine crescente; se false, ordina la colonna in ordine decrescente.

Indietro

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

NomeTipoDescrizione
columnNameStringIl nome della colonna da ordinare.
sortOrderSortOrderL'ordinamento.

Indietro

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 fornito. Genera un'eccezione se l'esecuzione non viene completata al momento del timeout, ma non annulla l'esecuzione dei dati.

Parametri

NomeTipoDescrizione
timeoutInSecondsIntegerIl tempo di attesa per l'esecuzione dei dati, in secondi. Il valore massimo è 300 secondi.

Indietro

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