uzyskiwać dostęp do arkuszy kalkulacyjnych i je modyfikować; Typowe operacje to zmiana nazwy arkusza i dostęp do zakresów obiektów z arkusza.
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
activate() | Sheet | Aktywuje ten arkusz. |
addDeveloperMetadata(key) | Sheet | Dodaje do arkusza metadane dewelopera z określonym kluczem. |
addDeveloperMetadata(key, visibility) | Sheet | Dodaje do arkusza metadane dewelopera z określonym kluczem i widocznością. |
addDeveloperMetadata(key, value) | Sheet | Dodaje do arkusza metadane dewelopera z określonym kluczem i wartością. |
addDeveloperMetadata(key, value, visibility) | Sheet | Dodaje do arkusza metadane dewelopera z określonym kluczem, wartością i widocznością. |
appendRow(rowContents) | Sheet | Dodaje wiersz na dole bieżącego regionu danych w arkuszu. |
asDataSourceSheet() | DataSourceSheet | Zwraca arkusz jako DataSourceSheet , jeśli jest on typu SheetType.DATASOURCE , lub null w przeciwnym razie. |
autoResizeColumn(columnPosition) | Sheet | Ustawia szerokość danej kolumny tak, aby pasowała do jej zawartości. |
autoResizeColumns(startColumn, numColumns) | Sheet | Ustawia szerokość wszystkich kolumn, zaczynając od danej pozycji kolumny, tak aby pasowały do ich zawartości. |
autoResizeRows(startRow, numRows) | Sheet | Ustawia wysokość wszystkich wierszy, zaczynając od podanej pozycji wiersza, tak aby pasowały do ich zawartości. |
clear() | Sheet | Czyści arkusz z treści i informacji o formatowaniu. |
clear(options) | Sheet | Czyści arkusz ze spisu treści lub formatu zgodnie z danymi opcjami zaawansowanymi. |
clearConditionalFormatRules() | void | usuwa z arkusza wszystkie reguły formatowania warunkowego. |
clearContents() | Sheet | Czyści arkusz ze spisu treści, zachowując informacje o formatowaniu. |
clearFormats() | Sheet | Usuwa formatowanie arkusza, zachowując zawartość. |
clearNotes() | Sheet | Usuwa wszystkie notatki z arkusza. |
collapseAllColumnGroups() | Sheet | Zwija wszystkie grupy kolumn w arkuszu. |
collapseAllRowGroups() | Sheet | Zwija wszystkie grupy wierszy w arkuszu. |
copyTo(spreadsheet) | Sheet | Skopiuj arkusz do podanego arkusza kalkulacyjnego, który może być tym samym arkuszem co źródło. |
createDeveloperMetadataFinder() | DeveloperMetadataFinder | Zwraca DeveloperMetadataFinder dla metadanych dewelopera w zakresie tego arkusza. |
createTextFinder(findText) | TextFinder | Tworzy wyszukiwarkę tekstu dla arkusza, która może znajdować i zastępować tekst w arkuszu. |
deleteColumn(columnPosition) | Sheet | Usuwa kolumnę w danej pozycji. |
deleteColumns(columnPosition, howMany) | void | Usuwa określoną liczbę kolumn, zaczynając od podanej pozycji kolumny. |
deleteRow(rowPosition) | Sheet | Usuwa wiersz na podanej pozycji. |
deleteRows(rowPosition, howMany) | void | Usuwa określoną liczbę wierszy, rozpoczynając od podanej pozycji wiersza. |
expandAllColumnGroups() | Sheet | Rozwija wszystkie grupy kolumn w arkuszu. |
expandAllRowGroups() | Sheet | Rozwija wszystkie grupy wierszy w arkuszu. |
expandColumnGroupsUpToDepth(groupDepth) | Sheet | Rozwija wszystkie grupy kolumn do określonej głębokości, a pozostałe zwinięte. |
expandRowGroupsUpToDepth(groupDepth) | Sheet | Rozwija wszystkie grupy wierszy do podanej głębokości, a pozostałe zwija. |
getActiveCell() | Range | Zwraca aktywną komórkę w tym arkuszu. |
getActiveRange() | Range | Zwraca wybrany zakres na aktywnym arkuszu lub null , jeśli nie ma aktywnego zakresu. |
getActiveRangeList() | RangeList | Zwraca listę aktywnych zakresów na aktywnym arkuszu lub null , jeśli nie ma aktywnych zakresów. |
getBandings() | Banding[] | Zwraca wszystkie pasma na tym arkuszu. |
getCharts() | EmbeddedChart[] | Zwraca tablicę wykresów na tym arkuszu. |
getColumnGroup(columnIndex, groupDepth) | Group | Zwraca grupę kolumn o danym indeksie i głębokości grupy. |
getColumnGroupControlPosition() | GroupControlTogglePosition | Zwraca GroupControlTogglePosition dla wszystkich grup kolumn w arkuszu. |
getColumnGroupDepth(columnIndex) | Integer | Zwraca głębokość grupy kolumny w podanym indeksie. |
getColumnWidth(columnPosition) | Integer | Pobiera szerokość danej kolumny w pikselach. |
getConditionalFormatRules() | ConditionalFormatRule[] | Pobierz wszystkie reguły formatowania warunkowego w tym arkuszu. |
getCurrentCell() | Range | Zwraca bieżącą komórkę na aktywnym arkuszu lub null , jeśli nie ma bieżącej komórki. |
getDataRange() | Range | Zwraca Range odpowiadający wymiarom, w których znajdują się dane. |
getDataSourceFormulas() | DataSourceFormula[] | Pobiera wszystkie formuły źródeł danych. |
getDataSourcePivotTables() | DataSourcePivotTable[] | Pobiera wszystkie tabele przestawne źródła danych. |
getDataSourceTables() | DataSourceTable[] | Pobiera wszystkie tabele źródeł danych. |
getDeveloperMetadata() | DeveloperMetadata[] | Pobierz wszystkie metadane dewelopera powiązane z tym arkuszem. |
getDrawings() | Drawing[] | Zwraca tablicę rysunków na arkuszu. |
getFilter() | Filter | Zwraca filtr na tym arkuszu lub null , jeśli nie ma filtra. |
getFormUrl() | String | Zwraca adres URL formularza, który wysyła odpowiedzi do tego arkusza, lub null , jeśli z arkuszem nie jest powiązany żaden formularz. |
getFrozenColumns() | Integer | Zwraca liczbę zablokowanych kolumn. |
getFrozenRows() | Integer | Zwraca liczbę zablokowanych wierszy. |
getImages() | OverGridImage[] | Zwraca wszystkie obrazy na siatce w arkuszu. |
getIndex() | Integer | Pobiera pozycję arkusza w arkuszu nadrzędnym. |
getLastColumn() | Integer | Zwraca pozycję ostatniej kolumny, która zawiera dane. |
getLastRow() | Integer | Zwraca pozycję ostatniego wiersza, który zawiera dane. |
getMaxColumns() | Integer | Zwraca bieżącą liczbę kolumn w arkuszu niezależnie od ich zawartości. |
getMaxRows() | Integer | Zwraca bieżącą liczbę wierszy w arkuszu niezależnie od ich zawartości. |
getName() | String | Zwraca nazwę arkusza. |
getNamedRanges() | NamedRange[] | Pobiera wszystkie zakresy nazwane na tym arkuszu. |
getParent() | Spreadsheet | Zwraca Spreadsheet zawierający ten arkusz. |
getPivotTables() | PivotTable[] | Zwraca wszystkie tabele przestawne na tym arkuszu. |
getProtections(type) | Protection[] | Pobiera tablicę obiektów reprezentujących wszystkie chronione zakresy w arkuszu lub tablicę o jednym elemencie reprezentującą ochronę samego arkusza. |
getRange(row, column) | Range | Zwraca zakres z komórką w lewym górnym rogu o podanych współrzędnych. |
getRange(row, column, numRows) | Range | Zwraca zakres z komórką w lewym górnym rogu o podanych współrzędnych i podanej liczbie wierszy. |
getRange(row, column, numRows, numColumns) | Range | Zwraca zakres z komórką w lewym górnym rogu o podanych współrzędnych i podanej liczbie wierszy oraz kolumn. |
getRange(a1Notation) | Range | Zwraca zakres określony w notacji A1 lub R1C1. |
getRangeList(a1Notations) | RangeList | Zwraca kolekcję RangeList reprezentującą zakresy na tym samym arkuszu, określone przez niepustą listę zapisów A1 lub R1C1. |
getRowGroup(rowIndex, groupDepth) | Group | Zwraca grupę wierszy o danym indeksie i głębokości grupy. |
getRowGroupControlPosition() | GroupControlTogglePosition | Zwraca GroupControlTogglePosition dla wszystkich grup wierszy w arkuszu. |
getRowGroupDepth(rowIndex) | Integer | Zwraca głębokość grupy wiersza o podanym indeksie. |
getRowHeight(rowPosition) | Integer | Pobiera wysokość danego wiersza w pikselach. |
getSelection() | Selection | Zwraca bieżącą wartość Selection w arkuszu kalkulacyjnym. |
getSheetId() | Integer | Zwraca identyfikator arkusza reprezentowanego przez ten obiekt. |
getSheetName() | String | Zwraca nazwę arkusza. |
getSheetValues(startRow, startColumn, numRows, numColumns) | Object[][] | Zwraca prostokątną siatkę wartości dla tego zakresu, rozpoczynając od podanych współrzędnych. |
getSlicers() | Slicer[] | Zwraca tablicę selektorów na arkuszu. |
getTabColorObject() | Color | Pobiera kolor karty arkusza lub null , jeśli karta arkusza nie ma koloru. |
getType() | SheetType | Zwraca typ arkusza. |
hasHiddenGridlines() | Boolean | Zwraca true , jeśli linie siatki arkusza są ukryte; w przeciwnym razie zwraca false . |
hideColumn(column) | void | Ukrywa kolumnę lub kolumny w podanym zakresie. |
hideColumns(columnIndex) | void | Ukrywa jedną kolumnę o danym indeksie. |
hideColumns(columnIndex, numColumns) | void | Ukrywa co najmniej 1 kolumnę licząc od podanego indeksu. |
hideRow(row) | void | Ukrywa wiersze w podanym zakresie. |
hideRows(rowIndex) | void | Ukrywa wiersz o podanym indeksie. |
hideRows(rowIndex, numRows) | void | Ukrywa co najmniej 1 ciągły wiersz, zaczynając od podanego indeksu. |
hideSheet() | Sheet | Ukrywa ten arkusz. |
insertChart(chart) | void | Dodaje nowy wykres do tego arkusza. |
insertColumnAfter(afterPosition) | Sheet | Wstawia kolumnę po podanej kolumnie. |
insertColumnBefore(beforePosition) | Sheet | Wstawia kolumnę przed podaną pozycją kolumny. |
insertColumns(columnIndex) | void | Wstawia pustą kolumnę w arkuszu w określonym miejscu. |
insertColumns(columnIndex, numColumns) | void | Wstawia co najmniej 1 kolejną pustą kolumnę w arkuszu, zaczynając od określonej lokalizacji. |
insertColumnsAfter(afterPosition, howMany) | Sheet | Wstawia określoną liczbę kolumn po podanej kolumnie. |
insertColumnsBefore(beforePosition, howMany) | Sheet | Wstawia określoną liczbę kolumn przed podaną pozycją kolumny. |
insertImage(blobSource, column, row) | OverGridImage | Wstawia BlobSource jako obraz w dokumencie w danym wierszu i kolumnie. |
insertImage(blobSource, column, row, offsetX, offsetY) | OverGridImage | Wstawia BlobSource jako obraz w dokumencie w danym wierszu i kolumnie z przesunięciem o pewną liczbę pikseli. |
insertImage(url, column, row) | OverGridImage | Wstawia obraz w dokumencie w danym wierszu i kolumnie. |
insertImage(url, column, row, offsetX, offsetY) | OverGridImage | Wstawia obraz w dokumencie w danym wierszu i kolumnie z przesunięciem o piksele. |
insertRowAfter(afterPosition) | Sheet | Wstawia wiersz po podanej pozycji wiersza. |
insertRowBefore(beforePosition) | Sheet | Wstawia wiersz przed podaną pozycją wiersza. |
insertRows(rowIndex) | void | Wstawia pusty wiersz w arkuszu w określonym miejscu. |
insertRows(rowIndex, numRows) | void | Wstawia na arkuszu co najmniej 1 ciągły pusty wiersz, zaczynając od określonej lokalizacji. |
insertRowsAfter(afterPosition, howMany) | Sheet | Wstawia określoną liczbę wierszy po podanej pozycji wiersza. |
insertRowsBefore(beforePosition, howMany) | Sheet | Wstawia określoną liczbę wierszy przed podaną pozycją wiersza. |
insertSlicer(range, anchorRowPos, anchorColPos) | Slicer | Dodaje do tego arkusza nowy moduł Slicer. |
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | Dodaje do tego arkusza nowy filtr. |
isColumnHiddenByUser(columnPosition) | Boolean | Zwraca informacje o tym, czy dana kolumna jest ukryta przez użytkownika. |
isRightToLeft() | Boolean | Zwraca true , jeśli układ arkusza jest od prawej do lewej. |
isRowHiddenByFilter(rowPosition) | Boolean | Zwraca wartość wskazującą, czy dany wiersz jest ukryty przez filtr (a nie przez widok filtra). |
isRowHiddenByUser(rowPosition) | Boolean | Zwraca informację, czy dany wiersz jest ukryty przez użytkownika. |
isSheetHidden() | Boolean | Zwraca wartość true , jeśli arkusz jest obecnie ukryty. |
moveColumns(columnSpec, destinationIndex) | void | Przenosi kolumny wybrane przez dany zakres do pozycji wskazanej przez destinationIndex . |
moveRows(rowSpec, destinationIndex) | void | Przenosi wiersze wybrane przez dany zakres do pozycji wskazanej przez destinationIndex . |
newChart() | EmbeddedChartBuilder | Zwraca kreator do tworzenia nowego wykresu w tym arkuszu. |
protect() | Protection | Tworzy obiekt, który może chronić arkusz przed edytowaniem przez użytkowników, którzy nie mają uprawnień. |
removeChart(chart) | void | usuwa wykres z arkusza nadrzędnego. |
setActiveRange(range) | Range | Ustawia określony zakres jako active range w aktywnym arkuszu, przy czym lewa górna komórka zakresu jest current cell . |
setActiveRangeList(rangeList) | RangeList | Ustawia określoną listę zakresów jako active ranges w aktywnym arkuszu. |
setActiveSelection(range) | Range | Określa aktywny obszar zaznaczenia na tym arkuszu. |
setActiveSelection(a1Notation) | Range | Ustawia aktywny zakres zaznaczania zgodnie z notacją A1 lub R1C1. |
setColumnGroupControlPosition(position) | Sheet | Określa pozycję przełącznika kontrolującego grupę kolumn na arkuszu. |
setColumnWidth(columnPosition, width) | Sheet | Ustawia szerokość danej kolumny w pikselach. |
setColumnWidths(startColumn, numColumns, width) | Sheet | Ustawia szerokość podanych kolumn w pikselach. |
setConditionalFormatRules(rules) | void | Zastępuje wszystkie istniejące reguły formatowania warunkowego na arkuszu regułami wejściowymi. |
setCurrentCell(cell) | Range | Ustawia wskazaną komórkę jako current cell . |
setFrozenColumns(columns) | void | Blokuje podany numer kolumn. |
setFrozenRows(rows) | void | Blokuje podany numer wiersza. |
setHiddenGridlines(hideGridlines) | Sheet | Ukrywa lub ujawnia linie siatki arkusza. |
setName(name) | Sheet | Ustawia nazwę arkusza. |
setRightToLeft(rightToLeft) | Sheet | Ustawia lub odznacza układ arkusza od prawej do lewej. |
setRowGroupControlPosition(position) | Sheet | Określa pozycję przełącznika grupy wierszy na arkuszu. |
setRowHeight(rowPosition, height) | Sheet | Ustawia wysokość wiersza w pikselach. |
setRowHeights(startRow, numRows, height) | Sheet | Ustawia wysokość podanych wierszy w pikselach. |
setRowHeightsForced(startRow, numRows, height) | Sheet | Ustawia wysokość podanych wierszy w pikselach. |
setTabColor(color) | Sheet | Ustawia kolor karty arkusza. |
setTabColorObject(color) | Sheet | Ustawia kolor karty arkusza. |
showColumns(columnIndex) | void | Odkrywa kolumnę o danym indeksie. |
showColumns(columnIndex, numColumns) | void | Odkrywa co najmniej 1 kolejną kolumnę, licząc od podanego indeksu. |
showRows(rowIndex) | void | Odkrywa wiersz o danym indeksie. |
showRows(rowIndex, numRows) | void | Odsłania co najmniej 1 ciągły wiersz, zaczynając od podanego indeksu. |
showSheet() | Sheet | Sprawia, że arkusz jest widoczny. |
sort(columnPosition) | Sheet | Sortuje arkusz według kolumny w kolejności rosnącej. |
sort(columnPosition, ascending) | Sheet | Sortuje arkusz według kolumny. |
unhideColumn(column) | void | Odkrywa kolumnę w podanym zakresie. |
unhideRow(row) | void | Odkrywa wiersz w podanym zakresie. |
updateChart(chart) | void | Zaktualizuje wykres na tym arkuszu. |
Szczegółowa dokumentacja
activate()
Aktywuje ten arkusz. Nie zmienia arkusza, tylko pojęcie aktywnego arkusza w elemencie nadrzędnym.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.activate();
Powrót
Sheet
– nowo aktywny arkusz.
addDeveloperMetadata(key)
Dodaje do arkusza metadane dewelopera z określonym kluczem.
// 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());
Parametry
Nazwa | Typ | Opis |
---|---|---|
key | String | Klucz nowych metadanych dewelopera. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
addDeveloperMetadata(key, visibility)
Dodaje do arkusza metadane dewelopera z określonym kluczem i widocznością.
// 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());
Parametry
Nazwa | Typ | Opis |
---|---|---|
key | String | Klucz nowych metadanych dewelopera. |
visibility | DeveloperMetadataVisibility | widoczność nowych metadanych dewelopera. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
addDeveloperMetadata(key, value)
Dodaje do arkusza metadane dewelopera z określonym kluczem i wartością.
// 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());
Parametry
Nazwa | Typ | Opis |
---|---|---|
key | String | Klucz nowych metadanych dewelopera. |
value | String | Wartość nowych metadanych dewelopera. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
addDeveloperMetadata(key, value, visibility)
Dodaje do arkusza metadanych dewelopera z określonym kluczem, wartością i widocznością.
// 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());
Parametry
Nazwa | Typ | Opis |
---|---|---|
key | String | Klucz nowych metadanych dewelopera. |
value | String | Wartość nowych metadanych dewelopera. |
visibility | DeveloperMetadataVisibility | widoczność nowych metadanych dewelopera. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
appendRow(rowContents)
Dodaje wiersz na dole bieżącego regionu danych w arkuszu. Jeśli zawartość komórki zaczyna się od =
, jest interpretowana jako formuła.
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']);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowContents | Object[] | Tablica wartości do wstawienia po ostatnim wierszu w arkuszu. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod.
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
asDataSourceSheet()
Zwraca arkusz jako DataSourceSheet
, jeśli jest on typu SheetType.DATASOURCE
, lub null
w przeciwnym razie.
// 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());
Powrót
DataSourceSheet
– arkusz ź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
autoResizeColumn(columnPosition)
Ustawia szerokość danej kolumny tak, aby pasowała do jej zawartości.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnPosition | Integer | Pozycja kolumny, której rozmiar chcesz zmienić. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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
autoResizeColumns(startColumn, numColumns)
Ustawia szerokość wszystkich kolumn, zaczynając od danej pozycji kolumny, tak aby pasowały do ich zawartości.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
startColumn | Integer | Kolumna początkowa, której rozmiar ma być automatycznie zmieniany. |
numColumns | Integer | Liczba kolumn, których rozmiar ma być automatycznie zmieniany. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
autoResizeRows(startRow, numRows)
Ustawia wysokość wszystkich wierszy, zaczynając od podanej pozycji wiersza, tak aby pasowały do ich zawartości.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
startRow | Integer | Wiersz początkowy, który ma być automatycznie dostosowywany. |
numRows | Integer | Liczba wierszy, których rozmiar ma być automatycznie zmieniany. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
clear()
Czyści arkusz z treści i informacji o formatowaniu.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.clear();
Powrót
Sheet
– wyczyszczony arkusz.
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
clear(options)
Czyści arkusz ze spisu treści lub formatu zgodnie z danymi opcjami zaawansowanymi.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.clear({formatOnly: true, contentsOnly: true});
Parametry
Nazwa | Typ | Opis |
---|---|---|
options | Object | Mapa JavaScript zawierająca opcje zaawansowane, wymienione poniżej. |
Parametry zaawansowane
Nazwa | Typ | Opis |
---|---|---|
contentsOnly | Boolean | Czy usunąć zawartość. |
formatOnly | Boolean | Określa, czy usunąć formatowanie. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
clearConditionalFormatRules()
usuwa z arkusza wszystkie reguły formatowania warunkowego. Odpowiada wywołaniu funkcji setConditionalFormatRules(rules)
z pustą tablicą jako argumentem wejściowym.
const sheet = SpreadsheetApp.getActiveSheet(); sheet.clearConditionalFormatRules();
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
clearContents()
Czyści arkusz ze spisu treści, zachowując informacje o formatowaniu.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.clearContents();
Powrót
Sheet
– ten arkusz, do łańcucha.
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
clearFormats()
Usuwa formatowanie arkusza, zachowując zawartość.
Formatowanie odnosi się do sposobu formatowania danych zgodnie z opcjami w menu „Formatowanie” (np. pogrubienie, kursywa, formatowanie warunkowe), a nie do szerokości lub wysokości komórek.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.clearFormats();
Powrót
Sheet
– ten arkusz, do łańcucha.
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
clearNotes()
Usuwa wszystkie notatki z arkusza.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.clearNotes();
Powrót
Sheet
– ten arkusz, do łańcucha.
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
collapseAllColumnGroups()
Zwija wszystkie grupy kolumn w arkuszu.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are collapsed. sheet.collapseAllColumnGroups();
Powrót
Sheet
– ten arkusz, do łańcucha.
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
collapseAllRowGroups()
Zwija wszystkie grupy wierszy w arkuszu.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are collapsed. sheet.collapseAllRowGroups();
Powrót
Sheet
– ten arkusz, do łańcucha.
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
copyTo(spreadsheet)
Skopiuj arkusz do podanego arkusza kalkulacyjnego, który może być tym samym arkuszem co źródło. Skopiowany arkusz ma nazwę „Kopia [nazwa oryginalna]”.
const source = SpreadsheetApp.getActiveSpreadsheet(); const sheet = source.getSheets()[0]; const destination = SpreadsheetApp.openById('ID_GOES HERE'); sheet.copyTo(destination);
Parametry
Nazwa | Typ | Opis |
---|---|---|
spreadsheet | Spreadsheet | Arkusz kalkulacyjny, do którego chcesz skopiować ten arkusz. Może to być ten sam arkusz kalkulacyjny co źródło. |
Powrót
Sheet
– nowy arkusz, do którego należy dołączyć arkusz źródłowy.
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
createDeveloperMetadataFinder()
Zwraca DeveloperMetadataFinder
dla metadanych dewelopera w zakresie tego arkusza. Metadane znajdują się w zakresie określonego arkusza, jeśli są powiązane z samym arkuszem lub z wierszem, kolumną lub zakresem w tym arkuszu.
// 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());
Powrót
DeveloperMetadataFinder
– wyszukiwarka metadanych dewelopera do wyszukiwania metadanych w zakresie tego arkusza.
createTextFinder(findText)
Tworzy wyszukiwarkę tekstu dla arkusza, która może znajdować i zastępować tekst w arkuszu.
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');
Parametry
Nazwa | Typ | Opis |
---|---|---|
findText | String | Tekst, który chcesz wyszukać. |
Powrót
TextFinder
– TextFinder
arkusza.
deleteColumn(columnPosition)
Usuwa kolumnę w danej pozycji.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first column sheet.deleteColumn(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnPosition | Integer | Pozycja kolumny, która zaczyna się od 1 w przypadku pierwszej kolumny. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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
deleteColumns(columnPosition, howMany)
Usuwa określoną liczbę kolumn, zaczynając od podanej pozycji kolumny.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first two columns sheet.deleteColumns(1, 2);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnPosition | Integer | Pozycja pierwszej kolumny, którą chcesz usunąć. |
howMany | Integer | Liczba kolumn do usunięcia. |
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
deleteRow(rowPosition)
Usuwa wiersz na podanej pozycji.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at "1" - this deletes the first row sheet.deleteRow(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowPosition | Integer | Pozycja wiersza, zaczynająca się od 1 dla pierwszego wiersza. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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
deleteRows(rowPosition, howMany)
Usuwa określoną liczbę wierszy, rozpoczynając od podanej pozycji wiersza.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at "1" - this deletes the first two rows sheet.deleteRows(1, 2);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowPosition | Integer | Pozycja pierwszego wiersza do usunięcia. |
howMany | Integer | Liczba wierszy do usunięcia. |
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
expandAllColumnGroups()
Rozwija wszystkie grupy kolumn w arkuszu. Ta metoda wymaga co najmniej 1 grupy kolumn.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are expanded. sheet.expandAllColumnGroups();
Powrót
Sheet
– ten arkusz, do łańcucha.
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
expandAllRowGroups()
Rozwija wszystkie grupy wierszy w arkuszu. Ta metoda wymaga co najmniej 1 grupy wierszy.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are expanded. sheet.expandAllRowGroups();
Powrót
Sheet
– ten arkusz, do łańcucha.
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
expandColumnGroupsUpToDepth(groupDepth)
Rozwija wszystkie grupy kolumn do określonej głębokości, a pozostałe zwinięte.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
groupDepth | Integer | Głębokość grupy, do której mają być rozwijane grupy kolumn. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
expandRowGroupsUpToDepth(groupDepth)
Rozwija wszystkie grupy wierszy do podanej głębokości, a pozostałe zwija.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
groupDepth | Integer | Głębokość grupy, do której mają być rozwijane grupy wierszy. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
getActiveCell()
Zwraca aktywną komórkę w tym arkuszu.
Uwaga: zalecamy użycie funkcji getCurrentCell()
, która zwraca aktualnie wyróżnioną komórkę.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Returns the active cell const cell = sheet.getActiveCell();
Powrót
Range
– bieżąca aktywna komórka
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
getActiveRange()
Zwraca wybrany zakres na aktywnym arkuszu lub null
, jeśli nie ma aktywnego zakresu. Jeśli wybrano kilka zakresów, ta metoda zwraca tylko ostatni wybrany zakres.
Termin „zakres aktywny” odnosi się do zakresu wybranego przez użytkownika na aktywnym arkuszu, ale w funkcji niestandardowej odnosi się do komórki, która jest aktywnie przeliczana.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); const activeRange = sheet.getActiveRange();
Powrót
Range
– aktywny zakres
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
Zobacz też
getActiveRangeList()
Zwraca listę aktywnych zakresów na aktywnym arkuszu lub null
, jeśli nie ma aktywnych zakresów.
Jeśli wybrany jest pojedynczy zakres, działa on jak wywołanie funkcji getActiveRange()
.
const sheet = SpreadsheetApp.getActiveSheet(); // Returns the list of active ranges. const activeRangeList = sheet.getActiveRangeList();
Powrót
RangeList
— lista aktywnych zakresó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
Zobacz też
getBandings()
Zwraca wszystkie pasma na tym arkuszu.
// 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()); }
Powrót
Banding[]
– wszystkie pasma w tym arkuszu.
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
getCharts()
Zwraca tablicę wykresów na tym arkuszu.
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 }
Powrót
EmbeddedChart[]
– tablica wykresó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
getColumnGroup(columnIndex, groupDepth)
Zwraca grupę kolumn o danym indeksie i głębokości grupy.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnIndex | Integer | Indeks kolumny przełącznika kontrolnego grupy lub indeks w grupie. |
groupDepth | Integer | Głębokość grupy. |
Powrót
Group
– grupa kolumn o danym indeksie i głębi kontrolnej, a jeśli takiej grupy nie ma, to wyjątek.
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
getColumnGroupControlPosition()
Zwraca GroupControlTogglePosition
dla wszystkich grup kolumn w arkuszu.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the column grouping control toggle is // shown after the group. const columnGroupControlPosition = sheet.getColumnGroupControlPosition();
Powrót
GroupControlTogglePosition
– true
, jeśli przełącznik grupowania kolumn jest widoczny po grupie na tej karcie, i false
w przeciwnym razie.
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
getColumnGroupDepth(columnIndex)
Zwraca głębokość grupy kolumny w podanym indeksie.
Głębokość grupy wskazuje, ile grup pokrywa się z kolumną. Może ona wynosić od 0 do 8.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over columns 1 through 3 const groupDepth = sheet.getColumnGroupDepth(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnIndex | Integer | Indeks kolumny. |
Powrót
Integer
– głębokość grupy kolumny w danym indeksie.
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
getColumnWidth(columnPosition)
Pobiera szerokość danej kolumny w pikselach.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.getColumnWidth(1));
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnPosition | Integer | Pozycja kolumny do sprawdzenia. |
Powrót
Integer
– szerokość kolumny w pikselach
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
getConditionalFormatRules()
Pobierz wszystkie reguły formatowania warunkowego w tym arkuszu.
// 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); }
Powrót
ConditionalFormatRule[]
– tablica wszystkich reguł w arkuszu.
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
getCurrentCell()
Zwraca bieżącą komórkę na aktywnym arkuszu lub null
, jeśli nie ma bieżącej komórki. Bieżąca komórka to komórka, która jest aktywna w interfejsie Arkuszy Google i wyróżniona ciemną obwódką. Nigdy nie ma więcej niż 1 bieżącej komórki. Gdy użytkownik wybierze co najmniej jeden zakres komórek, jedna z komórek w zakresie jest komórką bieżącą.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); // Returns the current highlighted cell in the one of the active ranges. const currentCell = sheet.getCurrentCell();
Powrót
Range
– bieżąca komórka
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
getDataRange()
Zwraca Range
odpowiadający wymiarom, w których znajdują się dane.
Jest to funkcjonalnie to samo, co utworzenie zakresu ograniczonego przez A1 i (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); }
Powrót
Range
– zakres obejmujący wszystkie dane w arkuszu kalkulacyjnym
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
getDataSourceFormulas()
Pobiera wszystkie formuły źródeł danych.
// 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());
Powrót
DataSourceFormula[]
– lista formuł źródeł 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
getDataSourcePivotTables()
Pobiera wszystkie tabele przestawne źródła danych.
// 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());
Powrót
DataSourcePivotTable[]
– lista tabel przestawnych źródeł 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
getDataSourceTables()
Pobiera wszystkie tabele źródeł danych.
// 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());
Powrót
DataSourceTable[]
– lista tabel źródeł 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
getDeveloperMetadata()
Pobierz wszystkie metadane dewelopera powiązane z tym arkuszem.
// 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()); }
Powrót
DeveloperMetadata[]
– metadane dewelopera powiązane z tym arkuszem.
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
getDrawings()
Zwraca tablicę rysunków na arkuszu.
// 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);
Powrót
Drawing[]
– lista rysunków na tym arkuszu.
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
getFilter()
Zwraca filtr na tym arkuszu lub null
, jeśli nie ma filtra.
// Gets the filter on the active sheet. const ss = SpreadsheetApp.getActiveSheet(); const filter = ss.getFilter();
Powrót
Filter
– filtr.
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
getFormUrl()
Zwraca adres URL formularza, który wysyła odpowiedzi do tego arkusza, lub null
, jeśli z arkuszem nie jest powiązany żaden formularz. Wyjątek jest zgłaszany, jeśli użytkownik nie ma uprawnień do edytowania arkusza kalkulacyjnego.
const sheet = SpreadsheetApp.getActiveSheet(); const url = sheet.getFormUrl();
Powrót
String
– adres URL formularza, którego odpowiedzi są umieszczane w tym arkuszu, lub null
, jeśli ten arkusz nie jest powiązany z żadnym formularzem.
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
getFrozenColumns()
Zwraca liczbę zablokowanych kolumn.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log('Number of frozen columns: %s', sheet.getFrozenColumns());
Powrót
Integer
— liczba zablokowanych kolumn
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
getFrozenRows()
Zwraca liczbę zablokowanych wierszy.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log('Number of frozen rows: %s', sheet.getFrozenRows());
Powrót
Integer
— liczba zablokowanych wierszy
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
getImages()
Zwraca wszystkie obrazy na siatce w arkuszu.
// 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()); }
Powrót
OverGridImage[]
– tablica obrazów nad siatką.
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
getIndex()
Pobiera pozycję arkusza w arkuszu nadrzędnym. Rozpoczyna się od 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());
Powrót
Integer
– pozycja arkusza w arkuszu nadrzędnym.
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
getLastColumn()
Zwraca pozycję ostatniej kolumny, która zawiera dane.
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());
Powrót
Integer
– ostatnia kolumna arkusza, która zawiera dane.
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
getLastRow()
Zwraca pozycję ostatniego wiersza, który zawiera dane.
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());
Powrót
Integer
– ostatni wiersz arkusza, który zawiera treści
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
getMaxColumns()
Zwraca bieżącą liczbę kolumn w arkuszu niezależnie od ich zawartości.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); Logger.log(first.getMaxColumns());
Powrót
Integer
– maksymalna szerokość arkusza.
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
getMaxRows()
Zwraca bieżącą liczbę wierszy w arkuszu niezależnie od ich zawartości.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); Logger.log(first.getMaxRows());
Powrót
Integer
– maksymalna wysokość arkusza.
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
getName()
Zwraca nazwę arkusza.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log(sheet.getName());
Powrót
String
– nazwa arkusza.
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
getNamedRanges()
Pobiera wszystkie zakresy nazwane na tym arkuszu.
// 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()); }
Powrót
NamedRange[]
– tablica wszystkich zakresów nazwanych w arkuszu.
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
getParent()
Zwraca Spreadsheet
zawierający ten arkusz.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // parent is identical to ss const parent = sheet.getParent();
Powrót
Spreadsheet
– arkusz nadrzędny.
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
getPivotTables()
Zwraca wszystkie tabele przestawne na tym arkuszu.
// 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()); }
Powrót
PivotTable[]
– tabele przestawne w tym arkuszu.
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
getProtections(type)
Pobiera tablicę obiektów reprezentujących wszystkie chronione zakresy w arkuszu lub tablicę o jednym elemencie reprezentującą ochronę samego arkusza.
// 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(); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
type | ProtectionType | Typ obszaru chronionego: SpreadsheetApp.ProtectionType.RANGE lub SpreadsheetApp.ProtectionType.SHEET . |
Powrót
Protection[]
– tablica obiektów reprezentujących wszystkie chronione zakresy w arkuszu lub tablica o jednym elemencie reprezentująca ochronę samego arkusza.
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
getRange(row, column)
Zwraca zakres z komórką w lewym górnym rogu o podanych współrzędnych.
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]);
Parametry
Nazwa | Typ | Opis |
---|---|---|
row | Integer | Indeks wiersza komórki, która ma zostać zwrócona; indeksowanie wierszy zaczyna się od 1. |
column | Integer | Indeks kolumny komórki, która ma zostać zwrócona; indeksowanie kolumn zaczyna się od 1. |
Powrót
Range
– zakres obejmujący tylko tę komórkę.
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
getRange(row, column, numRows)
Zwraca zakres z komórką w lewym górnym rogu o podanych współrzędnych i podanej liczbie wierszy.
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]); } }
Parametry
Nazwa | Typ | Opis |
---|---|---|
row | Integer | Indeks początkowy wiersza zakresu; indeksowanie wierszy zaczyna się od 1. |
column | Integer | Indeks kolumny zakresu; indeksowanie kolumn zaczyna się od 1. |
numRows | Integer | Liczba wierszy do zwrócenia. |
Powrót
Range
– zakres zawierający pojedynczą kolumnę danych z określoną liczbą wierszy.
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
getRange(row, column, numRows, numColumns)
Zwraca zakres z komórką w lewym górnym rogu o podanych współrzędnych i podanej liczbie wierszy oraz kolumn.
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]); } }
Parametry
Nazwa | Typ | Opis |
---|---|---|
row | Integer | Indeks początkowy wiersza zakresu; indeksowanie wierszy zaczyna się od 1. |
column | Integer | Indeks pierwszej kolumny zakresu; indeksowanie kolumn zaczyna się od 1. |
numRows | Integer | Liczba wierszy do zwrócenia. |
numColumns | Integer | Liczba kolumn do zwrócenia. |
Powrót
Range
– zakres odpowiadający określonemu obszarowi.
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
getRange(a1Notation)
Zwraca zakres określony w notacji A1 lub 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');
Parametry
Nazwa | Typ | Opis |
---|---|---|
a1Notation | String | Zakres do zwrócenia określony w notacji A1 lub R1C1. |
Powrót
Range
– zasięg w wybranym miejscu
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
getRangeList(a1Notations)
Zwraca kolekcję RangeList
reprezentującą zakresy na tym samym arkuszu, określone przez niepustą listę zapisów A1 lub R1C1.
// Get a list of ranges A1:D4, F1:H4. const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); const rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);
Parametry
Nazwa | Typ | Opis |
---|---|---|
a1Notations | String[] | Lista zakresów do zwrócenia, określona w notacji A1 lub R1C1. |
Powrót
RangeList
– lista zakresów w wyznaczonej lokalizacji
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
getRowGroup(rowIndex, groupDepth)
Zwraca grupę wierszy o danym indeksie i głębokości grupy.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowIndex | Integer | Indeks wiersza przełącznika kontrolnego grupy lub indeks w grupie. |
groupDepth | Integer | Głębokość grupy. |
Powrót
Group
– grupa wierszy o danym indeksie i głębi kontrolnej, a jeśli grupy nie ma, to wyjątek.
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
getRowGroupControlPosition()
Zwraca GroupControlTogglePosition
dla wszystkich grup wierszy w arkuszu.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the row grouping control toggle is shown // after the group. const rowGroupControlPosition = sheet.getRowGroupControlPosition();
Powrót
GroupControlTogglePosition
– true
, jeśli przełącznik grupowania wierszy jest widoczny po grupie na tym arkuszu,
a false
w przeciwnym razie.
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
getRowGroupDepth(rowIndex)
Zwraca głębokość grupy wiersza o podanym indeksie.
Głębokość grupy wskazuje, ile grup pokrywa się z wierszem. Może ona wynosić od 0 do 8.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over rows 1 through 3 const groupDepth = sheet.getRowGroupDepth(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowIndex | Integer | Indeks wiersza. |
Powrót
Integer
– głębokość grupy wiersza o danym indeksie.
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
getRowHeight(rowPosition)
Pobiera wysokość danego wiersza w pikselach.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.getRowHeight(1));
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowPosition | Integer | Pozycja wiersza do sprawdzenia. |
Powrót
Integer
– wysokość wiersza w pikselach
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
getSelection()
Zwraca bieżącą wartość Selection
w arkuszu kalkulacyjnym.
const selection = SpreadsheetApp.getActiveSpreadsheet().getSelection(); const currentCell = selection.getCurrentCell();
Powrót
Selection
– bieżący wybór
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
getSheetId()
Zwraca identyfikator arkusza reprezentowanego przez ten obiekt.
Jest to identyfikator arkusza, który jest unikalny dla danego arkusza kalkulacyjnego. Identyfikator jest monotonicznie rosnącą liczbą całkowitą przypisaną w momencie tworzenia arkusza i niezależną od jego pozycji. Jest to przydatne w połączeniu z metodami takimi jak Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd)
, które przyjmują parametr gridId
, a nie instancję Sheet
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetId());
Powrót
Integer
– identyfikator arkusza, który jest unikalny dla arkusza kalkulacyjnego.
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
getSheetName()
Zwraca nazwę arkusza.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetName());
Powrót
String
– nazwa arkusza.
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(startRow, startColumn, numRows, numColumns)
Zwraca prostokątną siatkę wartości dla tego zakresu, rozpoczynając od podanych współrzędnych. Wartość -1 podana jako pozycja wiersza lub kolumny jest równoważna uzyskaniu ostatniego wiersza lub ostatniej kolumny zawierającej dane w arkuszu.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
startRow | Integer | Pozycja początkowego wiersza. |
startColumn | Integer | Pozycja pierwszej kolumny. |
numRows | Integer | Liczba wierszy, dla których mają być zwracane wartości. |
numColumns | Integer | Liczba kolumn, dla których mają być zwracane wartości. |
Powrót
Object[][]
– dwuwymiarowa tablica wartości
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
getSlicers()
Zwraca tablicę selektorów na arkuszu.
// 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()); }
Powrót
Slicer[]
– lista segmentatorów na tym arkuszu.
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
getTabColorObject()
Pobiera kolor karty arkusza lub null
, jeśli karta arkusza nie ma koloru.
// This example assumes there is a sheet named "Sheet1" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('Sheet1'); const color = first.getTabColorObject();
Powrót
Color
– kolor karty arkusza lub null
, jeśli karta nie ma koloru.
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
getType()
Zwraca typ arkusza.
Domyślny typ arkusza to SheetType.GRID
. Arkusz zawierający pojedynczy obiekt wbudowany, np. EmbeddedChart
, to arkusz SheetType.OBJECT
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log(sheet.getType());
Powrót
SheetType
– typ arkusza.
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
hasHiddenGridlines()
Zwraca true
, jeśli linie siatki arkusza są ukryte; w przeciwnym razie zwraca false
.
Linie siatki są domyślnie widoczne.
// 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());
Powrót
Boolean
– true
, jeśli linie siatki są ukryte, w przeciwnym razie false
.
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
hideColumn(column)
Ukrywa kolumnę lub kolumny w podanym zakresie.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
column | Range | Zakres kolumny do ukrycia. |
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
hideColumns(columnIndex)
Ukrywa jedną kolumnę o danym indeksie. W tym przypadku użyj indeksu 1.
Aby ukryć więcej niż 1 kolumnę za pomocą indeksu, użyj hideColumns(columnIndex, numColumns)
.
Aby ukryć więcej niż 1 kolumnę za pomocą zakresu, użyj hideColumn()
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Hides the first column sheet.hideColumns(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnIndex | Integer | Indeks kolumny do ukrycia. |
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
hideColumns(columnIndex, numColumns)
Ukrywa co najmniej 1 kolumnę licząc od podanego indeksu. W tym przypadku użyj indeksu 1.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Hides the first three columns sheet.hideColumns(1, 3);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnIndex | Integer | Indeks początkowy kolumn do ukrycia. |
numColumns | Integer | Liczba kolumn do ukrycia. |
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
hideRow(row)
Ukrywa wiersze w podanym zakresie.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This hides the first row const range = sheet.getRange('A1'); sheet.hideRow(range);
Parametry
Nazwa | Typ | Opis |
---|---|---|
row | Range | Zakres wierszy do ukrycia. |
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
hideRows(rowIndex)
Ukrywa wiersz o podanym indeksie.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Hides the first row sheet.hideRows(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowIndex | Integer | Indeks wiersza do ukrycia. |
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
hideRows(rowIndex, numRows)
Ukrywa co najmniej 1 ciągły wiersz, zaczynając od podanego indeksu.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Hides the first three rows sheet.hideRows(1, 3);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowIndex | Integer | Indeks początkowy wierszy do ukrycia. |
numRows | Integer | Liczba wierszy do ukrycia. |
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
hideSheet()
Ukrywa ten arkusz. Nie ma wpływu, jeśli arkusz jest już ukryty. Jeśli ta metoda zostanie wywołana na widocznym tylko arkuszu, zgłasza wyjątek.
const sheet = SpreadsheetApp.getActiveSheet(); sheet.hideSheet();
Powrót
Sheet
– bieżący arkusz.
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
insertChart(chart)
Dodaje nowy wykres do tego arkusza.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
chart | EmbeddedChart | Wykres do wstawienia. |
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
insertColumnAfter(afterPosition)
Wstawia kolumnę po podanej kolumnie.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts a column after the first column position sheet.insertColumnAfter(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
afterPosition | Integer | Kolumna, po której ma zostać dodana nowa kolumna. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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
insertColumnBefore(beforePosition)
Wstawia kolumnę przed podaną pozycją kolumny.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts a column in the first column position sheet.insertColumnBefore(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
beforePosition | Integer | Kolumna, przed którą ma zostać dodana nowa kolumna. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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
insertColumns(columnIndex)
Wstawia pustą kolumnę w arkuszu w określonym miejscu.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Shifts all columns by one sheet.insertColumns(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnIndex | Integer | Indeks wskazujący, gdzie wstawić kolumnę. |
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
insertColumns(columnIndex, numColumns)
Wstawia co najmniej 1 kolejną pustą kolumnę w arkuszu, zaczynając od określonej lokalizacji.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Shifts all columns by three sheet.insertColumns(1, 3);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnIndex | Integer | Indeks wskazujący, gdzie wstawić kolumnę. |
numColumns | Integer | Liczba kolumn do wstawienia. |
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
insertColumnsAfter(afterPosition, howMany)
Wstawia określoną liczbę kolumn po podanej kolumnie.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
afterPosition | Integer | Kolumna, po której ma zostać dodana nowa kolumna. |
howMany | Integer | Liczba kolumn do wstawienia. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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
insertColumnsBefore(beforePosition, howMany)
Wstawia określoną liczbę kolumn przed podaną pozycją kolumny.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts five columns before the first column sheet.insertColumnsBefore(1, 5);
Parametry
Nazwa | Typ | Opis |
---|---|---|
beforePosition | Integer | Kolumna, przed którą ma zostać dodana nowa kolumna. |
howMany | Integer | Liczba kolumn do wstawienia. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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
insertImage(blobSource, column, row)
Wstawia BlobSource
jako obraz w dokumencie w danym wierszu i kolumnie. Rozmiar obrazu jest pobierany z treści bloba. Maksymalny obsługiwany rozmiar bloba to 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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
blobSource | BlobSource | Blob zawierający zawartość obrazu, typ MIME i (opcjonalnie) nazwę. |
column | Integer | Pozycja kolumny. |
row | Integer | Pozycja wiersza. |
Powrót
OverGridImage
– wstawiony obraz.
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
insertImage(blobSource, column, row, offsetX, offsetY)
Wstawia BlobSource
jako obraz w dokumencie w danym wierszu i kolumnie z przesunięciem o pewną liczbę pikseli. Rozmiar obrazu jest pobierany z treści bloba. Maksymalny obsługiwany rozmiar bloba to 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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
blobSource | BlobSource | Blob zawierający zawartość obrazu, typ MIME i (opcjonalnie) nazwę. |
column | Integer | Pozycja kolumny. |
row | Integer | Pozycja wiersza. |
offsetX | Integer | Poziome przesunięcie od narożnika komórki w pikselach. |
offsetY | Integer | Pionowe przesunięcie od narożnika komórki w pikselach. |
Powrót
OverGridImage
– wstawiony obraz.
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
insertImage(url, column, row)
Wstawia obraz w dokumencie w danym wierszu i kolumnie.
Podany adres URL musi być publicznie dostępny.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.insertImage('https://www.google.com/images/srpr/logo3w.png', 1, 1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
url | String | Adres URL obrazu. |
column | Integer | Pozycja kolumny siatki. |
row | Integer | Pozycja wiersza siatki. |
Powrót
OverGridImage
– wstawiony obraz.
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
insertImage(url, column, row, offsetX, offsetY)
Wstawia obraz w dokumencie w danym wierszu i kolumnie z przesunięciem o piksele.
Podany adres URL musi być publicznie dostępny.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.insertImage( 'https://www.google.com/images/srpr/logo3w.png', 1, 1, 10, 10, );
Parametry
Nazwa | Typ | Opis |
---|---|---|
url | String | Adres URL obrazu. |
column | Integer | Pozycja kolumny. |
row | Integer | Pozycja wiersza. |
offsetX | Integer | Poziome przesunięcie od narożnika komórki w pikselach. |
offsetY | Integer | Pionowe przesunięcie od narożnika komórki w pikselach. |
Powrót
OverGridImage
– wstawiony obraz.
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
insertRowAfter(afterPosition)
Wstawia wiersz po podanej pozycji wiersza.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts a row after the first row position sheet.insertRowAfter(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
afterPosition | Integer | Wiersz, po którym należy dodać nowy wiersz. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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
insertRowBefore(beforePosition)
Wstawia wiersz przed podaną pozycją wiersza.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts a row before the first row position sheet.insertRowBefore(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
beforePosition | Integer | Wiersz, przed którym należy dodać nowy wiersz. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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
insertRows(rowIndex)
Wstawia pusty wiersz w arkuszu w określonym miejscu.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Shifts all rows down by one sheet.insertRows(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowIndex | Integer | Indeks wskazujący, gdzie wstawić wiersz. |
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
insertRows(rowIndex, numRows)
Wstawia na arkuszu co najmniej 1 ciągły pusty wiersz, zaczynając od określonej lokalizacji.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Shifts all rows down by three sheet.insertRows(1, 3);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowIndex | Integer | Indeks wskazujący, gdzie wstawić wiersz. |
numRows | Integer | Liczba wierszy do wstawienia. |
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
insertRowsAfter(afterPosition, howMany)
Wstawia określoną liczbę wierszy po podanej pozycji wiersza.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts five rows after the first row sheet.insertRowsAfter(1, 5);
Parametry
Nazwa | Typ | Opis |
---|---|---|
afterPosition | Integer | Wiersz, po którym mają być dodawane nowe wiersze. |
howMany | Integer | Liczba wierszy do wstawienia. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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
insertRowsBefore(beforePosition, howMany)
Wstawia określoną liczbę wierszy przed podaną pozycją wiersza.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts five rows before the first row sheet.insertRowsBefore(1, 5);
Parametry
Nazwa | Typ | Opis |
---|---|---|
beforePosition | Integer | Wiersz, przed którym mają zostać dodane nowe wiersze. |
howMany | Integer | Liczba wierszy do wstawienia. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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
insertSlicer(range, anchorRowPos, anchorColPos)
Dodaje do tego arkusza nowy filtr.
// 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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
range | Range | Zakres, w którym tworzony jest filtr. |
anchorRowPos | Integer | W tym wierszu zablokowana jest górna krawędź osi. |
anchorColPos | Integer | Górna krawędź osi jest zablokowana w tej kolumnie. |
Powrót
Slicer
– nowo wstawiony fragmentator.
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
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)
Dodaje do tego arkusza nowy filtr.
// 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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
range | Range | Zakres, w którym tworzony jest filtr. |
anchorRowPos | Integer | W tym wierszu zablokowana jest górna krawędź osi. |
anchorColPos | Integer | Górna krawędź osi jest zablokowana w tej kolumnie. |
offsetX | Integer | Poziome przesunięcie od narożnika komórki w pikselach. |
offsetY | Integer | Pionowe przesunięcie od narożnika komórki w pikselach. |
Powrót
Slicer
– nowo wstawiony fragmentator.
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
isColumnHiddenByUser(columnPosition)
Zwraca informację, czy dana kolumna jest ukryta przez użytkownika.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.isColumnHiddenByUser(1));
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnPosition | Integer | Pozycja kolumny do sprawdzenia. |
Powrót
Boolean
– true
, jeśli kolumna jest ukryta, a w przeciwnym razie false
.
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
isRightToLeft()
Zwraca true
, jeśli układ arkusza jest od prawej do lewej. Zwraca false
, jeśli arkusz używa domyślnego układu od lewej do prawej.
// 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());
Powrót
Boolean
– true
, jeśli tekst jest pisany od prawej do lewej; w przeciwnym razie false
.
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
isRowHiddenByFilter(rowPosition)
Zwraca wartość wskazującą, czy dany wiersz jest ukryty przez filtr (a nie przez widok filtra).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.isRowHiddenByFilter(1));
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowPosition | Integer | Pozycja wiersza do sprawdzenia. |
Powrót
Boolean
– true
, jeśli wiersz jest ukryty, false
w przeciwnym razie.
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
isRowHiddenByUser(rowPosition)
Zwraca informację, czy dany wiersz jest ukryty przez użytkownika.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.isRowHiddenByUser(1));
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowPosition | Integer | Pozycja wiersza do sprawdzenia. |
Powrót
Boolean
– true
, jeśli wiersz jest ukryty, false
w przeciwnym razie.
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
isSheetHidden()
Zwraca wartość true
, jeśli arkusz jest obecnie ukryty.
const sheet = SpreadsheetApp.getActiveSheet(); if (sheet.isSheetHidden()) { // do something... }
Powrót
Boolean
– true
, jeśli arkusz jest ukryty, false
w przeciwnym razie.
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
moveColumns(columnSpec, destinationIndex)
Przenosi kolumny wybrane przez dany zakres do pozycji wskazanej przez destinationIndex
. columnSpec
nie musi dokładnie odpowiadać całej kolumnie ani grupie kolumn, które mają zostać przeniesione. Wybiera ona wszystkie kolumny, które mieszczą się w zakresie.
// 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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnSpec | Range | Zakres obejmujący kolumny, które mają zostać przeniesione. |
destinationIndex | Integer | Indeks, do którego mają zostać przeniesione kolumny. Pamiętaj, że ten indeks jest tworzony na podstawie współrzędnych przed przeniesieniem kolumn. Istniejące dane są przesuwane w prawo, aby zrobić miejsce dla przeniesionych kolumn, a kolumny źródłowe są usuwane z siatki. Dlatego dane mogą trafić do innego indeksu niż pierwotnie określony. |
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
moveRows(rowSpec, destinationIndex)
Przenosi wiersze wybrane przez dany zakres do pozycji wskazanej przez destinationIndex
. rowSpec
nie musi dokładnie odpowiadać całemu wierszowi ani grupie wierszy, które mają zostać przeniesione. Wybiera ona wszystkie wiersze, na które sięga zakres.
// 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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowSpec | Range | Zakres obejmujący wiersze, które mają zostać przeniesione. |
destinationIndex | Integer | Indeks, do którego mają zostać przeniesione wiersze. Pamiętaj, że ten indeks jest oparty na współrzędnych przed przeniesieniem wierszy. Istniejące dane są przesuwane w dół, aby zrobić miejsce dla przeniesionych wierszy, a wiersze źródłowe są usuwane z siatki. W związku z tym dane mogą trafić do innego indeksu niż określony pierwotnie. |
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
newChart()
Zwraca kreator do tworzenia nowego wykresu w tym arkuszu.
Ten przykład pokazuje, jak utworzyć nowy wykres:
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());
Powrót
EmbeddedChartBuilder
– kreator do tworzenia nowych wykresów.
protect()
Tworzy obiekt, który może chronić arkusz przed edytowaniem przez użytkowników, którzy nie mają uprawnień. Dopóki skrypt nie zmieni listy edytujących arkusz (wywołując Protection.removeEditor(emailAddress)
, Protection.removeEditor(user)
, Protection.removeEditors(emailAddresses)
, Protection.addEditor(emailAddress)
, Protection.addEditor(user)
, Protection.addEditors(emailAddresses)
lub ustawiając nową wartość dla Protection.setDomainEdit(editable)
), uprawnienia są takie same jak w samym arkuszu, co oznacza, że arkusz pozostaje niezabezpieczony. Jeśli arkusz jest już chroniony, ta metoda zwraca obiekt reprezentujący jego bieżące ustawienia ochrony.
Chroniony arkusz może zawierać niechronione obszary.
// 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); }
Powrót
Protection
– obiekt reprezentujący ustawienia ochrony.
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
removeChart(chart)
usuwa wykres z arkusza nadrzędnego.
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]); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
chart | EmbeddedChart | Wykres do usunięcia. |
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
setActiveRange(range)
Ustawia określony zakres jako active range
w aktywnym arkuszu, przy czym lewa górna komórka zakresu jest 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();
Parametry
Nazwa | Typ | Opis |
---|---|---|
range | Range | Zakres do ustawienia jako aktywny zakres. |
Powrót
Range
– nowo aktywny zakres
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
setActiveRangeList(rangeList)
Ustawia określoną listę zakresów jako active ranges
w aktywnym arkuszu. Ostatni zakres na liście jest ustawiony jako 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();
Parametry
Nazwa | Typ | Opis |
---|---|---|
rangeList | RangeList | Lista zakresów do wyboru. |
Powrót
RangeList
– nowo wybrana lista zakresó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
setActiveSelection(range)
Określa aktywny obszar zaznaczenia na tym arkuszu.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:D4'); sheet.setActiveSelection(range);
Parametry
Nazwa | Typ | Opis |
---|---|---|
range | Range | Zakres do ustawienia jako aktywny. |
Powrót
Range
– nowo aktywny zakres
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
setActiveSelection(a1Notation)
Ustawia aktywny zakres zaznaczania zgodnie z notacją A1 lub R1C1.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.setActiveSelection('A1:D4');
Parametry
Nazwa | Typ | Opis |
---|---|---|
a1Notation | String | Zakres, który ma być ustawiony jako aktywny, określony w notacji A1 lub R1C1. |
Powrót
Range
– nowo aktywny zakres
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
setColumnGroupControlPosition(position)
Określa pozycję przełącznika kontrolującego grupę kolumn na arkuszu.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setColumnGroupControlPosition( SpreadsheetApp.GroupControlTogglePosition.AFTER, );
Parametry
Nazwa | Typ | Opis |
---|---|---|
position | GroupControlTogglePosition | Położenie przełącznika kontrolującego grupę kolumn. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
setColumnWidth(columnPosition, width)
Ustawia szerokość danej kolumny w pikselach.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first column to a width of 200 pixels sheet.setColumnWidth(1, 200);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnPosition | Integer | Pozycja kolumny, którą chcesz ustawić. |
width | Integer | Szerokość w pikselach. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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(startColumn, numColumns, width)
Ustawia szerokość podanych kolumn w pikselach.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
startColumn | Integer | Pozycja początkowa kolumny, która ma zostać zmieniona. |
numColumns | Integer | Liczba kolumn, które mają zostać zmienione. |
width | Integer | Szerokość w pikselach. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
setConditionalFormatRules(rules)
Zastępuje wszystkie istniejące reguły formatowania warunkowego na arkuszu regułami wejściowymi. Reguły są oceniane w kolejności ich podania.
// 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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rules | ConditionalFormatRule[] | nowe reguły formatowania warunkowego. |
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
setCurrentCell(cell)
Ustawia wskazaną komórkę jako current cell
.
Jeśli wybrana komórka znajduje się w już wybranym zakresie, ten zakres staje się aktywnym zakresem, a komórka staje się bieżącą komórką.
Jeśli wybrana komórka nie znajduje się w żadnym wybranym zakresie, dotychczasowe zaznaczenie zostaje usunięte, a komórka staje się bieżącą komórką i aktywnym zakresem.
Uwaga: podana wartość Range
musi składać się z jednej komórki, w przeciwnym razie zostanie rzucony wyjątek.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); const cell = sheet.getRange('B5'); sheet.setCurrentCell(cell); const selection = sheet.getSelection(); // Current cell: B5 const currentCell = selection.getCurrentCell();
Parametry
Nazwa | Typ | Opis |
---|---|---|
cell | Range | Komórka, która ma być ustawiona jako bieżąca komórka. |
Powrót
Range
– nowo ustawiona bieżąca komórka
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
setFrozenColumns(columns)
Blokuje podany numer kolumn. Jeśli wartość wynosi 0, żadne kolumny nie są wstrzymywane.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Freezes the first column sheet.setFrozenColumns(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columns | Integer | Liczba kolumn do zablokowania. |
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
setFrozenRows(rows)
Blokuje podany numer wiersza. Jeśli jest równa 0, żadne wiersze nie są wstrzymywane.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Freezes the first row sheet.setFrozenRows(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rows | Integer | Liczba wierszy do zablokowania. |
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
setHiddenGridlines(hideGridlines)
Ukrywa lub ujawnia linie siatki arkusza.
// 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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
hideGridlines | Boolean | Jeśli true , ukryj linie siatki w tym arkuszu; w przeciwnym razie pokaż linie siatki. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
setName(name)
Ustawia nazwę arkusza.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.setName('not first anymore');
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | Nowa nazwa arkusza. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
setRightToLeft(rightToLeft)
Ustawia lub odznacza układ arkusza od prawej do lewej.
// 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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rightToLeft | Boolean | Jeśli true , układ arkusza jest ustawiony od prawej do lewej, a komórka A1 znajduje się w prawym górnym rogu. Jeśli false , układ arkusza jest ustawiony domyślnie na kierunek od lewej do prawej, a komórka A1 znajduje się w lewym górnym rogu. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
setRowGroupControlPosition(position)
Określa pozycję przełącznika grupy wierszy na arkuszu.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setRowGroupControlPosition( SpreadsheetApp.GroupControlTogglePosition.AFTER, );
Parametry
Nazwa | Typ | Opis |
---|---|---|
position | GroupControlTogglePosition | Pozycja przełącznika kontrolującego grupę wierszy. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
setRowHeight(rowPosition, height)
Ustawia wysokość wiersza w pikselach. Domyślnie wiersze rozszerzają się, aby pomieścić zawartość komórki. Jeśli chcesz wymusić określoną wysokość wierszy, użyj atrybutu 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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowPosition | Integer | Pozycja wiersza, którą chcesz zmienić. |
height | Integer | Wysokość w pikselach. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod.
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
setRowHeights(startRow, numRows, height)
Ustawia wysokość podanych wierszy w pikselach. Domyślnie wiersze rozszerzają się, aby pomieścić zawartość komórki. Jeśli chcesz wymusić określoną wysokość wierszy, użyj atrybutu 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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
startRow | Integer | Pozycja początkowa wiersza, która ma ulec zmianie. |
numRows | Integer | Liczba wierszy do zmiany. |
height | Integer | Wysokość w pikselach. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
setRowHeightsForced(startRow, numRows, height)
Ustawia wysokość podanych wierszy w pikselach. Domyślnie wiersze rozszerzają się, aby pomieścić zawartość komórki. Gdy używasz tagu setRowHeightsForced
, wiersze są wymuszane do określonej wysokości, nawet jeśli zawartość komórki jest wyższa niż wysokość wiersza.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
startRow | Integer | Pozycja początkowa wiersza, która ma ulec zmianie. |
numRows | Integer | Liczba wierszy do zmiany. |
height | Integer | Wysokość w pikselach. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
setTabColor(color)
Ustawia kolor karty arkusza.
// 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.
Parametry
Nazwa | Typ | Opis |
---|---|---|
color | String | kod koloru w notacji CSS (np. '#ffffff' lub 'white' ) albo null , aby zresetować kolor karty. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
setTabColorObject(color)
Ustawia kolor karty arkusza.
// 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.
Parametry
Nazwa | Typ | Opis |
---|---|---|
color | Color | Kolor karty arkusza do ustawienia. |
Powrót
Sheet
– ten arkusz, do łańcucha.
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
showColumns(columnIndex)
Odkrywa kolumnę o danym indeksie.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Unhides the first column sheet.showColumns(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnIndex | Integer | Indeks kolumny, którą chcesz odkryć. |
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
showColumns(columnIndex, numColumns)
Odkrywa co najmniej 1 kolejną kolumnę, licząc od podanego indeksu.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Unhides the first three columns sheet.showColumns(1, 3);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnIndex | Integer | Indeks początkowy kolumn, które mają być widoczne. |
numColumns | Integer | Liczba kolumn, które mają być odsłonięte. |
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
showRows(rowIndex)
Odkrywa wiersz o danym indeksie.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Unhides the first row sheet.showRows(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowIndex | Integer | Indeks wiersza, który chcesz odkryć. |
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
showRows(rowIndex, numRows)
Odsłania co najmniej 1 ciągły wiersz, zaczynając od podanego indeksu.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Unhides the first three rows sheet.showRows(1, 3);
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowIndex | Integer | Indeks początkowy wierszy, które mają być widoczne. |
numRows | Integer | Liczba wierszy, które mają być odsłonięte. |
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
showSheet()
Sprawia, że arkusz jest widoczny. Nie ma wpływu, jeśli arkusz jest już widoczny.
const sheet = SpreadsheetApp.getActiveSheet(); sheet.showSheet();
Powrót
Sheet
– bieżący arkusz.
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
sort(columnPosition)
Sortuje arkusz według kolumny w kolejności rosnącej.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sorts the sheet by the first column, ascending sheet.sort(1);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnPosition | Integer | Kolumna, według której chcesz sortować. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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
sort(columnPosition, ascending)
Sortuje arkusz według kolumny. Przyjmuje parametr określający kolejność rosnącą lub malejącą.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sorts the sheet by the first column, descending sheet.sort(1, false);
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnPosition | Integer | Kolumna, według której chcesz sortować. |
ascending | Boolean | true – sortowanie rosnąco, false – malejąco. |
Powrót
Sheet
– arkusz, przydatny do łańcuchowania metod
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
unhideColumn(column)
Odkrywa kolumnę w podanym zakresie.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
column | Range | Zakres, który chcesz odsłonić, jeśli jest ukryty. |
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
unhideRow(row)
Odkrywa wiersz w podanym zakresie.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
row | Range | Zakres, który chcesz odsłonić, jeśli jest ukryty. |
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
updateChart(chart)
Zaktualizuje wykres na tym arkuszu.
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); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
chart | EmbeddedChart | Wykres do zaktualizowania. |
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