這項服務可讓指令碼建立、存取及修改 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
方法
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) | PivotValue | 根據指定的資料來源欄新增透視值,且不使用任何摘要函式。 |
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 資料來源的規格。 |
asLooker() | LookerDataSourceSpec | 取得 Looker 資料來源的規格。 |
copy() | DataSourceSpecBuilder | 根據這個資料來源的設定建立 DataSourceSpecBuilder 。 |
getParameters() | DataSourceParameter[] | 取得資料來源的參數。 |
getType() | DataSourceType | 取得資料來源的類型。 |
DataSourceSpecBuilder
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
asBigQuery() | BigQueryDataSourceSpecBuilder | 取得 BigQuery 資料來源的建構工具。 |
asLooker() | LookerDataSourceSpecBuilder | 取得 Looker 資料來源的建構工具。 |
build() | DataSourceSpec | 根據這個建構工具中的設定,建構資料來源規格。 |
copy() | DataSourceSpecBuilder | 根據這個資料來源的設定,建立 DataSourceSpecBuilder 。 |
getParameters() | DataSourceParameter[] | 取得資料來源的參數。 |
getType() | DataSourceType | 取得資料來源的類型。 |
removeAllParameters() | DataSourceSpecBuilder | 移除所有參數。 |
removeParameter(parameterName) | DataSourceSpecBuilder | 移除指定的參數。 |
setParameterFromCell(parameterName, sourceCell) | DataSourceSpecBuilder | 新增參數,或者如果具有名稱的參數存在,則會針對 DataSourceType.BIGQUERY 類型的資料來源規格建構工具更新來源儲存格。 |
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 資料來源。 |
LOOKER | Enum | Looker 資料來源。 |
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 索引。 |
remove() | void | 從試算表中刪除此繪圖。 |
setHeight(height) | Drawing | 以像素為單位,設定此繪圖的實際高度。 |
setOnAction(macroName) | Drawing | 將巨集函式指派給這張圖表。 |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Drawing | 設定繪圖在工作表中顯示的位置。 |
setWidth(width) | Drawing | 以像素為單位,設定此繪圖的實際寬度。 |
setZIndex(zIndex) | Drawing | 設定此繪圖的 Z 索引。 |
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 | 將數量上限推論為漸層條件的特定插補點。 |
LookerDataSourceSpec
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
copy() | DataSourceSpecBuilder | 根據這個資料來源的設定,建立 DataSourceSpecBuilder 。 |
getExploreName() | String | 取得模型中 Looker 探索的名稱。 |
getInstanceUrl() | String | 取得 Looker 執行個體的網址。 |
getModelName() | String | 取得執行個體中的 Looker 模型名稱。 |
getParameters() | DataSourceParameter[] | 取得資料來源的參數。 |
getType() | DataSourceType | 取得資料來源的類型。 |
LookerDataSourceSpecBuilder
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
build() | DataSourceSpec | 根據這個建構工具中的設定,建構資料來源規格。 |
copy() | DataSourceSpecBuilder | 根據這個資料來源的設定建立 DataSourceSpecBuilder 。 |
getExploreName() | String | 取得模型中的 Looker 探索名稱。 |
getInstanceUrl() | String | 取得 Looker 執行個體的網址。 |
getModelName() | String | 取得執行個體中的 Looker 模型名稱。 |
getParameters() | DataSourceParameter[] | 取得資料來源的參數。 |
getType() | DataSourceType | 取得資料來源的類型。 |
removeAllParameters() | LookerDataSourceSpecBuilder | 移除所有參數。 |
removeParameter(parameterName) | LookerDataSourceSpecBuilder | 移除指定的參數。 |
setExploreName(exploreName) | LookerDataSourceSpecBuilder | 在 Looker 模型中設定探索名稱。 |
setInstanceUrl(instanceUrl) | LookerDataSourceSpecBuilder | 設定 Looker 的執行個體網址。 |
setModelName(modelName) | LookerDataSourceSpecBuilder | 在 Looker 執行個體中設定 Looker 模型名稱。 |
setParameterFromCell(parameterName, sourceCell) | LookerDataSourceSpecBuilder | 新增參數,或者如果具有名稱的參數存在,則會針對 DataSourceType.BIGQUERY 類型的資料來源規格建構工具更新來源儲存格。 |
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 | 在資料透視表中,以指定的 formula 根據指定的 name 建立新資料透視表。 |
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 | 設定文字字型系列,例如「myactivity」。 |
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 | 裁剪超出儲存格寬度的行。 |