Interface Sheet

スプレッドシートのシートへの操作を提供するクラスです。This class provides operations on spreadsheet sheets.

Hierarchy

Sheet

Methods

appendRow

appendRow(rowContents: any[]): Sheet
シートに指定された値で1行書き込みます。
値のある最後の行の次の行に対して書き込みを行います。Writes one row to the sheet with the specified value.
Writes to the row following the last row with a value.

Returns
このシートオブジェクトThis sheet object
Parameters
- rowContents: any[]
  
  後に挿入する値の配列 array of values to insert after
Returns Sheet

clear

clear(): Sheet
このシートオブジェクトのセルの値、フォーマットをクリアします。Clear the cell values and formatting of this sheet object.

Returns
このシートオブジェクトThis sheet object

Returns Sheet
clear(options: SheetClearOptions): Sheet
このシートオブジェクトのセルの値/フォーマットを指定されたオプションでクリアします。Clear the value/format of a cell in this sheet object with the specified options.

Returns
このシートオブジェクトThis sheet object
Parameters
- options: SheetClearOptions
  
  オプションの引数 optional arguments
Returns Sheet

getDataRange

getDataRange(): Range
データが存在する範囲に対応するレンジオブジェクトを返却します。
A1からSheet.getLastColumn(), Sheet.getLastRow()で囲まれた範囲と同義となります。Returns range objects corresponding to the range where data resides.
This is equal to the range enclosed by A1 to Sheet.getLastColumn(), Sheet.getLastRow().

Returns
指定された範囲のレンジオブジェクトRange object for the specified range

Returns Range

getIndex

getIndex(): number
スプレッドシート内のシートの位置を取得します。
0 から始まります。Gets the position of the sheet in the spreadsheet.
Starts at 0.

Returns
スプレッドシートでのシートの位置Sheet position in spreadsheet

Returns number

getLastColumn

getLastColumn(): number
値のある最後の列の位置を返します。Returns the position of the last column with a value.

Returns
値を含むシートの最後の列Last column of the sheet containing the value

Returns number

getLastRow

getLastRow(): number
値のある最後の行の位置を返します。Returns the position of the last row with a value.

Returns
値を含むシートの最後の行Last row of the sheet containing the value

Returns number

getMaxColumns

getMaxColumns(): number
値に関係なく、シート内の現在の列数を返します。Returns the current number of columns in the sheet, regardless of the value.

Returns
シートの最大列数Maximum number of columns in a sheet

Returns number

getMaxRows

getMaxRows(): number
値に関係なく、シート内の現在の行数を返します。Returns the current number of rows in the sheet, regardless of the value.

Returns
シートの最大行数Maximum number of rows in a sheet

Returns number

getName

getName(): string
シート名を返します。Returns the sheet name.

Returns
シートの名前Sheet name

Returns string

getRange

getRange(row: number, column: number, numRows: number, numColumns: number): Range
指定された行と列、行数と列数のレンジオブジェクトを返します。Returns a range object with the specified rows and columns and number of rows and columns.

Returns
指定された範囲のレンジオブジェクトRange object for the specified range
Parameters
- row: number
  
  範囲の開始行インデックス。
  行のインデックス付けは 1 から始まります。 The starting row index of the range.
  Column indexing starts at 1.
- column: number
  
  範囲の開始列インデックス。
  列のインデックス付けは 1 から始まります。 The starting column index of the range.
  Column indexing starts at 1.
- numRows: number
  
  範囲の行数 number of rows in range
- numColumns: number
  
  範囲の列数 number of columns in range
Returns Range
getRange(row: number, column: number, numRows: number): Range
指定された行と列、行数のレンジオブジェクトを返します。
列数は1となります。Returns a range object with the specified rows and columns and number of columns.
The number of columns is 1.

Returns
指定された範囲のレンジオブジェクトRange object for the specified range
Parameters
- row: number
  
  範囲の開始行インデックス。
  行のインデックス付けは 1 から始まります。 The starting row index of the range.
  Column indexing starts at 1.
- column: number
  
  範囲の開始列インデックス。
  列のインデックス付けは 1 から始まります。 The starting column index of the range.
  Column indexing starts at 1.
- numRows: number
  
  範囲の行数 number of rows in range
Returns Range
getRange(row: number, column: number): Range
指定された行と列の単一のレンジオブジェクトを返します。Returns a single range object for a specified row and column.

Returns
指定された範囲のレンジオブジェクトRange object for the specified range
Parameters
- row: number
  
  範囲の開始行インデックス。
  行のインデックス付けは 1 から始まります。 The starting row index of the range.
  Column indexing starts at 1.
- column: number
  
  範囲の開始列インデックス。
  列のインデックス付けは 1 から始まります。 The starting column index of the range.
  Column indexing starts at 1.
Returns Range
getRange(a1Notation: string): Range
A1表記またはR1C1表記で指定されたレンジオブジェクトを返します。Returns the range object specified in A1 or R1C1 notation.

Returns
指定された範囲のレンジオブジェクトRange object for the specified range
Parameters
- a1Notation: string
  
  A1表記またはR1C1表記で指定されたレンジ。 range specified in A1 or R1C1 notation.
Returns Range

getRangeList

getRangeList(a1Notations: string[]): RangeList
A1表記またはR1C1表記で指定された複数のレンジオブジェクトを返します。Returns the multiple range object specified in A1 or R1C1 notation.

Returns
指定された範囲のレンジリストオブジェクトRange list object for the specified range
Parameters
- a1Notations: string[]
  
  A1表記またはR1C1表記で指定されたレンジの配列。 Array of ranges specified in A1 or R1C1 notation.
Returns RangeList

getSheetId

getSheetId(): number
シートのIDを返します。Returns the sheet ID.

Returns
シートのIDSheet ID

Returns number

getSheetName

getSheetName(): string
シート名を返します。Returns the sheet name.

Returns
シートの名前Sheet name

Returns string

getSheetValues

getSheetValues(startRow: number, startColumn: number, numRows: number, numColumns: number): any[][]
指定された行と列、行数と列数の範囲のセルの値を返します。Returns the value of a range of cells with the specified rows and columns and number of rows and columns.

Returns
セルの値の2次元配列2D Array of cell values
Parameters
- startRow: number
- startColumn: number
- numRows: number
  
  範囲の行数 number of rows in range
- numColumns: number
  
  範囲の列数 number of columns in range
Returns any[][]

insertColumnAfter

insertColumnAfter(afterPosition: number): Sheet
指定された列位置の後に列を挿入します。Inserts a column after the specified column position.

Returns
このシートオブジェクトThis sheet object
Parameters
- afterPosition: number
  
  新しい列を追加する必要がある列位置 column position to add a new column
Returns Sheet

insertColumnBefore

insertColumnBefore(beforePosition: number): Sheet
指定された列位置の前に列を挿入します。Inserts a column before the specified column position.

Returns
このシートオブジェクトThis sheet object
Parameters
- beforePosition: number
  
  新しい列を追加する必要がある列位置 column position to add a new column
Returns Sheet

insertColumns

insertColumns(columnIndex: number): void
シートの指定された位置に列を挿入します。Inserts a column at a specified position on the sheet.
Parameters
- columnIndex: number
  
  列を挿入する場所を示すインデックス An index show where to insert the column
Returns void
insertColumns(columnIndex: number, numColumns: number): void
シートの指定された位置に複数の列を挿入します。Inserts multiple columns at the specified position on the sheet.
Parameters
- columnIndex: number
  
  列を挿入する場所を示すインデックス An index show where to insert the column
- numColumns: number
  
  挿入する列の数 number of columns to insert
Returns void

insertColumnsAfter

insertColumnsAfter(afterPosition: number, howMany: number): Sheet
指定された列位置の後に複数の列を挿入します。Inserts multiple columns after the specified column position.

Returns
このシートオブジェクトThis sheet object
Parameters
- afterPosition: number
  
  新しい列を追加する必要がある列位置 column position to add a new column
- howMany: number
  
  挿入する列の数 number of columns to insert
Returns Sheet

insertColumnsBefore

insertColumnsBefore(beforePosition: number, howMany: number): Sheet
指定された列位置の前に複数の列を挿入します。Inserts multiple columns before the specified column position.

Returns
このシートオブジェクトThis sheet object
Parameters
- beforePosition: number
  
  新しい列を追加する必要がある列位置 column position to add a new column
- howMany: number
  
  挿入する列の数 number of columns to insert
Returns Sheet

insertRowAfter

insertRowAfter(afterPosition: number): Sheet
指定された行位置の後に行を挿入します。Inserts a row after the specified row position.

Returns
このシートオブジェクトThis sheet object
Parameters
- afterPosition: number
  
  新しい行を追加する必要がある行位置 row position to add a new row
Returns Sheet

insertRowBefore

insertRowBefore(beforePosition: number): Sheet
指定された行位置の前に行を挿入します。Inserts a row before the specified row position.

Returns
このシートオブジェクトThis sheet object
Parameters
- beforePosition: number
  
  新しい行を追加する必要がある行位置 row position to add a new row
Returns Sheet

insertRows

insertRows(rowIndex: number): void
シートの指定された位置に行を挿入します。Inserts a row at the specified position on the sheet.
Parameters
- rowIndex: number
  
  行を挿入する場所を示すインデックス an index shows where to insert the column
Returns void
insertRows(rowIndex: number, numRows: number): void
シートの指定された位置に複数の行を挿入します。Inserts multiple rows at the specified position on the sheet.
Parameters
- rowIndex: number
  
  行を挿入する場所を示すインデックス an index shows where to insert the column
- numRows: number
Returns void

insertRowsAfter

insertRowsAfter(afterPosition: number, howMany: number): Sheet
指定された行位置の後に複数の行を挿入します。Inserts multiple rows after the specified row position.

Returns
このシートオブジェクトThis sheet object
Parameters
- afterPosition: number
  
  新しい行を追加する必要がある行位置 row position to add a new row
- howMany: number
  
  挿入する行の数 number of rows to insert
Returns Sheet

insertRowsBefore

insertRowsBefore(beforePosition: number, howMany: number): Sheet
指定された行位置の前に複数の行を挿入します。Inserts multiple rows before the specified row position.

Returns
このシートオブジェクトThis sheet object
Parameters
- beforePosition: number
  
  新しい行を追加する必要がある行位置 row position to add a new row
- howMany: number
  
  挿入する行の数 number of rows to insert
Returns Sheet

setName

setName(name: string): Sheet
シート名を設定します。Specify the sheet name.

Returns
このシートオブジェクトThis sheet object
Parameters
- name: string
  
  シートの新しい名前new name of the sheet
Returns Sheet

Interface Sheet

Hierarchy

Index

Methods

Methods

appendRow

Returns

Parameters

rowContents: any[]

Returns Sheet

clear

Returns

Returns Sheet

Returns

Parameters

options: SheetClearOptions

Returns Sheet

getDataRange

Returns

Returns Range

getIndex

Returns

Returns number

getLastColumn

Returns

Returns number

getLastRow

Returns

Returns number

getMaxColumns

Returns

Returns number

getMaxRows

Returns

Returns number

getName

Returns

Returns string

getRange

Returns

Parameters

row: number

column: number

numRows: number

numColumns: number

Returns Range

Returns

Parameters

row: number

column: number

numRows: number

Returns Range

Returns

Parameters

row: number

column: number

Returns Range

Returns

Parameters

a1Notation: string

Returns Range

getRangeList

Returns

Parameters

a1Notations: string[]

Returns RangeList

getSheetId

Returns

Returns number

getSheetName

Returns

Returns string

getSheetValues

Returns

Parameters

startRow: number

startColumn: number

numRows: number

numColumns: number

Returns any[][]