otwierać i modyfikować istniejący arkusz źródła danych, Aby utworzyć nowy arkusz źródła danych, użyj funkcji Spreadsheet.insertDataSourceSheet(spec)
.
Używaj tej klasy tylko z danymi połączonymi z bazą danych.
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addFilter(columnName, filterCriteria) | DataSourceSheet | Dodaje filtr zastosowany do arkusza źródła danych. |
asSheet() | Sheet | Zwraca arkusz źródła danych jako zwykły obiekt arkusza. |
autoResizeColumn(columnName) | DataSourceSheet | Automatycznie zmienia szerokość określonej kolumny. |
autoResizeColumns(columnNames) | DataSourceSheet | Automatycznie zmienia szerokość określonych kolumn. |
cancelDataRefresh() | DataSourceSheet | anuluje odświeżanie danych powiązane z tym obiektem, jeśli jest obecnie uruchomione. |
forceRefreshData() | DataSourceSheet | Odświeża dane tego obiektu niezależnie od bieżącego stanu. |
getColumnWidth(columnName) | Integer | Zwraca szerokość określonej kolumny. |
getDataSource() | DataSource | Pobiera źródło danych, z którym połączony jest obiekt. |
getFilters() | DataSourceSheetFilter[] | Zwraca wszystkie filtry zastosowane do arkusza źródła danych. |
getSheetValues(columnName) | Object[] | Zwraca wszystkie wartości z arkusza źródła danych dla podanej nazwy kolumny. |
getSheetValues(columnName, startRow, numRows) | Object[] | Zwraca wszystkie wartości w arkuszu źródła danych dla podanej nazwy kolumny od podanego wiersza startowego (-1) do podanego wiersza numRows . |
getSortSpecs() | SortSpec[] | Pobiera wszystkie specyfikacje sortowania z arkusza źródła danych. |
getStatus() | DataExecutionStatus | Pobiera stan wykonania danych obiektu. |
refreshData() | DataSourceSheet | Odświeża dane obiektu. |
removeFilters(columnName) | DataSourceSheet | Usuwa wszystkie filtry zastosowane do kolumny arkusza źródła danych. |
removeSortSpec(columnName) | DataSourceSheet | Usuwa specyfikację sortowania w kolumnie w arkuszu źródła danych. |
setColumnWidth(columnName, width) | DataSourceSheet | Ustawia szerokość określonej kolumny. |
setColumnWidths(columnNames, width) | DataSourceSheet | Ustawia szerokość określonych kolumn. |
setSortSpec(columnName, ascending) | DataSourceSheet | Określa specyfikację sortowania w kolumnie w arkuszu źródła danych. |
setSortSpec(columnName, sortOrder) | DataSourceSheet | Określa specyfikację sortowania w kolumnie w arkuszu źródła danych. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Czekam na zakończenie bieżącego wykonania, przekracza limit czasu po podanej liczbie sekund. |
Szczegółowa dokumentacja
addFilter(columnName, filterCriteria)
Dodaje filtr zastosowany do arkusza źródła danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny, do której chcesz zastosować ten filtr. |
filterCriteria | FilterCriteria | Kryteria filtrowania, które chcesz zastosować. |
Powrót
DataSourceSheet
– arkusz źródła danych, który służy do łańcuchowania metod.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
asSheet()
autoResizeColumn(columnName)
Automatycznie zmienia szerokość określonej kolumny.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny. |
Powrót
DataSourceSheet
– arkusz źródła danych służący do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeColumns(columnNames)
Automatycznie zmienia szerokość określonych kolumn.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnNames | String[] | Lista nazw kolumn do zaktualizowania. |
Powrót
DataSourceSheet
– arkusz źródła danych służący do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
cancelDataRefresh()
Anuluje odświeżanie danych powiązane z tym obiektem, jeśli jest on uruchomiony.
Ten przykład pokazuje, jak anulować odświeżenie formuły.
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
Zgłasza wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution()
, aby włączyć wykonywanie kodu dla określonego źródła danych
typu.
Powrót
DataSourceSheet
– obiekt danych.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
Odświeża dane tego obiektu niezależnie od jego bieżącego stanu. Zobacz refreshData()
:
. Jeśli chcesz anulować aktualnie wykonywane odświeżanie tego obiektu, zapoznaj się z artykułem cancelDataRefresh()
.
Zgłasza wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution()
, aby włączyć wykonywanie kodu dla określonego źródła danych
typu.
Powrót
DataSourceSheet
– obiekt danych.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnWidth(columnName)
Zwraca szerokość określonej kolumny.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny. |
Powrót
Integer
– szerokość kolumny lub null
, jeśli kolumna ma szerokość domyślną.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSource()
Pobiera źródło danych, z którym jest połączony obiekt.
Powrót
DataSource
– źródło danych.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilters()
Zwraca wszystkie filtry zastosowane w arkuszu źródła danych.
Powrót
DataSourceSheetFilter[]
– tablica wszystkich filtrów zastosowanych do arkusza źródła danych.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetValues(columnName)
Zwraca wszystkie wartości z arkusza źródła danych dla podanej nazwy kolumny.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny źródła danych, dla której mają zostać pobrane wartości. |
Powrót
Object[]
– jednowymiarowa tablica wartości.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetValues(columnName, startRow, numRows)
Zwraca wszystkie wartości z arkusza źródła danych dla podanej nazwy kolumny z podanego
wiersza początkowego (w oparciu o -1) do podanej wartości numRows
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny źródła danych, dla której mają zostać pobrane wartości. |
startRow | Integer | Pozycja wiersza, od której ma się rozpoczynać pobieranie wartości. |
numRows | Integer | Liczba wierszy do pobrania. |
Powrót
Object[]
– jednowymiarowa tablica wartości.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSortSpecs()
Pobiera wszystkie specyfikacje sortowania z arkusza źródła danych.
Powrót
SortSpec[]
– lista specyfikacji sortowania.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getStatus()
Pobiera stan wykonania danych obiektu.
Powrót
DataExecutionStatus
– stan wykonania kodu.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
refreshData()
Odświeża dane obiektu.
Zgłasza wyjątek, jeśli obecnie jest w stanie error
. Aby zaktualizować specyfikację, użyj polecenia DataSource#updateSpec()
. Metoda
preferowana niż forceRefreshData()
, aby zapobiec nieoczekiwanym edytowaniu źródła danych.
Wyjątek jest zgłaszany, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution()
, aby włączyć wykonywanie kodu dla określonego źródła danych
typu.
Powrót
DataSourceSheet
– obiekt danych.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeFilters(columnName)
Usuwa wszystkie filtry zastosowane do kolumny arkusza źródła danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny, z której chcesz usunąć filtry. |
Powrót
DataSourceSheet
– arkusz źródła danych służący do tworzenia łańcuchów metod.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeSortSpec(columnName)
Usuwa specyfikację sortowania w kolumnie w arkuszu źródła danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny. |
Powrót
DataSourceSheet
– arkusz źródła danych służący do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidth(columnName, width)
Ustawia szerokość określonej kolumny.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny. |
width | Integer | Nowa szerokość kolumny. |
Powrót
DataSourceSheet
– arkusz źródła danych służący do tworzenia łańcuchów.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidths(columnNames, width)
Ustawia szerokość określonych kolumn.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnNames | String[] | Lista nazw kolumn do zaktualizowania. |
width | Integer | Nowa szerokość kolumn. |
Powrót
DataSourceSheet
– arkusz źródła danych służący do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSortSpec(columnName, ascending)
Ustawia specyfikację sortowania w kolumnie w arkuszu źródła danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny do sortowania. |
ascending | Boolean | Jeśli true , posortuj kolumnę w kolejności rosnącej, a jeśli false – w kolejności malejącej. |
Powrót
DataSourceSheet
– arkusz źródła danych służący do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSortSpec(columnName, sortOrder)
Określa specyfikację sortowania w kolumnie w arkuszu źródła danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny, którą chcesz posortować. |
sortOrder | SortOrder | Kolejność sortowania. |
Powrót
DataSourceSheet
– arkusz źródła danych służący do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
Czekam na zakończenie bieżącego wykonania, przekracza limit czasu po podanej liczbie sekund. Wyjątek jest zwracany, jeśli wykonanie nie zostało ukończone, gdy upłynął limit czasu, ale nie anuluje wykonania danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
timeoutInSeconds | Integer | Czas oczekiwania na wykonanie bazy danych (w sekundach). Maksymalny czas trwania to 300 sekund. |
Powrót
DataExecutionStatus
– stan wykonania kodu.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets