這項服務可讓指令碼建立、存取及修改 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
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
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
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
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
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
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 | 將資料來源資料透視表傳回為一般的資料透視表物件。 |
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 值初始化的 RTF 值的建構工具。 |
getEndIndex() | Integer | 取得儲存格中這個值的結尾索引。 |
getLinkUrl() | String | 傳回這個值的連結網址。 |
getLinkUrl(startOffset, endOffset) | String | 傳回 startOffset 到 endOffset 的文字連結網址。 |
getRuns() | RichTextValue[] | 傳回分割為執行結果的 RTF 字串,其中每次的執行作業都是可能擁有一致的文字樣式最長的可能子字串。 |
getStartIndex() | Integer | 取得儲存格中這個值的起始索引。 |
getText() | String | 傳回這個值的文字。 |
getTextStyle() | TextStyle | 傳回這個值的文字樣式。 |
getTextStyle(startOffset, endOffset) | TextStyle | 傳回 startOffset 至 endOffset 的文字樣式。 |
RichTextValueBuilder
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
build() | RichTextValue | 使用此建構工具建立 RTF 格式的值。 |
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 | 裁剪長度超過儲存格寬度的線。 |