這項服務允許指令碼建立、存取及修改 Google 試算表檔案。另請參閱將資料儲存試算表的指南。
有時候,試算表作業會組合在一起以提升效能,例如對某個方法執行多次呼叫時。如果您想確保所有待處理的變更都能立即執行,例如在指令碼執行時顯示使用者資訊,請呼叫 SpreadsheetApp.flush()
。
類別
AutoFillSeries
屬性
屬性 | 類型 | 說明 |
---|---|---|
DEFAULT_SERIES | Enum | 預設值。 |
ALTERNATE_SERIES | Enum | 使用這項設定的自動填入功能會導致展開範圍內的空白儲存格填入現有值的副本。 |
Banding
方法
BandingTheme
屬性
屬性 | 類型 | 說明 |
---|---|---|
LIGHT_GREY | Enum | 淺灰色錶帶主題。 |
CYAN | Enum | 青色條紋主題。 |
GREEN | Enum | 綠色條紋主題。 |
YELLOW | Enum | 黃色條紋主題。 |
ORANGE | Enum | 橘色條紋主題。 |
BLUE | Enum | 藍色條紋主題。 |
TEAL | Enum | 藍綠色條紋主題。 |
GREY | Enum | 灰色錶帶主題。 |
BROWN | Enum | 棕色條紋主題。 |
LIGHT_GREEN | Enum | 淺綠色條紋主題。 |
INDIGO | Enum | 靛藍色樂團主題。 |
PINK | Enum | 粉紅色條紋主題。 |
BigQueryDataSourceSpec
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
copy() | DataSourceSpecBuilder | 根據這個資料來源的設定建立DataSourceSpecBuilder 。 |
getDatasetId() | String | 取得 BigQuery 資料集 ID。 |
getParameters() | DataSourceParameter[] | 取得資料來源的參數。 |
getProjectId() | String | 取得帳單專案 ID。 |
getRawQuery() | String | 取得原始查詢字串。 |
getTableId() | String | 取得 BigQuery 資料表 ID。 |
getTableProjectId() | String | 取得資料表的 BigQuery 專案 ID。 |
getType() | DataSourceType | 取得資料來源的類型。 |
BigQueryDataSourceSpecBuilder
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
build() | DataSourceSpec | 從這個建構工具的設定建立資料來源規格。 |
copy() | DataSourceSpecBuilder | 根據這個資料來源的設定建立DataSourceSpecBuilder 。 |
getDatasetId() | String | 取得 BigQuery 資料集 ID。 |
getParameters() | DataSourceParameter[] | 取得資料來源的參數。 |
getProjectId() | String | 取得帳單專案 ID。 |
getRawQuery() | String | 取得原始查詢字串。 |
getTableId() | String | 取得 BigQuery 資料表 ID。 |
getTableProjectId() | String | 取得資料表的 BigQuery 專案 ID。 |
getType() | DataSourceType | 取得資料來源的類型。 |
removeAllParameters() | BigQueryDataSourceSpecBuilder | 移除所有參數。 |
removeParameter(parameterName) | BigQueryDataSourceSpecBuilder | 移除指定的參數。 |
setDatasetId(datasetId) | BigQueryDataSourceSpecBuilder | 設定 BigQuery 資料集 ID。 |
setParameterFromCell(parameterName, sourceCell) | BigQueryDataSourceSpecBuilder | 新增參數;如果參數已存在,則更新來源儲存格。 |
setProjectId(projectId) | BigQueryDataSourceSpecBuilder | 設定帳單 BigQuery 專案 ID。 |
setRawQuery(rawQuery) | BigQueryDataSourceSpecBuilder | 設定原始查詢字串。 |
setTableId(tableId) | BigQueryDataSourceSpecBuilder | 設定 BigQuery 資料表 ID。 |
setTableProjectId(projectId) | BigQueryDataSourceSpecBuilder | 設定資料表的 BigQuery 專案 ID。 |
BooleanCondition
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getBackgroundObject() | Color | 取得這個布林值條件的背景顏色。 |
getBold() | Boolean | 如果這個布林條件讓文字變為粗體,會傳回 true ;如果這個布林條件會移除文字中的粗體部分,則傳回 false 。 |
getCriteriaType() | BooleanCriteria | 取得 BooleanCriteria 列舉中定義的規則條件類型。 |
getCriteriaValues() | Object[] | 取得規則條件的引數陣列。 |
getFontColorObject() | Color | 取得這個布林值條件的字型顏色。 |
getItalic() | Boolean | 如果這項布林條件將文字設為斜體,則傳回 true ;如果這個布林條件會從文字中移除斜體,則傳回 false 。 |
getStrikethrough() | Boolean | 如果這個布林條件在文字中解除刪除線,系統會傳回 true ;如果這項布林條件會將文字中的刪除線移除,則傳回 false 。 |
getUnderline() | Boolean | 如果這個布林條件為文字加上底線,則傳回 true ;如果這個布林條件移除文字中的底線,則傳回 false 。 |
BooleanCriteria
屬性
屬性 | 類型 | 說明 |
---|---|---|
CELL_EMPTY | Enum | 如果儲存格空白,就符合條件。 |
CELL_NOT_EMPTY | Enum | 儲存格不是空白時就符合條件。 |
DATE_AFTER | Enum | 只有在日期晚於指定值時才會滿足條件。 |
DATE_BEFORE | Enum | 符合條件的日期早於指定值。 |
DATE_EQUAL_TO | Enum | 日期等於指定值時就會符合條件。 |
DATE_NOT_EQUAL_TO | Enum | 如果日期不等於指定值,就會符合條件。 |
DATE_AFTER_RELATIVE | Enum | 只有在日期晚於相對日期值時才會符合條件。 |
DATE_BEFORE_RELATIVE | Enum | 日期早於相對日期值就會符合條件。 |
DATE_EQUAL_TO_RELATIVE | Enum | 日期等於相對日期值時,即符合條件。 |
NUMBER_BETWEEN | Enum | 只要指定的值介於指定值之間,就算符合條件。 |
NUMBER_EQUAL_TO | Enum | 數字等於指定值時,即符合條件。 |
NUMBER_GREATER_THAN | Enum | 數字大於指定值就會符合條件。 |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | 數字大於或等於指定值時,即符合條件。 |
NUMBER_LESS_THAN | Enum | 符合條件的數字小於指定值。 |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | 假如數字小於或等於指定值,就算符合條件。 |
NUMBER_NOT_BETWEEN | Enum | 如果指定的值並非介於指定值之間,則符合條件。 |
NUMBER_NOT_EQUAL_TO | Enum | 輸入的數字不等於指定值時,即符合條件。 |
TEXT_CONTAINS | Enum | 如果輸入的值含有指定值,就符合條件。 |
TEXT_DOES_NOT_CONTAIN | Enum | 如果輸入的值不包含指定值,就符合條件。 |
TEXT_EQUAL_TO | Enum | 如果輸入內容等於指定值,就會符合條件。 |
TEXT_NOT_EQUAL_TO | Enum | 如果輸入的值不等於指定值,就會符合條件。 |
TEXT_STARTS_WITH | Enum | 只要輸入的值開頭為指定的值,就會符合條件。 |
TEXT_ENDS_WITH | Enum | 只要輸入的內容結束時符合指定值,就會符合條件。 |
CUSTOM_FORMULA | Enum | 如果輸入內容產生了特定公式為 true 的結果,即符合條件。 |
BorderStyle
屬性
屬性 | 類型 | 說明 |
---|---|---|
DOTTED | Enum | 虛線框線。 |
DASHED | Enum | 虛線框線。 |
SOLID | Enum | 細實線框線。 |
SOLID_MEDIUM | Enum | 中等實線框線。 |
SOLID_THICK | Enum | 粗實線框線。 |
DOUBLE | Enum | 兩個實線框線。 |
CellImage
屬性
屬性 | 類型 | 說明 |
---|---|---|
valueType | ValueType | 設為 ValueType.IMAGE 的欄位,代表圖片值類型。 |
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getAltTextDescription() | String | 傳回這張圖片的替代文字說明。 |
getAltTextTitle() | String | 傳回這張圖片的替代文字標題。 |
getContentUrl() | String | 傳回 Google 代管的圖片網址。 |
getUrl() | String | 取得圖片的來源網址;如果沒有網址,則傳回 null 。 |
toBuilder() | CellImageBuilder | 建立建構工具,將圖片轉換為映像檔值類型,以將圖片放入儲存格。 |
CellImageBuilder
屬性
屬性 | 類型 | 說明 |
---|---|---|
valueType | ValueType | 設為 ValueType.IMAGE 的欄位,代表圖片值類型。 |
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
build() | CellImage | 建立在儲存格中新增圖片所需的圖片值類型。 |
getAltTextDescription() | String | 傳回這張圖片的替代文字說明。 |
getAltTextTitle() | String | 傳回這張圖片的替代文字標題。 |
getContentUrl() | String | 傳回 Google 代管的圖片網址。 |
getUrl() | String | 取得圖片的來源網址;如果沒有網址,則傳回 null 。 |
setAltTextDescription(description) | CellImage | 設定這張圖片的替代文字說明。 |
setAltTextTitle(title) | CellImage | 設定這張圖片的替代文字標題。 |
setSourceUrl(url) | CellImageBuilder | 設定圖片來源網址。 |
toBuilder() | CellImageBuilder | 建立建構工具,將圖片轉換為映像檔值類型,以將圖片放入儲存格。 |
Color
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
asRgbColor() | RgbColor | 將這個顏色轉換成 RgbColor 。 |
asThemeColor() | ThemeColor | 將這個顏色轉換成 ThemeColor 。 |
getColorType() | ColorType | 取得這個顏色的類型。 |
ColorBuilder
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
asRgbColor() | RgbColor | 將這個顏色轉換成 RgbColor 。 |
asThemeColor() | ThemeColor | 將這個顏色轉換成 ThemeColor 。 |
build() | Color | 從提供給建構工具的設定建立色彩物件。 |
getColorType() | ColorType | 取得這個顏色的類型。 |
setRgbColor(cssString) | ColorBuilder | 設為 RGB 顏色。 |
setThemeColor(themeColorType) | ColorBuilder | 設為主題顏色。 |
ConditionalFormatRule
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
copy() | ConditionalFormatRuleBuilder | 傳回採用此規則設定的規則建立工具預設。 |
getBooleanCondition() | BooleanCondition | 如果這項規則使用布林條件條件,擷取規則的 BooleanCondition 資訊。 |
getGradientCondition() | GradientCondition | 如果這項規則使用漸層條件,則擷取規則的 GradientCondition 資訊。 |
getRanges() | Range[] | 擷取要套用這項條件式格式規則的範圍。 |
ConditionalFormatRuleBuilder
方法
ContainerInfo
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getAnchorColumn() | Integer | 圖表左側則固定在這個欄中。 |
getAnchorRow() | Integer | 圖表的頂端會固定在這個列中。 |
getOffsetX() | Integer | 圖表左上角與錨點欄的偏移值偏移。 |
getOffsetY() | Integer | 圖表左上角與錨定列偏移這個像素的距離。 |
CopyPasteType
屬性
屬性 | 類型 | 說明 |
---|---|---|
PASTE_NORMAL | Enum | 貼上值、公式、格式和合併項目。 |
PASTE_NO_BORDERS | Enum | 貼上值、公式、格式並進行合併,但不加上框線。 |
PASTE_FORMAT | Enum | 請只貼上格式。 |
PASTE_FORMULA | Enum | 僅貼上公式。 |
PASTE_DATA_VALIDATION | Enum | 僅貼上驗證資料。 |
PASTE_VALUES | Enum | 「只」貼上值,但不要加入格式、公式或合併項目。 |
PASTE_CONDITIONAL_FORMATTING | Enum | 僅貼上色彩規則。 |
PASTE_COLUMN_WIDTHS | Enum | 僅貼上欄寬。 |
DataExecutionErrorCode
屬性
屬性 | 類型 | 說明 |
---|---|---|
DATA_EXECUTION_ERROR_CODE_UNSUPPORTED | Enum | Apps Script 不支援的資料執行錯誤代碼。 |
NONE | Enum | 資料執行作業未發生任何錯誤。 |
TIME_OUT | Enum | 資料執行逾時。 |
TOO_MANY_ROWS | Enum | 資料執行傳回的列數超出上限。 |
TOO_MANY_COLUMNS | Enum | 資料執行傳回的資料欄數量超出上限。 |
TOO_MANY_CELLS | Enum | 資料執行結果傳回的儲存格數量超出上限。 |
ENGINE | Enum | 資料執行引擎錯誤。 |
PARAMETER_INVALID | Enum | 資料執行參數無效。 |
UNSUPPORTED_DATA_TYPE | Enum | 資料執行作業傳回不支援的資料類型。 |
DUPLICATE_COLUMN_NAMES | Enum | 資料執行作業會傳回重複的資料欄名稱。 |
INTERRUPTED | Enum | 資料執行中斷。 |
OTHER | Enum | 其他錯誤。 |
TOO_MANY_CHARS_PER_CELL | Enum | 資料執行傳回的值超過單一儲存格允許的字元數上限。 |
DATA_NOT_FOUND | Enum | 找不到資料來源參照的資料庫。 |
PERMISSION_DENIED | Enum | 使用者無法存取資料來源參照的資料庫。 |
DataExecutionState
屬性
屬性 | 類型 | 說明 |
---|---|---|
DATA_EXECUTION_STATE_UNSUPPORTED | Enum | Apps Script 不支援資料執行狀態。 |
RUNNING | Enum | 資料執行程序已開始且正在執行。 |
SUCCESS | Enum | 資料執行完畢且成功執行。 |
ERROR | Enum | 資料執行完畢且發生錯誤。 |
NOT_STARTED | Enum | 資料執行程序尚未開始。 |
DataExecutionStatus
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getErrorCode() | DataExecutionErrorCode | 取得資料執行作業的錯誤代碼。 |
getErrorMessage() | String | 取得資料執行的錯誤訊息。 |
getExecutionState() | DataExecutionState | 取得資料執行的狀態。 |
getLastExecutionTime() | Date | 取得上次資料執行完成的時間,無論執行作業狀態為何。 |
getLastRefreshedTime() | Date | 取得資料上次成功重新整理的時間。 |
isTruncated() | Boolean | 如果上次成功執行的資料遭到截斷,系統會傳回 true ,否則會傳回 false 。 |
DataSource
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
cancelAllLinkedDataSourceObjectRefreshes() | void | 針對與此資料來源連結的資料來源物件,取消所有目前正在執行的重新整理作業。 |
createCalculatedColumn(name, formula) | DataSourceColumn | 建立計算欄。 |
createDataSourcePivotTableOnNewSheet() | DataSourcePivotTable | 在新工作表的第一個儲存格中,以這個資料來源建立資料來源資料透視表。 |
createDataSourceTableOnNewSheet() | DataSourceTable | 在新工作表的第一個儲存格中,根據這個資料來源建立資料來源表格。 |
getCalculatedColumnByName(columnName) | DataSourceColumn | 傳回資料來源中與資料欄名稱相符的計算結果欄。 |
getCalculatedColumns() | DataSourceColumn[] | 傳回資料來源中的所有計算結果欄。 |
getColumns() | DataSourceColumn[] | 傳回資料來源中的所有資料欄。 |
getDataSourceSheets() | DataSourceSheet[] | 傳回與這個資料來源相關聯的資料來源工作表。 |
getSpec() | DataSourceSpec | 取得資料來源規格。 |
refreshAllLinkedDataSourceObjects() | void | 重新整理與資料來源連結的所有資料來源物件。 |
updateSpec(spec) | DataSource | 更新資料來源規格,並重新整理與這個資料來源相連結的資料來源物件,以符合新規格。 |
updateSpec(spec, refreshAllLinkedObjects) | DataSource | 更新資料來源規格,並根據新規格重新整理連結的 data
source sheets 。 |
waitForAllDataExecutionsCompletion(timeoutInSeconds) | void | 等待連結資料來源物件的所有目前執行作業完成,並在提供的秒數過後逾時。 |
DataSourceChart
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
cancelDataRefresh() | DataSourceChart | 如果這個物件正在執行中,則取消相關的資料重新整理作業。 |
forceRefreshData() | DataSourceChart | 重新整理這個物件的資料,無論目前狀態為何。 |
getDataSource() | DataSource | 取得物件連結的資料來源。 |
getStatus() | DataExecutionStatus | 取得物件的資料執行狀態。 |
refreshData() | DataSourceChart | 重新整理物件資料。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 等到目前的執行作業完成,並在指定的秒數過後逾時。 |
DataSourceColumn
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getDataSource() | DataSource | 取得與資料來源欄相關聯的資料來源。 |
getFormula() | String | 取得資料來源欄的公式。 |
getName() | String | 取得資料來源欄的名稱。 |
hasArrayDependency() | Boolean | 傳回資料欄是否具有陣列依附關係。 |
isCalculatedColumn() | Boolean | 傳回該欄是否為計算結果欄。 |
remove() | void | 移除資料來源欄。 |
setFormula(formula) | DataSourceColumn | 設定資料來源欄的公式。 |
setName(name) | DataSourceColumn | 設定資料來源資料欄的名稱。 |
DataSourceFormula
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
cancelDataRefresh() | DataSourceFormula | 如果這個物件正在執行中,則取消相關的資料重新整理作業。 |
forceRefreshData() | DataSourceFormula | 重新整理這個物件的資料,無論目前狀態為何。 |
getAnchorCell() | Range | 傳回 Range 代表固定此資料來源公式的儲存格。 |
getDataSource() | DataSource | 取得物件連結的資料來源。 |
getDisplayValue() | String | 傳回資料來源公式的顯示值。 |
getFormula() | String | 傳回這個資料來源公式的公式。 |
getStatus() | DataExecutionStatus | 取得物件的資料執行狀態。 |
refreshData() | DataSourceFormula | 重新整理物件資料。 |
setFormula(formula) | DataSourceFormula | 更新公式。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 等到目前的執行作業完成,並在指定的秒數過後逾時。 |
DataSourceParameter
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getName() | String | 取得參數名稱。 |
getSourceCell() | String | 取得指定參數的來源儲存格;如果參數類型不是 DataSourceParameterType.CELL ,則會取得 null 。 |
getType() | DataSourceParameterType | 取得參數類型。 |
DataSourceParameterType
屬性
屬性 | 類型 | 說明 |
---|---|---|
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED | Enum | Apps Script 不支援的資料來源參數類型。 |
CELL | Enum | 資料來源參數是根據儲存格的值。 |
DataSourcePivotTable
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
addColumnGroup(columnName) | PivotGroup | 依據指定資料來源欄新增資料透視欄群組。 |
addFilter(columnName, filterCriteria) | PivotFilter | 根據指定的資料來源欄,以指定的篩選條件新增篩選器。 |
addPivotValue(columnName, summarizeFunction) | PivotValue | 根據具有指定摘要函式的指定資料來源資料欄,新增資料透視值。 |
addRowGroup(columnName) | PivotGroup | 依據指定資料來源欄新增資料透視列群組。 |
asPivotTable() | PivotTable | 以一般的資料透視表物件傳回資料來源資料透視表。 |
cancelDataRefresh() | DataSourcePivotTable | 如果這個物件正在執行中,則取消相關的資料重新整理作業。 |
forceRefreshData() | DataSourcePivotTable | 重新整理這個物件的資料,無論目前狀態為何。 |
getDataSource() | DataSource | 取得物件連結的資料來源。 |
getStatus() | DataExecutionStatus | 取得物件的資料執行狀態。 |
refreshData() | DataSourcePivotTable | 重新整理物件資料。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 等到目前的執行作業完成,並在指定的秒數過後逾時。 |
DataSourceRefreshSchedule
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getFrequency() | DataSourceRefreshScheduleFrequency | 取得重新整理排程頻率,指定重新整理的頻率和時間。 |
getScope() | DataSourceRefreshScope | 取得這項重新整理排程的範圍。 |
getTimeIntervalOfNextRun() | TimeInterval | 取得這項重新整理排程下次執行的時間。 |
isEnabled() | Boolean | 決定是否啟用這項重新整理時間表。 |
DataSourceRefreshScheduleFrequency
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getDaysOfTheMonth() | Integer[] | 取得當月日期以數字 (1-28) 表示,用於重新整理資料來源。 |
getDaysOfTheWeek() | Weekday[] | 取得星期幾重新整理資料來源。 |
getFrequencyType() | FrequencyType | 取得頻率類型。 |
getStartHour() | Integer | 取得重新整理排程執行時間間隔的開始小時 (數字 0 到 23)。 |
DataSourceRefreshScope
屬性
屬性 | 類型 | 說明 |
---|---|---|
DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTED | Enum | 不支援這個資料來源重新整理範圍。 |
ALL_DATA_SOURCES | Enum | 重新整理的設定會套用至試算表中的所有資料來源。 |
DataSourceSheet
方法
DataSourceSheetFilter
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | 傳回要套用這個篩選器的資料來源欄。 |
getDataSourceSheet() | DataSourceSheet | 傳回這個篩選器所屬的 DataSourceSheet 。 |
getFilterCriteria() | FilterCriteria | 傳回這個篩選器的篩選條件。 |
remove() | void | 從資料來源物件中移除這個篩選器。 |
setFilterCriteria(filterCriteria) | DataSourceSheetFilter | 設定這個篩選器的篩選條件。 |
DataSourceSpec
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
asBigQuery() | BigQueryDataSourceSpec | 取得 BigQuery 資料來源的規格。 |
copy() | DataSourceSpecBuilder | 根據這個資料來源的設定建立DataSourceSpecBuilder 。 |
getParameters() | DataSourceParameter[] | 取得資料來源的參數。 |
getType() | DataSourceType | 取得資料來源的類型。 |
DataSourceSpecBuilder
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
asBigQuery() | BigQueryDataSourceSpecBuilder | 取得 BigQuery 資料來源的建構工具。 |
build() | DataSourceSpec | 從這個建構工具的設定建立資料來源規格。 |
copy() | DataSourceSpecBuilder | 根據這個資料來源的設定建立DataSourceSpecBuilder 。 |
getParameters() | DataSourceParameter[] | 取得資料來源的參數。 |
getType() | DataSourceType | 取得資料來源的類型。 |
removeAllParameters() | DataSourceSpecBuilder | 移除所有參數。 |
removeParameter(parameterName) | DataSourceSpecBuilder | 移除指定的參數。 |
setParameterFromCell(parameterName, sourceCell) | DataSourceSpecBuilder | 新增參數;如果參數已存在,則更新來源儲存格。 |
DataSourceTable
方法
DataSourceTableColumn
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | 取得資料來源欄。 |
remove() | void | 從 DataSourceTable 中移除資料欄。 |
DataSourceTableFilter
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | 傳回要套用這個篩選器的資料來源欄。 |
getDataSourceTable() | DataSourceTable | 傳回這個篩選器所屬的 DataSourceTable 。 |
getFilterCriteria() | FilterCriteria | 傳回這個篩選器的篩選條件。 |
remove() | void | 從資料來源物件中移除這個篩選器。 |
setFilterCriteria(filterCriteria) | DataSourceTableFilter | 設定這個篩選器的篩選條件。 |
DataSourceType
屬性
屬性 | 類型 | 說明 |
---|---|---|
DATA_SOURCE_TYPE_UNSUPPORTED | Enum | Apps Script 不支援的資料來源類型。 |
BIGQUERY | Enum | BigQuery 資料來源。 |
DataValidation
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
copy() | DataValidationBuilder | 根據這項規則的設定,建立資料驗證規則的建構工具。 |
getAllowInvalid() | Boolean | 如果規則在輸入失敗資料驗證時顯示警告,會傳回 true ;如果規則完全拒絕輸入,則傳回 false 。 |
getCriteriaType() | DataValidationCriteria | 取得 DataValidationCriteria 列舉中定義的規則條件類型。 |
getCriteriaValues() | Object[] | 取得規則條件的引數陣列。 |
getHelpText() | String | 取得規則的說明文字;如果未設定說明文字,則為 null 。 |
DataValidationBuilder
方法
DataValidationCriteria
屬性
屬性 | 類型 | 說明 |
---|---|---|
DATE_AFTER | Enum | 必須提供晚於指定值的日期。 |
DATE_BEFORE | Enum | 必須提供早於指定值的日期。 |
DATE_BETWEEN | Enum | 必須提供介於指定值之間的日期。 |
DATE_EQUAL_TO | Enum | 必須提供與指定值相等的日期。 |
DATE_IS_VALID_DATE | Enum | 必須提供日期。 |
DATE_NOT_BETWEEN | Enum | 必須提供非指定值之間的日期。 |
DATE_ON_OR_AFTER | Enum | 必須提供等於或晚於指定值的日期。 |
DATE_ON_OR_BEFORE | Enum | 必須提供等於或早於指定值的日期。 |
NUMBER_BETWEEN | Enum | 必須提供介於指定值之間的數字。 |
NUMBER_EQUAL_TO | Enum | 要求的數字必須等於指定值。 |
NUMBER_GREATER_THAN | Enum | 數值必須大於指定值。 |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | 要求的數字必須大於或等於指定值。 |
NUMBER_LESS_THAN | Enum | 必須提供小於指定值的數字。 |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | 必須提供小於或等於指定值的數字。 |
NUMBER_NOT_BETWEEN | Enum | 必須提供非指定值之間的數字。 |
NUMBER_NOT_EQUAL_TO | Enum | 必須提供不等於指定值的數字。 |
TEXT_CONTAINS | Enum | 輸入內容必須包含指定值。 |
TEXT_DOES_NOT_CONTAIN | Enum | 輸入內容中不含指定值。 |
TEXT_EQUAL_TO | Enum | 輸入內容必須等於指定值。 |
TEXT_IS_VALID_EMAIL | Enum | 必須輸入電子郵件地址形式。 |
TEXT_IS_VALID_URL | Enum | 必須輸入網址格式。 |
VALUE_IN_LIST | Enum | 輸入內容必須與其中一個指定值相等。 |
VALUE_IN_RANGE | Enum | 要求輸入內容等於指定範圍內的值。 |
CUSTOM_FORMULA | Enum | 要求輸入內容會將指定的公式計算為 true 。 |
CHECKBOX | Enum | 必須輸入自訂值或布林值;顯示為核取方塊。 |
DateTimeGroupingRule
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getRuleType() | DateTimeGroupingRuleType | 取得日期時間分組規則的類型。 |
DateTimeGroupingRuleType
屬性
屬性 | 類型 | 說明 |
---|---|---|
UNSUPPORTED | Enum | 不支援的日期時間分組規則類型。 |
SECOND | Enum | 將日期和時間分組 (從 0 到 59), |
MINUTE | Enum | 以分鐘 (0 到 59) 為單位分組的日期時間。 |
HOUR | Enum | 使用 24 小時的系統 (0 到 23) 將日期時間分組。 |
HOUR_MINUTE | Enum | 使用 24 小時系統按小時和分鐘將日期時間分組,例如 19:45 。 |
HOUR_MINUTE_AMPM | Enum | 使用 12 小時系統按小時和分鐘將日期時間分組,例如 7:45 PM 。 |
DAY_OF_WEEK | Enum | 依星期幾分組的日期時間,例如 Sunday 。 |
DAY_OF_YEAR | Enum | 依星期幾分組的日期時間 (1 到 366), |
DAY_OF_MONTH | Enum | 依日期分組的日期時間 (從 1 到 31), |
DAY_MONTH | Enum | 依日期和月份分組的日期時間,例如 22-Nov 。 |
MONTH | Enum | 按月分組的日期時間,例如 Nov 。 |
QUARTER | Enum | 按季分組的日期時間,例如 Q1 (1 至 3 月)。 |
YEAR | Enum | 按年份分組的日期時間,例如 2008。 |
YEAR_MONTH | Enum | 依年和月份分組的日期時間,例如 2008-Nov 。 |
YEAR_QUARTER | Enum | 依年份和季度分組的日期時間,例如 2008 Q4 。 |
YEAR_MONTH_DAY | Enum | 按年、月和日分組的日期時間,例如 2008-11-22 。 |
DeveloperMetadata
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getId() | Integer | 傳回與此開發人員中繼資料相關聯的專屬 ID。 |
getKey() | String | 傳回與此開發人員中繼資料相關聯的金鑰。 |
getLocation() | DeveloperMetadataLocation | 傳回此開發人員中繼資料的位置。 |
getValue() | String | 傳回與此開發人員中繼資料相關聯的值;如果這個中繼資料沒有任何值,則傳回 null 。 |
getVisibility() | DeveloperMetadataVisibility | 傳回這項開發人員中繼資料的瀏覽權限。 |
moveToColumn(column) | DeveloperMetadata | 將此開發人員中繼資料移至指定資料欄。 |
moveToRow(row) | DeveloperMetadata | 將此開發人員中繼資料移至指定資料列。 |
moveToSheet(sheet) | DeveloperMetadata | 將此開發人員中繼資料移至指定的工作表。 |
moveToSpreadsheet() | DeveloperMetadata | 將這個開發人員中繼資料移至頂層試算表。 |
remove() | void | 刪除這項中繼資料。 |
setKey(key) | DeveloperMetadata | 將這項開發人員中繼資料的鍵設為指定值。 |
setValue(value) | DeveloperMetadata | 將與這項開發人員中繼資料相關聯的值設為指定值。 |
setVisibility(visibility) | DeveloperMetadata | 將這個開發人員中繼資料的瀏覽權限設為指定的瀏覽權限。 |
DeveloperMetadataFinder
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
find() | DeveloperMetadata[] | 執行這項搜尋,並傳回相符的中繼資料。 |
onIntersectingLocations() | DeveloperMetadataFinder | 將搜尋設為考慮與中繼資料相交的位置。 |
withId(id) | DeveloperMetadataFinder | 將這項搜尋限制在僅考量符合指定 ID 的中繼資料。 |
withKey(key) | DeveloperMetadataFinder | 將搜尋範圍限制在僅考慮符合指定鍵的中繼資料。 |
withLocationType(locationType) | DeveloperMetadataFinder | 將搜尋範圍限制在符合指定位置類型的中繼資料。 |
withValue(value) | DeveloperMetadataFinder | 將搜尋範圍限制在僅考量符合指定值的中繼資料。 |
withVisibility(visibility) | DeveloperMetadataFinder | 將搜尋範圍限制在僅考量符合指定瀏覽權限的中繼資料。 |
DeveloperMetadataLocation
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getColumn() | Range | 傳回此中繼資料資料欄位置的 Range ;如果位置類型不是 DeveloperMetadataLocationType.COLUMN ,則傳回 null 。 |
getLocationType() | DeveloperMetadataLocationType | 取得位置的類型。 |
getRow() | Range | 傳回此中繼資料的資料列位置的 Range ;如果位置類型不是 DeveloperMetadataLocationType.ROW ,則傳回 null 。 |
getSheet() | Sheet | 傳回此中繼資料的 Sheet 位置;如果位置類型不是 DeveloperMetadataLocationType.SHEET ,則傳回 null 。 |
getSpreadsheet() | Spreadsheet | 傳回此中繼資料的 Spreadsheet 位置;如果位置類型不是 DeveloperMetadataLocationType.SPREADSHEET ,則傳回 null 。 |
DeveloperMetadataLocationType
屬性
屬性 | 類型 | 說明 |
---|---|---|
SPREADSHEET | Enum | 與頂層試算表相關聯的開發人員中繼資料位置類型。 |
SHEET | Enum | 與整份工作表相關聯的開發人員中繼資料位置類型。 |
ROW | Enum | 與資料列相關聯的開發人員中繼資料位置類型。 |
COLUMN | Enum | 與資料欄相關聯的開發人員中繼資料位置類型。 |
DeveloperMetadataVisibility
屬性
屬性 | 類型 | 說明 |
---|---|---|
DOCUMENT | Enum | 凡是具備文件存取權的開發人員專案,都能存取文件瀏覽權限中繼資料。 |
PROJECT | Enum | 只有建立中繼資料的開發人員專案才能查看及存取專案可見的中繼資料。 |
Dimension
屬性
屬性 | 類型 | 說明 |
---|---|---|
COLUMNS | Enum | 欄 (垂直) 維度。 |
ROWS | Enum | 列 (水平) 維度。 |
Direction
屬性
屬性 | 類型 | 說明 |
---|---|---|
UP | Enum | 遞減資料列索引的方向。 |
DOWN | Enum | 資料列索引的遞增方向。 |
PREVIOUS | Enum | 遞減資料欄索引的方向。 |
NEXT | Enum | 遞增資料欄索引的方向。 |
Drawing
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getContainerInfo() | ContainerInfo | 取得繪圖在工作表中位置的相關資訊。 |
getHeight() | Integer | 傳回此繪圖的實際高度 (以像素為單位)。 |
getOnAction() | String | 傳回附加至此繪圖的巨集名稱。 |
getSheet() | Sheet | 傳回顯示這個繪圖的工作表。 |
getWidth() | Integer | 傳回此繪圖的實際寬度 (以像素為單位)。 |
getZIndex() | Number | 傳回此繪圖的 Z-index。 |
remove() | void | 從試算表中刪除這個繪圖。 |
setHeight(height) | Drawing | 設定此繪圖的實際高度 (以像素為單位)。 |
setOnAction(macroName) | Drawing | 為這個繪圖指派巨集函式。 |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Drawing | 設定繪圖在工作表中的顯示位置。 |
setWidth(width) | Drawing | 設定此繪圖的實際寬度 (以像素為單位)。 |
setZIndex(zIndex) | Drawing | 設定此繪圖的 Z-index。 |
EmbeddedAreaChartBuilder
方法
EmbeddedBarChartBuilder
方法
EmbeddedChart
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
asDataSourceChart() | DataSourceChart | 如果圖表是資料來源圖表,則轉換為資料來源圖表執行個體;如果不是,則轉換為 null 。 |
getAs(contentType) | Blob | 傳回這個物件中的資料,做為已轉換為指定內容類型的 blob。 |
getBlob() | Blob | 傳回這個物件中的資料,做為 blob。 |
getChartId() | Integer | 針對包含圖表的試算表傳回該圖表專屬的固定 ID;如果圖表不在試算表內,則傳回 null 。 |
getContainerInfo() | ContainerInfo | 傳回圖表在工作表中位置的相關資訊。 |
getHiddenDimensionStrategy() | ChartHiddenDimensionStrategy | 傳回處理隱藏列和欄的策略。 |
getMergeStrategy() | ChartMergeStrategy | 傳回有多個範圍時採用的合併策略。 |
getNumHeaders() | Integer | 傳回範圍視為標題的列數或欄數。 |
getOptions() | ChartOptions | 傳回這個圖表的選項,例如高度、顏色和軸。 |
getRanges() | Range[] | 傳回這張圖表用來做為資料來源的範圍。 |
getTransposeRowsAndColumns() | Boolean | 如果為 true ,系統會切換用於填入圖表的資料列與資料欄。 |
modify() | EmbeddedChartBuilder | 傳回可用來修改此圖表的 EmbeddedChartBuilder 。 |
EmbeddedChartBuilder
方法
EmbeddedColumnChartBuilder
方法
EmbeddedComboChartBuilder
方法
EmbeddedHistogramChartBuilder
方法
EmbeddedLineChartBuilder
方法
EmbeddedPieChartBuilder
方法
EmbeddedScatterChartBuilder
方法
EmbeddedTableChartBuilder
方法
Filter
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getColumnFilterCriteria(columnPosition) | FilterCriteria | 取得指定資料欄的篩選條件;如果資料欄未套用篩選條件,則會取得 null 。 |
getRange() | Range | 取得這個篩選器適用的範圍。 |
remove() | void | 移除這個篩選器。 |
removeColumnFilterCriteria(columnPosition) | Filter | 從指定資料欄中移除篩選條件。 |
setColumnFilterCriteria(columnPosition, filterCriteria) | Filter | 設定指定資料欄的篩選條件。 |
sort(columnPosition, ascending) | Filter | 按照指定資料欄排序篩選範圍,但排除此篩選器所適用的範圍內的第一列 (標題列)。 |
FilterCriteria
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
copy() | FilterCriteriaBuilder | 複製此篩選條件並建立可套用至其他篩選器的條件建構工具。 |
getCriteriaType() | BooleanCriteria | 傳回條件的布林值類型,例如 CELL_EMPTY 。 |
getCriteriaValues() | Object[] | 傳回布林值條件的引數陣列。 |
getHiddenValues() | String[] | 傳回篩選器隱藏的值。 |
getVisibleBackgroundColor() | Color | 傳回做為篩選條件使用的背景顏色。 |
getVisibleForegroundColor() | Color | 傳回做為篩選條件的前景顏色。 |
getVisibleValues() | String[] | 傳回資料透視表篩選器顯示的值。 |
FilterCriteriaBuilder
方法
FrequencyType
屬性
屬性 | 類型 | 說明 |
---|---|---|
FREQUENCY_TYPE_UNSUPPORTED | Enum | 不支援此頻率類型。 |
DAILY | Enum | 每日重新整理。 |
WEEKLY | Enum | 每週更新一次。 |
MONTHLY | Enum | 每月的指定日期更新。 |
GradientCondition
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getMaxColorObject() | Color | 取得此漸層條件的最大值顏色集。 |
getMaxType() | InterpolationType | 取得此漸層條件的最大值的內插類型。 |
getMaxValue() | String | 取得此漸層條件的最大值。 |
getMidColorObject() | Color | 取得這個漸層條件的中點值的顏色。 |
getMidType() | InterpolationType | 取得這個漸層條件的中點值內插類型。 |
getMidValue() | String | 取得這個漸層條件的中點值。 |
getMinColorObject() | Color | 取得此漸層條件的最小值的顏色組合。 |
getMinType() | InterpolationType | 取得此漸層條件的最小值的內插類型。 |
getMinValue() | String | 取得此漸層條件的最小值。 |
Group
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
collapse() | Group | 收合這個群組。 |
expand() | Group | 展開這個群組。 |
getControlIndex() | Integer | 傳回這個群組的控制切換索引。 |
getDepth() | Integer | 傳回這個群組的深度。 |
getRange() | Range | 傳回這個群組的存在範圍。 |
isCollapsed() | Boolean | 如果這個群組已收合,則傳回 true 。 |
remove() | void | 從工作表中移除這個群組,逐一減少 range 的群組深度。 |
GroupControlTogglePosition
屬性
屬性 | 類型 | 說明 |
---|---|---|
BEFORE | Enum | 控制項切換按鈕位於群組之前的位置 (索引較低)。 |
AFTER | Enum | 控制項切換鈕位於群組之後的位置 (位於較高索引處)。 |
InterpolationType
屬性
屬性 | 類型 | 說明 |
---|---|---|
NUMBER | Enum | 使用數字做為漸層條件的特定內插點。 |
PERCENT | Enum | 請使用數字做為漸層條件的內插點百分比內插點。 |
PERCENTILE | Enum | 請使用數字做為漸層條件的百分位數內插點。 |
MIN | Enum | 將最小數值推斷為漸層條件的具體內插點。 |
MAX | Enum | 將最大數字推斷為漸層條件的特定內插點。 |
NamedRange
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getName() | String | 取得這個已命名範圍的名稱。 |
getRange() | Range | 取得這個已命名範圍參照的範圍。 |
remove() | void | 刪除這個已命名範圍。 |
setName(name) | NamedRange | 設定/更新已命名範圍的名稱。 |
setRange(range) | NamedRange | 設定/更新這個已命名範圍的範圍。 |
OverGridImage
方法
PageProtection
PivotFilter
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getFilterCriteria() | FilterCriteria | 傳回這個資料透視篩選器的篩選條件。 |
getPivotTable() | PivotTable | 傳回這個篩選器所屬的 PivotTable 。 |
getSourceDataColumn() | Integer | 傳回這個篩選器運作的來源資料欄數量。 |
getSourceDataSourceColumn() | DataSourceColumn | 傳回篩選器運作的資料來源欄。 |
remove() | void | 從資料透視表中移除這個資料透視篩選器。 |
setFilterCriteria(filterCriteria) | PivotFilter | 設定這個資料透視篩選器的篩選條件。 |
PivotGroup
方法
PivotGroupLimit
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getCountLimit() | Integer | 取得資料透視表中資料列或資料欄的數量上限。 |
getPivotGroup() | PivotGroup | 傳回限制所屬的資料透視群組。 |
remove() | void | 移除資料透視表元素分組限制。 |
setCountLimit(countLimit) | PivotGroupLimit | 設定資料透視表中資料列或資料欄的計數限制。 |
PivotTable
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
addCalculatedPivotValue(name, formula) | PivotValue | 以指定的 name 計算指定 formula 的資料透視表中建立新的資料透視表。 |
addColumnGroup(sourceDataColumn) | PivotGroup | 定義資料透視表中新的資料透視欄分組。 |
addFilter(sourceDataColumn, filterCriteria) | PivotFilter | 為資料透視表建立新的資料透視篩選器。 |
addPivotValue(sourceDataColumn, summarizeFunction) | PivotValue | 使用指定的 summarizeFunction 定義資料透視表中的新資料透視值。 |
addRowGroup(sourceDataColumn) | PivotGroup | 定義資料透視表中新的資料透視列分組。 |
asDataSourcePivotTable() | DataSourcePivotTable | 如果資料透視表已連結至 DataSource ,則傳回資料透視表做為資料來源資料透視表;否則會傳回 null 。 |
getAnchorCell() | Range | 傳回 Range ,代表這個資料透視表錨定位置的儲存格。 |
getColumnGroups() | PivotGroup[] | 傳回這個資料透視表中資料欄群組已排序的清單。 |
getFilters() | PivotFilter[] | 傳回這個資料透視表中經過排序的篩選器清單。 |
getPivotValues() | PivotValue[] | 傳回這個資料透視表中資料透視表值的排序清單。 |
getRowGroups() | PivotGroup[] | 傳回這個資料透視表中列群組已排序的清單。 |
getSourceDataRange() | Range | 傳回建立資料透視表的來源資料範圍。 |
getValuesDisplayOrientation() | Dimension | 傳回值要以列或欄的形式顯示。 |
remove() | void | 刪除這個資料透視表。 |
setValuesDisplayOrientation(dimension) | PivotTable | 設定這個資料透視表的版面配置,以欄或列的形式顯示值。 |
PivotTableSummarizeFunction
屬性
屬性 | 類型 | 說明 |
---|---|---|
CUSTOM | Enum | 自訂函式,這個值僅適用於計算結果欄位。 |
SUM | Enum | SUM 函式 |
COUNTA | Enum | COUNTA 函式 |
COUNT | Enum | COUNT 函式 |
COUNTUNIQUE | Enum | COUNTUNIQUE 函式 |
AVERAGE | Enum | AVERAGE 函式 |
MAX | Enum | MAX 函式 |
MIN | Enum | MIN 函式 |
MEDIAN | Enum | MEDIAN 函式 |
PRODUCT | Enum | PRODUCT 函式 |
STDEV | Enum | STDEV 函式 |
STDEVP | Enum | STDEVP 函式 |
VAR | Enum | VAR 函式 |
VARP | Enum | VARP 函式 |
PivotValue
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getDisplayType() | PivotValueDisplayType | 會傳回顯示類型,說明這個資料透視值目前在表格中的顯示方式。 |
getFormula() | String | 傳回計算這個值的公式。 |
getPivotTable() | PivotTable | 傳回這個值所屬的 PivotTable 。 |
getSourceDataColumn() | Integer | 傳回資料透視值匯總的來源資料欄數量。 |
getSourceDataSourceColumn() | DataSourceColumn | 傳回資料透視值摘要的資料來源欄。 |
getSummarizedBy() | PivotTableSummarizeFunction | 傳回這個群組的摘要函式。 |
remove() | void | 從資料透視表中移除這個值。 |
setDisplayName(name) | PivotValue | 設定資料透視表中這個值的顯示名稱。 |
setFormula(formula) | PivotValue | 設定用來計算這個值的公式。 |
showAs(displayType) | PivotValue | 系統會在資料透視表中顯示這個值,當做另一個值的函式。 |
summarizeBy(summarizeFunction) | PivotValue | 設定摘要函式。 |
PivotValueDisplayType
屬性
屬性 | 類型 | 說明 |
---|---|---|
DEFAULT | Enum | 預設值。 |
PERCENT_OF_ROW_TOTAL | Enum | 顯示資料透視值佔該列總值的百分比。 |
PERCENT_OF_COLUMN_TOTAL | Enum | 以該欄總計百分比顯示資料透視值。 |
PERCENT_OF_GRAND_TOTAL | Enum | 顯示資料透視值佔總體總值的百分比。 |
Protection
方法
ProtectionType
屬性
屬性 | 類型 | 說明 |
---|---|---|
RANGE | Enum | 保護範圍 |
SHEET | Enum | 保護工作表: |
Range
方法
RangeList
方法
RecalculationInterval
屬性
屬性 | 類型 | 說明 |
---|---|---|
ON_CHANGE | Enum | 只有在值有所變更時,才重新計算。 |
MINUTE | Enum | 重新計算值變更的時間,以及每分鐘。 |
HOUR | Enum | 重新計算值變更的時間,以及每小時變更一次。 |
RelativeDate
屬性
屬性 | 類型 | 說明 |
---|---|---|
TODAY | Enum | 與目前日期比較的日期。 |
TOMORROW | Enum | 與目前日期相較的日期。 |
YESTERDAY | Enum | 與目前日期之前的日期比較。 |
PAST_WEEK | Enum | 在過去一週內的日期。 |
PAST_MONTH | Enum | 在過去一個月內的日期。 |
PAST_YEAR | Enum | 在過去一年內的日期。 |
RichTextValue
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
copy() | RichTextValueBuilder | 傳回以此 RTF 值初始化的 Rich Text 值的建構工具。 |
getEndIndex() | Integer | 取得儲存格中這個值的結束索引。 |
getLinkUrl() | String | 傳回這個值的連結網址。 |
getLinkUrl(startOffset, endOffset) | String | 傳回從 startOffset 到 endOffset 的文字的連結網址。 |
getRuns() | RichTextValue[] | 傳回分割為執行陣列的 Rich Text 字串,其中每次執行是具有一致文字樣式的最長可能子字串。 |
getStartIndex() | Integer | 取得儲存格中這個值的起始索引。 |
getText() | String | 傳回這個值的文字。 |
getTextStyle() | TextStyle | 傳回這個值的文字樣式。 |
getTextStyle(startOffset, endOffset) | TextStyle | 傳回 startOffset 到 endOffset 的文字樣式。 |
RichTextValueBuilder
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
build() | RichTextValue | 以這個建構工具建立 Rich Text 值。 |
setLinkUrl(startOffset, endOffset, linkUrl) | RichTextValueBuilder | 設定這個值的特定子字串連結網址;如果 linkUrl 為 null ,則會清除網址。 |
setLinkUrl(linkUrl) | RichTextValueBuilder | 設定整個值的連結網址;如果 linkUrl 為 null ,則會清除網址。 |
setText(text) | RichTextValueBuilder | 設定這個值的文字,並清除任何現有的文字樣式。 |
setTextStyle(startOffset, endOffset, textStyle) | RichTextValueBuilder | 將文字樣式套用至此值的指定子字串。 |
setTextStyle(textStyle) | RichTextValueBuilder | 將文字樣式套用至整個值。 |
Selection
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getActiveRange() | Range | 傳回有效工作表中的所選範圍;如果沒有有效範圍,則傳回 null 。 |
getActiveRangeList() | RangeList | 傳回使用中工作表中的有效範圍清單;如果沒有有效範圍,則傳回 null 。 |
getActiveSheet() | Sheet | 傳回試算表中已啟用的工作表。 |
getCurrentCell() | Range | 傳回目前在任一有效範圍中選取的儲存格 (已醒目顯示的儲存格)。如果目前沒有儲存格,則傳回 null 。 |
getNextDataRange(direction) | Range | 從 current cell 和 active range 開始並往指定方向移動,並傳回調整後的範圍,其中範圍的適當邊緣已移動以涵蓋 next data cell ,同時仍涵蓋目前的儲存格。 |
Sheet
方法
SheetType
屬性
屬性 | 類型 | 說明 |
---|---|---|
GRID | Enum | 內含格狀檢視畫面的工作表。 |
OBJECT | Enum | 內含單一嵌入物件的工作表,例如 EmbeddedChart 。 |
DATASOURCE | Enum | 內含 DataSource 的工作表。 |
Slicer
方法
SortOrder
屬性
屬性 | 類型 | 說明 |
---|---|---|
ASCENDING | Enum | 遞增排序。 |
DESCENDING | Enum | 遞減排列順序。 |
SortSpec
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getBackgroundColor() | Color | 傳回用於排序的背景顏色;如果沒有,則傳回 null 。 |
getDataSourceColumn() | DataSourceColumn | 取得對排序規格執行動作的資料來源欄。 |
getDimensionIndex() | Integer | 傳回維度索引;如果未連結至本機篩選器,則傳回 null 。 |
getForegroundColor() | Color | 傳回用於排序的前景顏色;如果沒有,則傳回 null 。 |
getSortOrder() | SortOrder | 傳回排列順序。 |
isAscending() | Boolean | 傳回排序順序是否以遞增方式排序。 |
Spreadsheet
方法
SpreadsheetApp
屬性
屬性 | 類型 | 說明 |
---|---|---|
AutoFillSeries | AutoFillSeries | 用於計算自動填入值的序列類型列舉。 |
BandingTheme | BandingTheme | 可能的帶狀主題列舉。 |
BooleanCriteria | BooleanCriteria | 條件式格式設定布林值條件的列舉項目。 |
BorderStyle | BorderStyle | 在 Range 上設定框線的有效樣式列舉。 |
ColorType | ColorType | 可能的顏色類型列舉。 |
CopyPasteType | CopyPasteType | 可能貼上類型的列舉。 |
DataExecutionErrorCode | DataExecutionErrorCode | 可能的資料執行錯誤代碼列舉。 |
DataExecutionState | DataExecutionState | 可能的資料執行狀態列舉。 |
DataSourceParameterType | DataSourceParameterType | 可能的資料來源參數類型列舉。 |
DataSourceRefreshScope | DataSourceRefreshScope | 可能的資料來源重新整理範圍列舉項目。 |
DataSourceType | DataSourceType | 可能的資料來源類型列舉。 |
DataValidationCriteria | DataValidationCriteria | 列舉代表可針對特定範圍設定的資料驗證標準。 |
DateTimeGroupingRuleType | DateTimeGroupingRuleType | 日期時間分組規則列舉。 |
DeveloperMetadataLocationType | DeveloperMetadataLocationType | 可能的開發人員中繼資料位置類型列舉。 |
DeveloperMetadataVisibility | DeveloperMetadataVisibility | 可能的開發人員中繼資料瀏覽權限列舉。 |
Dimension | Dimension | 可列舉試算表的可能尺寸。 |
Direction | Direction | 使用方向鍵在試算表中移動的可能路線列舉。 |
FrequencyType | FrequencyType | 可能的頻率類型列舉。 |
GroupControlTogglePosition | GroupControlTogglePosition | 群組控制項切換鈕所在的位置列舉。 |
InterpolationType | InterpolationType | 條件式格式漸層內插類型的列舉。 |
PivotTableSummarizeFunction | PivotTableSummarizeFunction | 列舉可用來匯總資料透視表值函式的函式。 |
PivotValueDisplayType | PivotValueDisplayType | 列舉資料透視值顯示方式。 |
ProtectionType | ProtectionType | 列舉項目,代表試算表中有哪些部分可編輯保護。 |
RecalculationInterval | RecalculationInterval | 可用於重新計算試算表的可能間隔列舉。 |
RelativeDate | RelativeDate | 列舉相對日期選項,用於計算以日期為依據的 BooleanCriteria 所使用的值。 |
SheetType | SheetType | 列出試算表中不同類型的工作表。 |
SortOrder | SortOrder | 排序順序列舉。 |
TextDirection | TextDirection | 有效文字方向的列舉項目。 |
TextToColumnsDelimiter | TextToColumnsDelimiter | 此屬性列舉用於將文字分隔成不同欄的預設分隔符號。 |
ThemeColorType | ThemeColorType | 可能的主題顏色類型的列舉。 |
ValueType | ValueType | 由 Range.getValue() 和 Range.getValues() 從試算表服務的 Range 類別傳回的值類型列舉。 |
WrapStrategy | WrapStrategy | 列舉用於包裝儲存格的策略。 |
方法
SpreadsheetTheme
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getConcreteColor(themeColorType) | Color | 傳回有效主題顏色類型的具體 Color 。 |
getFontFamily() | String | 傳回主題的字型系列;如果是 null 主題,則傳回 null 。 |
getThemeColors() | ThemeColorType[] | 傳回目前主題的所有可能主題顏色類型清單。 |
setConcreteColor(themeColorType, color) | SpreadsheetTheme | 將此色彩配置中與 ThemeColorType 相關聯的具體顏色設為指定顏色。 |
setConcreteColor(themeColorType, red, green, blue) | SpreadsheetTheme | 將這個色彩配置中與 ThemeColorType 相關聯的具體顏色設為 RGB 格式的指定顏色。 |
setFontFamily(fontFamily) | SpreadsheetTheme | 設定主題的字型系列。 |
TextDirection
屬性
屬性 | 類型 | 說明 |
---|---|---|
LEFT_TO_RIGHT | Enum | 文字方向為從左到右。 |
RIGHT_TO_LEFT | Enum | 文字方向為從右到左。 |
TextFinder
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
findAll() | Range[] | 傳回符合搜尋條件的所有儲存格。 |
findNext() | Range | 傳回符合搜尋條件的下一個儲存格。 |
findPrevious() | Range | 傳回與搜尋條件相符的上一個儲存格。 |
getCurrentMatch() | Range | 傳回目前符合搜尋條件的儲存格。 |
ignoreDiacritics(ignoreDiacritics) | TextFinder | 如果設為 true ,系統會將搜尋設為在比對時忽略變音符號,否則搜尋則會比對變音符號。 |
matchCase(matchCase) | TextFinder | 如果設為 true ,則將搜尋設為完全符合搜尋文字大小寫,否則搜尋會預設為不區分大小寫。 |
matchEntireCell(matchEntireCell) | TextFinder | 如果設為 true ,則將搜尋設為與儲存格的完整內容相符;否則,搜尋會預設為部分比對。 |
matchFormulaText(matchFormulaText) | TextFinder | 如果設為 true ,則將搜尋設為傳回公式文字中出現的相符項目;否則,系統會根據顯示值考慮含有公式的儲存格。 |
replaceAllWith(replaceText) | Integer | 以指定文字取代所有符合項目。 |
replaceWith(replaceText) | Integer | 將目前相符儲存格中的搜尋文字換成指定文字,並傳回取代的次數。 |
startFrom(startRange) | TextFinder | 將搜尋設為在指定儲存格範圍後立即開始搜尋。 |
useRegularExpression(useRegEx) | TextFinder | 如果設為 true ,系統會將搜尋字串設定為規則運算式,否則搜尋會將搜尋字串解讀為一般文字。 |
TextRotation
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getDegrees() | Integer | 取得標準文字方向和目前文字方向之間的角度。 |
isVertical() | Boolean | 如果文字垂直堆疊,則傳回 true ;否則傳回 false 。 |
TextStyle
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
copy() | TextStyleBuilder | 建立以此文字樣式值初始化的文字樣式建構工具。 |
getFontFamily() | String | 取得文字的字型系列。 |
getFontSize() | Integer | 取得點中文字的字型大小。 |
getForegroundColorObject() | Color | 取得文字的字型顏色。 |
isBold() | Boolean | 取得文字是否為粗體。 |
isItalic() | Boolean | 取得儲存格是否為斜體。 |
isStrikethrough() | Boolean | 確認儲存格是否加上刪除線。 |
isUnderline() | Boolean | 取得儲存格是否加上底線。 |
TextStyleBuilder
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
build() | TextStyle | 以這個建構工具建立文字樣式。 |
setBold(bold) | TextStyleBuilder | 設定文字是否為粗體。 |
setFontFamily(fontFamily) | TextStyleBuilder | 設定文字字型系列,例如「感受」。 |
setFontSize(fontSize) | TextStyleBuilder | 設定點的文字字型大小。 |
setForegroundColor(cssString) | TextStyleBuilder | 設定文字字型顏色。 |
setForegroundColorObject(color) | TextStyleBuilder | 設定文字字型顏色。 |
setItalic(italic) | TextStyleBuilder | 設定文字是否為斜體。 |
setStrikethrough(strikethrough) | TextStyleBuilder | 設定文字是否加上刪除線。 |
setUnderline(underline) | TextStyleBuilder | 設定文字是否加上底線。 |
TextToColumnsDelimiter
屬性
屬性 | 類型 | 說明 |
---|---|---|
COMMA | Enum | "," 分隔符號。 |
SEMICOLON | Enum | ";" 分隔符號。 |
PERIOD | Enum | "." 分隔符號。 |
SPACE | Enum | " " 分隔符號。 |
ThemeColor
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getColorType() | ColorType | 取得這個顏色的類型。 |
getThemeColorType() | ThemeColorType | 取得這個顏色的主題顏色類型。 |
ThemeColorType
屬性
屬性 | 類型 | 說明 |
---|---|---|
UNSUPPORTED | Enum | 代表不支援的主題顏色。 |
TEXT | Enum | 代表文字顏色。 |
BACKGROUND | Enum | 代表圖表背景所用的顏色。 |
ACCENT1 | Enum | 代表第一個強調色。 |
ACCENT2 | Enum | 代表第二個強調色。 |
ACCENT3 | Enum | 代表第三個強調色。 |
ACCENT4 | Enum | 代表第四個強調色。 |
ACCENT5 | Enum | 代表第五個強調色。 |
ACCENT6 | Enum | 代表第六個強調色。 |
HYPERLINK | Enum | 代表超連結所使用的顏色。 |
ValueType
屬性
屬性 | 類型 | 說明 |
---|---|---|
IMAGE | Enum | 儲存格含有圖片的值類型。 |
WrapStrategy
屬性
屬性 | 類型 | 說明 |
---|---|---|
WRAP | Enum | 將超過儲存格寬度的線條換行至換行。 |
OVERFLOW | Enum | 到下一個儲存格中加上線條,只要該儲存格是空的即可。 |
CLIP | Enum | 超過儲存格寬度的裁剪線。 |