Spreadsheet Service

試算表

這項服務可讓指令碼建立、存取及修改 Google 試算表檔案。另請參閱在試算表中儲存資料的指南

有時,系統會將試算表作業合併,以提升效能,例如對方法進行多次呼叫時。如要確保所有待處理變更立即生效 (例如在執行指令碼時顯示使用者資訊),請呼叫 SpreadsheetApp.flush()

類別

名稱簡短說明
AutoFillSeries用於計算自動填入值的序列類型列舉。
Banding存取及修改區塊,也就是套用至範圍內資料列或資料欄的顏色模式。
BandingTheme列舉分帶主題。
BigQueryDataSourceSpec存取現有的 BigQuery 資料來源規格。
BigQueryDataSourceSpecBuilderBigQueryDataSourceSpecBuilder 的建構工具。
BooleanCondition存取 ConditionalFormatRules 中的布林值條件。
BooleanCriteria代表布林值條件的列舉,可用於條件式格式或篩選器。
BorderStyle可使用 Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style) 在範圍上設定的樣式。
CellImage代表要新增至儲存格的圖片。
CellImageBuilderCellImage 的建構工具。
Color顏色的表示法。
ColorBuilderColorBuilder 的建構工具。
ConditionalFormatRule存取條件式格式設定規則。
ConditionalFormatRuleBuilder條件式格式規則的建構工具。
ContainerInfo存取圖表在工作表中的位置。
CopyPasteType列舉可能的特殊貼上類型。
DataExecutionErrorCode資料執行錯誤代碼的列舉。
DataExecutionState資料執行狀態的列舉。
DataExecutionStatus資料執行狀態。
DataSource存取及修改現有資料來源。
DataSourceChart存取及修改現有資料來源圖表。
DataSourceColumn存取及修改資料來源欄。
DataSourceFormula存取及修改現有資料來源公式。
DataSourceParameter存取現有資料來源參數。
DataSourceParameterType資料來源參數類型的列舉。
DataSourcePivotTable存取及修改現有的資料來源資料透視表。
DataSourceRefreshSchedule存取及修改現有的重新整理時間表。
DataSourceRefreshScheduleFrequency存取重新整理時間表的頻率,指定重新整理的頻率和時間。
DataSourceRefreshScope重新整理範圍的列舉。
DataSourceSheet存取及修改現有資料來源工作表。
DataSourceSheetFilter存取及修改現有資料來源工作表篩選器。
DataSourceSpec存取現有資料來源規格的一般設定。
DataSourceSpecBuilderDataSourceSpec 的建構工具。
DataSourceTable存取及修改現有資料來源資料表。
DataSourceTableColumn存取及修改 DataSourceTable 中的現有資料欄。
DataSourceTableFilter存取及修改現有資料來源表篩選器。
DataSourceType資料來源類型的列舉。
DataValidation存取資料驗證規則。
DataValidationBuilder資料驗證規則的建構工具。
DataValidationCriteria此列舉代表可在範圍中設定的資料驗證條件。
DateTimeGroupingRule存取現有的日期/時間分組規則。
DateTimeGroupingRuleType日期時間分組規則的類型。
DeveloperMetadata存取及修改開發人員中繼資料。
DeveloperMetadataFinder在試算表中搜尋開發人員中繼資料。
DeveloperMetadataLocation存取開發人員中繼資料位置資訊。
DeveloperMetadataLocationType列舉開發人員中繼資料位置類型。
DeveloperMetadataVisibility列舉開發人員中繼資料瀏覽權限類型。
Dimension列舉試算表中可儲存資料的可能方向。
Direction列舉代表使用方向鍵在試算表內移動時,可能會移動的方向。
Drawing代表在試算表中覆蓋工作表的繪圖。
EmbeddedAreaChartBuilder面積圖的建構工具。
EmbeddedBarChartBuilder長條圖的建構工具。
EmbeddedChart代表已嵌入試算表的圖表。
EmbeddedChartBuilder用於編輯 EmbeddedChart 的建構工具。
EmbeddedColumnChartBuilder柱狀圖的建構工具。
EmbeddedComboChartBuilder組合圖的建構工具。
EmbeddedHistogramChartBuilder直方圖的建構工具。
EmbeddedLineChartBuilder折線圖的建構工具。
EmbeddedPieChartBuilder圓餅圖的建構工具。
EmbeddedScatterChartBuilder散布圖的建構工具。
EmbeddedTableChartBuilder表格圖表的建構工具。
Filter使用這個類別修改 Grid 工作表 (工作表的預設類型) 上的現有篩選器。
FilterCriteria使用這個類別可取得現有篩選條件的相關資訊,或複製篩選條件。
FilterCriteriaBuilder如要為篩選器新增條件,請按照下列步驟操作:
  1. 使用 SpreadsheetApp.newFilterCriteria() 建立條件建構工具。
  2. 使用這個類別的方法,將設定新增至建構工具。
  3. 使用 build() 根據指定的設定組合條件。
FrequencyType頻率類型的列舉。
GradientCondition存取 ConditionalFormatRuleApis 中的漸層 (顏色) 條件。
Group存取及修改試算表群組。
GroupControlTogglePosition此列舉代表群組控制切換鈕可能有的位址。
InterpolationType此列舉代表內插選項,用於計算 ConditionalFormatRuleGradientCondition 要使用的值。
LookerDataSourceSpecDataSourceSpec:用於存取現有 Looker 資料來源規格。
LookerDataSourceSpecBuilderLookerDataSourceSpecBuilder 的建構工具。
NamedRange在試算表中建立、存取及修改已命名範圍。
OverGridImage代表試算表格線上的圖片。
PageProtection在舊版 Google 試算表中存取及修改受保護的工作表。
PivotFilter存取及修改資料透視表篩選器。
PivotGroup存取及修改資料透視表細分群組。
PivotGroupLimit存取及修改資料透視表群組限制。
PivotTable存取及修改資料透視表。
PivotTableSummarizeFunction列舉匯總資料透視表資料的函式。
PivotValue存取及修改資料透視表中的值群組。
PivotValueDisplayType列舉顯示樞紐值做為另一個值的函式的方式。
Protection存取及修改受保護的區間和工作表。
ProtectionType此列舉代表可防止編輯的試算表部分。
Range存取及修改試算表區間。
RangeList同一個工作表中一或多個 Range 例項的集合。
RecalculationInterval列舉代表試算表重新計算時可能使用的間隔。
RelativeDate列舉代表相對日期選項,用於計算要在以日期為基礎的 BooleanCriteria 中使用的值。
RichTextValue用於表示儲存格文字的特殊文字字串。
RichTextValueBuilderRTF 值的建構工具。
Selection存取目前在有效工作表中有效的選取範圍。
Sheet存取及修改試算表工作表。
SheetType試算表中可存在的不同工作表類型。
Slicer代表篩選器,用於以非協作方式篩選範圍、圖表和資料透視表。
SortOrder代表排序順序的列舉。
SortSpec排序規格。
Spreadsheet存取及修改 Google 試算表檔案。
SpreadsheetApp存取及建立 Google 試算表檔案。
SpreadsheetTheme存取及修改現有主題。
TextDirection文字路線的列舉。
TextFinder在指定範圍、工作表或試算表中搜尋或取代文字。
TextRotation存取資料欄的文字旋轉設定。
TextStyle儲存格中文字的算繪樣式。
TextStyleBuilder文字樣式的建構工具。
TextToColumnsDelimiter列舉可將文字資料欄分割為多個資料欄的預設分隔符類型。
ThemeColor主題顏色的表示法。
ThemeColorType這個列舉會說明主題支援的各種顏色項目。
ValueTypeRange.getValue()Range.getValues() 從試算表服務的 Range 類別傳回的值類型列舉。
WrapStrategy用於處理儲存格文字斷行的策略列舉。

AutoFillSeries

屬性

屬性類型說明
DEFAULT_SERIESEnum預設值。
ALTERNATE_SERIESEnum使用這項設定進行自動填入時,系統會將現有值的副本填入展開範圍中的空白儲存格。

Banding

方法

方法傳回類型簡短說明
copyTo(range)Banding將這個頻帶複製到其他範圍。
getFirstColumnColorObject()Color傳回條紋中第一個交替欄的顏色,如果未設定顏色,則傳回 null
getFirstRowColorObject()Color傳回第一個交替列顏色,如果未設定顏色,則傳回 null
getFooterColumnColorObject()Color傳回分帶中最後一列的顏色,如果未設定顏色,則傳回 null
getFooterRowColorObject()Color傳回分割區中最後一列的顏色,如果未設定顏色,則傳回 null
getHeaderColumnColorObject()Color傳回分帶中第一個欄的顏色,如果未設定顏色,則傳回 null
getHeaderRowColorObject()Color傳回標題列的顏色,如果未設定顏色,則傳回 null
getRange()Range傳回此頻帶的範圍。
getSecondColumnColorObject()Color傳回頻帶中的第二個交替欄顏色,如果未設定顏色,則傳回 null
getSecondRowColorObject()Color傳回第二個交替列顏色,如果未設定顏色,則傳回 null
remove()void移除這條紋。
setFirstColumnColor(color)Banding設定第一個交替的欄顏色。
setFirstColumnColorObject(color)Banding設定頻帶中第一個交替的欄顏色。
setFirstRowColor(color)Banding設定交替的第一列顏色。
setFirstRowColorObject(color)Banding設定條紋中第一個交替列的顏色。
setFooterColumnColor(color)Banding設定最後一欄的顏色。
setFooterColumnColorObject(color)Banding設定分帶中最後一欄的顏色。
setFooterRowColor(color)Banding設定最後一列的顏色。
setFooterRowColorObject(color)Banding設定分頁中頁尾資料列的顏色。
setHeaderColumnColor(color)Banding設定標題欄的顏色。
setHeaderColumnColorObject(color)Banding設定標題欄的顏色。
setHeaderRowColor(color)Banding設定標題列的顏色。
setHeaderRowColorObject(color)Banding設定標題列的顏色。
setRange(range)Banding設定此頻帶的範圍。
setSecondColumnColor(color)Banding設定交錯的第二欄顏色。
setSecondColumnColorObject(color)Banding設定頻帶中的第二個交替欄顏色。
setSecondRowColor(color)Banding設定交錯的第二列顏色。
setSecondRowColorObject(color)Banding設定頻帶中的第二個交替顏色。

BandingTheme

屬性

屬性類型說明
LIGHT_GREYEnum淺灰色帶狀主題。
CYANEnum青色帶狀主題。
GREENEnum綠色帶狀主題。
YELLOWEnum黃色條紋主題。
ORANGEEnum橘色帶狀主題。
BLUEEnum藍色帶狀主題。
TEALEnum藍綠色帶狀主題。
GREYEnum灰色帶狀主題。
BROWNEnum棕色條紋主題。
LIGHT_GREENEnum淺綠色帶狀主題。
INDIGOEnum靛藍色帶狀主題。
PINKEnum粉紅色帶狀主題。

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新增參數,或如果有同名參數,則更新資料來源規格建構工具 (類型為 DataSourceType.BIGQUERY) 的來源儲存格。
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_EMPTYEnum儲存格為空白時,就符合條件。
CELL_NOT_EMPTYEnum儲存格不為空白時,就符合條件。
DATE_AFTEREnum當日期晚於指定值時,就符合條件。
DATE_BEFOREEnum當日期早於指定值時,就符合條件。
DATE_EQUAL_TOEnum當日期等於指定值時,就符合條件。
DATE_NOT_EQUAL_TOEnum當日期不等於指定值時,就符合條件。
DATE_AFTER_RELATIVEEnum當日期晚於相對日期值時,就符合條件。
DATE_BEFORE_RELATIVEEnum當日期早於相對日期值時,就符合此條件。
DATE_EQUAL_TO_RELATIVEEnum當日期等於相對日期值時,就符合條件。
NUMBER_BETWEENEnum當數字介於指定值之間時,就符合條件。
NUMBER_EQUAL_TOEnum當數字等於指定值時,就符合條件。
NUMBER_GREATER_THANEnum當數字大於指定值時,就符合條件。
NUMBER_GREATER_THAN_OR_EQUAL_TOEnum當數字大於或等於指定值時,就符合條件。
NUMBER_LESS_THANEnum當數字小於指定值時,就符合條件。
NUMBER_LESS_THAN_OR_EQUAL_TOEnum當數字小於或等於指定值時,就會符合條件。
NUMBER_NOT_BETWEENEnum如果數字不在指定值之間,就符合條件。
NUMBER_NOT_EQUAL_TOEnum當數字不等於指定值時,就符合條件。
TEXT_CONTAINSEnum如果輸入內容包含指定值,就符合條件。
TEXT_DOES_NOT_CONTAINEnum如果輸入內容不含指定值,就會符合條件。
TEXT_EQUAL_TOEnum當輸入值等於指定值時,就符合條件。
TEXT_NOT_EQUAL_TOEnum如果輸入值不等於指定值,就會符合條件。
TEXT_STARTS_WITHEnum輸入內容開頭為指定值時,就符合條件。
TEXT_ENDS_WITHEnum只要輸入內容結尾為指定值,就符合條件。
CUSTOM_FORMULAEnum如果輸入內容會導致指定公式評估為 true,就符合條件。

BorderStyle

屬性

屬性類型說明
DOTTEDEnum虛線邊框。
DASHEDEnum虛線邊框。
SOLIDEnum較細的實線邊框。
SOLID_MEDIUMEnum中型實線邊框。
SOLID_THICKEnum粗實線邊框。
DOUBLEEnum兩個實線邊框。

CellImage

屬性

屬性類型說明
valueTypeValueType欄位設為 ValueType.IMAGE,代表圖片值類型。

方法

方法傳回類型簡短說明
getAltTextDescription()String傳回此圖片的替代文字說明。
getAltTextTitle()String傳回圖片的替代文字標題。
getContentUrl()String傳回 Google 代管的圖片網址。
getUrl()String取得圖片的來源網址;如果網址無法使用,則會傳回 null
toBuilder()CellImageBuilder建立建構工具,將圖片轉換為圖片值類型,以便將圖片放入單元格。

CellImageBuilder

屬性

屬性類型說明
valueTypeValueType欄位設為 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

方法

方法傳回類型簡短說明
build()ConditionalFormatRule根據套用至建構工具的設定,建構條件式格式規則。
copy()ConditionalFormatRuleBuilder傳回含有此規則設定的規則建構工具預設值。
getBooleanCondition()BooleanCondition如果這項規則使用布林值條件條件,則會擷取規則的 BooleanCondition 資訊。
getGradientCondition()GradientCondition如果此規則使用漸層條件條件,則會擷取規則的 GradientCondition 資訊。
getRanges()Range[]擷取要套用此條件式格式規則的範圍。
setBackground(color)ConditionalFormatRuleBuilder設定條件式格式規則的格式背景顏色。
setBackgroundObject(color)ConditionalFormatRuleBuilder設定條件式格式規則的格式背景顏色。
setBold(bold)ConditionalFormatRuleBuilder為條件式格式規則的格式設定文字粗體。
setFontColor(color)ConditionalFormatRuleBuilder設定條件式格式規則的格式字型顏色。
setFontColorObject(color)ConditionalFormatRuleBuilder設定條件式格式規則的格式字型顏色。
setGradientMaxpoint(color)ConditionalFormatRuleBuilder清除條件式格式規則的漸層 maxpoint 值,改為使用規則範圍中的最大值。
setGradientMaxpointObject(color)ConditionalFormatRuleBuilder清除條件式格式規則的漸層 maxpoint 值,改為使用規則範圍中的最大值。
setGradientMaxpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層 maxpoint 欄位。
setGradientMaxpointWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層最大點欄位。
setGradientMidpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層中點欄位。
setGradientMidpointWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層中點欄位。
setGradientMinpoint(color)ConditionalFormatRuleBuilder清除條件式格式規則的漸層 minpoint 值,改為使用規則範圍中的最小值。
setGradientMinpointObject(color)ConditionalFormatRuleBuilder清除條件式格式規則的漸層 minpoint 值,改為使用規則範圍中的最小值。
setGradientMinpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層 minpoint 欄位。
setGradientMinpointWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層 minpoint 欄位。
setItalic(italic)ConditionalFormatRuleBuilder為條件式格式規則設定斜體文字格式。
setRanges(ranges)ConditionalFormatRuleBuilder設定要套用此條件式格式規則的一或多個範圍。
setStrikethrough(strikethrough)ConditionalFormatRuleBuilder設定條件式格式規則的格式為文字刪除線。
setUnderline(underline)ConditionalFormatRuleBuilder設定條件式格式規則的文字底線格式。
whenCellEmpty()ConditionalFormatRuleBuilder設定條件式格式規則,在儲存格為空白時觸發。
whenCellNotEmpty()ConditionalFormatRuleBuilder設定條件式格式規則,在儲存格非空白時觸發。
whenDateAfter(date)ConditionalFormatRuleBuilder設定條件式格式規則,在日期大於指定值時觸發。
whenDateAfter(date)ConditionalFormatRuleBuilder設定條件式格式規則,在日期大於指定相對日期時觸發。
whenDateBefore(date)ConditionalFormatRuleBuilder設定條件式格式規則,在日期早於指定日期時觸發。
whenDateBefore(date)ConditionalFormatRuleBuilder設定條件式格式規則,在日期早於指定相對日期時觸發。
whenDateEqualTo(date)ConditionalFormatRuleBuilder設定條件式格式規則,在日期等於指定日期時觸發。
whenDateEqualTo(date)ConditionalFormatRuleBuilder設定條件式格式規則,在日期等於指定相對日期時觸發。
whenFormulaSatisfied(formula)ConditionalFormatRuleBuilder設定條件式格式規則,在指定公式評估為 true 時觸發。
whenNumberBetween(start, end)ConditionalFormatRuleBuilder設定條件式格式規則,當數字介於兩個指定值之間,或為其中一個值時觸發。
whenNumberEqualTo(number)ConditionalFormatRuleBuilder設定條件式格式規則,在數字等於指定值時觸發。
whenNumberGreaterThan(number)ConditionalFormatRuleBuilder設定條件式格式規則,在數字大於指定值時觸發。
whenNumberGreaterThanOrEqualTo(number)ConditionalFormatRuleBuilder設定條件式格式規則,在數字大於或等於指定值時觸發。
whenNumberLessThan(number)ConditionalFormatRuleBuilder設定條件式格式規則,在數字小於指定值時觸發。
whenNumberLessThanOrEqualTo(number)ConditionalFormatRuleBuilder設定條件式格式規則,在數字小於或等於指定值時觸發。
whenNumberNotBetween(start, end)ConditionalFormatRuleBuilder設定條件式格式規則,在數字不在兩個指定值之間,且不等於兩個指定值時觸發。
whenNumberNotEqualTo(number)ConditionalFormatRuleBuilder設定條件式格式規則,在數字不等於指定值時觸發。
whenTextContains(text)ConditionalFormatRuleBuilder設定條件式格式規則,在輸入內容包含指定值時觸發。
whenTextDoesNotContain(text)ConditionalFormatRuleBuilder設定條件式格式規則,在輸入內容不含指定值時觸發。
whenTextEndsWith(text)ConditionalFormatRuleBuilder設定條件式格式規則,在輸入內容結尾為指定值時觸發。
whenTextEqualTo(text)ConditionalFormatRuleBuilder設定條件式格式規則,在輸入值等於指定值時觸發。
whenTextStartsWith(text)ConditionalFormatRuleBuilder設定條件式格式規則,在輸入內容開頭為指定值時觸發。
withCriteria(criteria, args)ConditionalFormatRuleBuilder將條件式格式規則設為由 BooleanCriteria 值定義的條件,通常是從現有規則的 criteriaarguments 取得。

ContainerInfo

方法

方法傳回類型簡短說明
getAnchorColumn()Integer圖表的左側會固定在這個欄中。
getAnchorRow()Integer圖表的頂端會固定在這個資料列。
getOffsetX()Integer圖表的左上角會從錨定欄偏移這麼多像素。
getOffsetY()Integer圖表的左上角會從錨定資料列偏移這麼多像素。

CopyPasteType

屬性

屬性類型說明
PASTE_NORMALEnum貼上值、公式、格式和合併。
PASTE_NO_BORDERSEnum貼上值、公式、格式和合併資料,但不含邊框。
PASTE_FORMATEnum請只貼上格式。
PASTE_FORMULAEnum請只貼上公式。
PASTE_DATA_VALIDATIONEnum請只貼上資料驗證規則。
PASTE_VALUESEnum請只貼上值,不含格式、公式或合併。
PASTE_CONDITIONAL_FORMATTINGEnum請只貼上顏色規則。
PASTE_COLUMN_WIDTHSEnum請僅貼上欄寬。

DataExecutionErrorCode

屬性

屬性類型說明
DATA_EXECUTION_ERROR_CODE_UNSUPPORTEDEnumApps Script 不支援的資料執行錯誤代碼。
NONEEnum資料執行作業沒有錯誤。
TIME_OUTEnum資料執行作業逾時。
TOO_MANY_ROWSEnum資料執行結果傳回的列數超出上限。
TOO_MANY_COLUMNSEnum資料執行結果傳回的欄數超過限制。
TOO_MANY_CELLSEnum資料執行結果傳回的儲存格數量超出上限。
ENGINEEnum資料執行引擎錯誤。
PARAMETER_INVALIDEnum資料執行參數無效。
UNSUPPORTED_DATA_TYPEEnum資料執行作業傳回不支援的資料類型。
DUPLICATE_COLUMN_NAMESEnum資料執行結果傳回重複的欄名。
INTERRUPTEDEnum資料執行作業會中斷。
OTHEREnum其他錯誤。
TOO_MANY_CHARS_PER_CELLEnum資料執行作業傳回的值超過單一儲存格允許的字元上限。
DATA_NOT_FOUNDEnum找不到資料來源所參照的資料庫。
PERMISSION_DENIEDEnum使用者無法存取資料來源參照的資料庫。

DataExecutionState

屬性

屬性類型說明
DATA_EXECUTION_STATE_UNSUPPORTEDEnumApps Script 不支援資料執行狀態。
RUNNINGEnum資料執行作業已開始並正在執行。
SUCCESSEnum資料執行作業已完成並順利完成。
ERROREnum資料執行作業已完成,但發生錯誤。
NOT_STARTEDEnum資料執行作業尚未開始。

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_UNSUPPORTEDEnumApps Script 不支援的資料來源參數類型。
CELLEnum資料來源參數的值會根據儲存格計算。

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_UNSUPPORTEDEnum不支援資料來源重新整理範圍。
ALL_DATA_SOURCESEnum重新整理作業會套用至試算表中的所有資料來源。

DataSourceSheet

方法

方法傳回類型簡短說明
addFilter(columnName, filterCriteria)DataSourceSheet新增套用至資料來源工作表的篩選器。
asSheet()Sheet將資料來源工作表傳回為一般工作表物件。
autoResizeColumn(columnName)DataSourceSheet自動調整指定欄的寬度。
autoResizeColumns(columnNames)DataSourceSheet自動調整指定欄的寬度。
cancelDataRefresh()DataSourceSheet如果此物件目前正在執行,則取消與該物件相關聯的資料重新整理作業。
forceRefreshData()DataSourceSheet無論目前狀態為何,都會重新整理此物件的資料。
getColumnWidth(columnName)Integer傳回指定資料欄的寬度。
getDataSource()DataSource取得物件連結的資料來源。
getFilters()DataSourceSheetFilter[]傳回套用至資料來源工作表的所有篩選器。
getSheetValues(columnName)Object[]傳回指定資料欄名稱的資料來源工作表所有值。
getSheetValues(columnName, startRow, numRows)Object[]傳回指定資料欄名稱的資料來源工作表所有值,從提供的起始資料列 (以 1 為基準) 到提供的 numRows
getSortSpecs()SortSpec[]取得資料來源工作表中的所有排序規格。
getStatus()DataExecutionStatus取得物件的資料執行狀態。
refreshData()DataSourceSheet重新整理物件的資料。
removeFilters(columnName)DataSourceSheet移除套用至資料來源工作表資料欄的所有篩選器。
removeSortSpec(columnName)DataSourceSheet移除資料來源工作表中資料欄的排序規格。
setColumnWidth(columnName, width)DataSourceSheet設定指定資料欄的寬度。
setColumnWidths(columnNames, width)DataSourceSheet設定指定資料欄的寬度。
setSortSpec(columnName, ascending)DataSourceSheet設定資料來源工作表中資料欄的排序規格。
setSortSpec(columnName, sortOrder)DataSourceSheet設定資料來源工作表中資料欄的排序規格。
waitForCompletion(timeoutInSeconds)DataExecutionStatus等待目前執行作業完成,並在指定秒數後逾時。

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

方法

方法傳回類型簡短說明
addColumns(columnNames)DataSourceTable在資料來源表格中新增欄。
addFilter(columnName, filterCriteria)DataSourceTable新增套用至資料來源資料表的篩選器。
addSortSpec(columnName, ascending)DataSourceTable在資料來源表格中的資料欄上新增排序規格。
addSortSpec(columnName, sortOrder)DataSourceTable在資料來源表格中新增資料欄的排序規格。
cancelDataRefresh()DataSourceTable如果目前正在執行,則會取消與此物件相關聯的資料重新整理作業。
forceRefreshData()DataSourceTable無論目前狀態為何,都會重新整理此物件的資料。
getColumns()DataSourceTableColumn[]取得新增至資料來源表格的所有資料來源欄。
getDataSource()DataSource取得物件連結的資料來源。
getFilters()DataSourceTableFilter[]傳回套用至資料來源資料表的所有篩選器。
getRange()Range取得這個資料來源表格跨越的 Range
getRowLimit()Integer傳回資料來源表的列數上限。
getSortSpecs()SortSpec[]取得資料來源資料表中的所有排序規格。
getStatus()DataExecutionStatus取得物件的資料執行狀態。
isSyncingAllColumns()Boolean傳回資料來源表是否同步處理關聯資料來源中的所有欄。
refreshData()DataSourceTable重新整理物件的資料。
removeAllColumns()DataSourceTable移除資料來源資料表中的所有欄。
removeAllSortSpecs()DataSourceTable移除資料來源資料表中的所有排序規格。
setRowLimit(rowLimit)DataSourceTable更新資料來源表的列數上限。
syncAllColumns()DataSourceTable將關聯資料來源中的所有現有和日後的資料欄同步至資料來源資料表。
waitForCompletion(timeoutInSeconds)DataExecutionStatus等待目前執行作業完成,並在指定秒數後逾時。

DataSourceTableColumn

方法

方法傳回類型簡短說明
getDataSourceColumn()DataSourceColumn取得資料來源欄。
remove()voidDataSourceTable 移除資料欄。

DataSourceTableFilter

方法

方法傳回類型簡短說明
getDataSourceColumn()DataSourceColumn傳回這個篩選器適用的資料來源欄。
getDataSourceTable()DataSourceTable傳回此篩選器所屬的 DataSourceTable
getFilterCriteria()FilterCriteria傳回此篩選器的篩選條件。
remove()void從資料來源物件中移除這個篩選器。
setFilterCriteria(filterCriteria)DataSourceTableFilter設定這個篩選器的篩選條件。

DataSourceType

屬性

屬性類型說明
DATA_SOURCE_TYPE_UNSUPPORTEDEnumApps Script 不支援的資料來源類型。
BIGQUERYEnumBigQuery 資料來源。
LOOKEREnumLooker 資料來源。

DataValidation

方法

方法傳回類型簡短說明
copy()DataValidationBuilder根據資料驗證規則的設定,建立資料驗證規則的建構工具。
getAllowInvalid()Boolean如果規則在輸入資料驗證失敗時顯示警告,則會傳回 true;如果完全拒絕輸入資料,則會傳回 false
getCriteriaType()DataValidationCriteria取得 DataValidationCriteria 列舉中定義的規則條件類型。
getCriteriaValues()Object[]取得規則條件的引數陣列。
getHelpText()String取得規則的說明文字,如果未設定說明文字,則會傳回 null

DataValidationBuilder

方法

方法傳回類型簡短說明
build()DataValidation根據套用至建構工具的設定,建構資料驗證規則。
copy()DataValidationBuilder根據資料驗證規則的設定,建立資料驗證規則的建構工具。
getAllowInvalid()Boolean如果規則在輸入資料驗證失敗時顯示警告,則會傳回 true;如果完全拒絕輸入資料,則會傳回 false
getCriteriaType()DataValidationCriteria取得 DataValidationCriteria 列舉中定義的規則條件類型。
getCriteriaValues()Object[]取得規則條件的引數陣列。
getHelpText()String取得規則的說明文字,如果未設定說明文字,則會傳回 null
requireCheckbox()DataValidationBuilder將資料驗證規則設為要求輸入值為布林值;這個值會以核取方塊呈現。
requireCheckbox(checkedValue)DataValidationBuilder將資料驗證規則設為要求輸入值為指定值或空白。
requireCheckbox(checkedValue, uncheckedValue)DataValidationBuilder設定資料驗證規則,要求輸入值為指定的值之一。
requireDate()DataValidationBuilder將資料驗證規則設為要求輸入日期。
requireDateAfter(date)DataValidationBuilder將資料驗證規則設為要求日期必須晚於指定值。
requireDateBefore(date)DataValidationBuilder將資料驗證規則設為要求日期必須早於指定值。
requireDateBetween(start, end)DataValidationBuilder設定資料驗證規則,要求日期必須介於兩個指定日期之間,或為其中一個日期。
requireDateEqualTo(date)DataValidationBuilder設定資料驗證規則,要求日期必須等於指定的值。
requireDateNotBetween(start, end)DataValidationBuilder將資料驗證規則設為要求日期不落在兩個指定日期之間,且不等於兩個日期。
requireDateOnOrAfter(date)DataValidationBuilder設定資料驗證規則,要求日期必須在指定值的當天或之後。
requireDateOnOrBefore(date)DataValidationBuilder設定資料驗證規則,要求日期必須在指定值之前或當天。
requireFormulaSatisfied(formula)DataValidationBuilder將資料驗證規則設為要求指定公式的評估結果為 true
requireNumberBetween(start, end)DataValidationBuilder將資料驗證規則設為要求數字介於兩個指定數字之間,或為兩個指定數字之一。
requireNumberEqualTo(number)DataValidationBuilder將資料驗證規則設為要求數字等於指定值。
requireNumberGreaterThan(number)DataValidationBuilder將資料驗證規則設為要求數字大於指定值。
requireNumberGreaterThanOrEqualTo(number)DataValidationBuilder將資料驗證規則設為要求數字大於或等於指定值。
requireNumberLessThan(number)DataValidationBuilder將資料驗證規則設為要求數字小於指定值。
requireNumberLessThanOrEqualTo(number)DataValidationBuilder將資料驗證規則設為要求數字小於或等於指定值。
requireNumberNotBetween(start, end)DataValidationBuilder設定資料驗證規則,要求數字不得介於兩個指定數字之間,且不得為兩個指定數字。
requireNumberNotEqualTo(number)DataValidationBuilder將資料驗證規則設為要求數字不等於指定值。
requireTextContains(text)DataValidationBuilder設定資料驗證規則,要求輸入內容包含指定的值。
requireTextDoesNotContain(text)DataValidationBuilder設定資料驗證規則,要求輸入內容不得包含指定值。
requireTextEqualTo(text)DataValidationBuilder將資料驗證規則設為要求輸入值與指定值相等。
requireTextIsEmail()DataValidationBuilder設定資料驗證規則,要求輸入內容必須是電子郵件地址的格式。
requireTextIsUrl()DataValidationBuilder設定資料驗證規則,要求輸入內容必須是網址的形式。
requireValueInList(values)DataValidationBuilder設定資料驗證規則,要求輸入值必須等於指定值之一。
requireValueInList(values, showDropdown)DataValidationBuilder設定資料驗證規則,要求輸入值必須等於指定的其中一個值,並提供隱藏下拉式選單的選項。
requireValueInRange(range)DataValidationBuilder設定資料驗證規則,要求輸入值必須等於指定範圍內的值。
requireValueInRange(range, showDropdown)DataValidationBuilder設定資料驗證規則,要求輸入值必須等於指定範圍內的值,並提供隱藏下拉式選單的選項。
setAllowInvalid(allowInvalidData)DataValidationBuilder設定在輸入資料驗證失敗時,是否要顯示警告,或是否要完全拒絕輸入內容。
setHelpText(helpText)DataValidationBuilder設定使用者將滑鼠游標懸停在已設定資料驗證的儲存格上時,所顯示的說明文字。
withCriteria(criteria, args)DataValidationBuilder將資料驗證規則設為由 DataValidationCriteria 值定義的條件,通常是從現有規則的 criteriaarguments 取得。

DataValidationCriteria

屬性

屬性類型說明
DATE_AFTEREnum必須是指定值之後的日期。
DATE_BEFOREEnum必須輸入比指定值早的日期。
DATE_BETWEENEnum必須是介於指定值之間的日期。
DATE_EQUAL_TOEnum需要與指定值相同的日期。
DATE_IS_VALID_DATEEnum必須指定日期。
DATE_NOT_BETWEENEnum必須輸入不在指定值範圍內的日期。
DATE_ON_OR_AFTEREnum要求日期必須等於或晚於指定值。
DATE_ON_OR_BEFOREEnum必須輸入不晚於指定值的日期。
NUMBER_BETWEENEnum必須是介於指定值之間的數字。
NUMBER_EQUAL_TOEnum必須是與指定值相同的數字。
NUMBER_GREATER_THANEnum要求輸入的數字大於指定值。
NUMBER_GREATER_THAN_OR_EQUAL_TOEnum必須是大於或等於指定值的數字。
NUMBER_LESS_THANEnum請輸入小於指定值的數字。
NUMBER_LESS_THAN_OR_EQUAL_TOEnum必須是小於或等於指定值的數字。
NUMBER_NOT_BETWEENEnum請輸入介於指定值之間的數字。
NUMBER_NOT_EQUAL_TOEnum要求的數字不得等於指定值。
TEXT_CONTAINSEnum要求輸入內容包含指定的值。
TEXT_DOES_NOT_CONTAINEnum要求輸入內容不得包含指定值。
TEXT_EQUAL_TOEnum要求輸入值等於指定值。
TEXT_IS_VALID_EMAILEnum要求輸入內容必須是電子郵件地址的形式。
TEXT_IS_VALID_URLEnum要求輸入內容必須是網址格式。
VALUE_IN_LISTEnum要求輸入值等於指定值之一。
VALUE_IN_RANGEEnum要求輸入值必須等於指定範圍內的值。
CUSTOM_FORMULAEnum要求輸入內容可讓指定公式評估為 true
CHECKBOXEnum輸入值必須是自訂值或布林值,並以核取方塊呈現。

DateTimeGroupingRule

方法

方法傳回類型簡短說明
getRuleType()DateTimeGroupingRuleType取得日期時間分組規則的類型。

DateTimeGroupingRuleType

屬性

屬性類型說明
UNSUPPORTEDEnum系統不支援的日期時間分組規則類型。
SECONDEnum將日期時間依秒分組,從 0 到 59。
MINUTEEnum將日期時間分組為 0 到 59 之間的分鐘。
HOUREnum使用 24 小時制 (從 0 到 23) 將日期時間分組。
HOUR_MINUTEEnum使用 24 小時制系統,將日期時間依小時和分鐘分組,例如 19:45
HOUR_MINUTE_AMPMEnum使用 12 小時制系統,將日期時間分組為小時和分鐘,例如 7:45 PM
DAY_OF_WEEKEnum依星期幾將日期/時間分組,例如 Sunday
DAY_OF_YEAREnum依年內日期分組,從 1 到 366。
DAY_OF_MONTHEnum依月內第幾天 (1 到 31) 分組日期時間。
DAY_MONTHEnum依照日期和月份分組日期時間,例如 22-Nov
MONTHEnum依月份分組日期/時間,例如 Nov
QUARTEREnum將日期時間分組為季度,例如 Q1 (代表 1 月至 3 月)。
YEAREnum依年份分組日期時間,例如 2008 年。
YEAR_MONTHEnum依年和月分組日期時間,例如 2008-Nov
YEAR_QUARTEREnum將日期時間分組為年和季度,例如 2008 Q4
YEAR_MONTH_DAYEnum依年、月和日分組日期時間,例如 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

屬性

屬性類型說明
SPREADSHEETEnum與頂層試算表相關聯的開發人員中繼資料位置類型。
SHEETEnum與整個工作表相關聯的開發人員中繼資料位置類型。
ROWEnum與資料列相關聯的開發人員中繼資料位置類型。
COLUMNEnum與資料欄相關聯的開發人員中繼資料位置類型。

DeveloperMetadataVisibility

屬性

屬性類型說明
DOCUMENTEnum只要是可存取文件的開發人員專案,就能存取文件可見的中繼資料。
PROJECTEnum專案可見中繼資料只會向建立中繼資料的開發人員專案顯示,並由該專案存取。

Dimension

屬性

屬性類型說明
COLUMNSEnum資料欄 (垂直) 維度。
ROWSEnum列 (水平) 維度。

Direction

屬性

屬性類型說明
UPEnum列索引遞減的方向。
DOWNEnum列索引增加的方向。
PREVIOUSEnum資料欄索引遞減的方向。
NEXTEnum資料欄索引增加的方向。

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

方法

方法傳回類型簡短說明
addRange(range)EmbeddedChartBuilder在這個建構工具修改的圖表中新增範圍。
asAreaChart()EmbeddedAreaChartBuilder將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder
asBarChart()EmbeddedBarChartBuilder將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder將圖表類型設為 ColumnChart,並傳回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder將圖表類型設為 HistogramChart,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為 LineChart,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為 ScatterChart,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建立圖表,反映所有對圖表所做的變更。
clearRanges()EmbeddedChartBuilder從這個建構工具修改的圖表中移除所有區間。
getChartType()ChartType傳回目前的圖表類型。
getContainer()ContainerInfo傳回圖表 ContainerInfo,該圖表會封裝圖表在工作表中顯示的位置。
getRanges()Range[]傳回目前為此圖表提供資料的範圍清單副本。
removeRange(range)EmbeddedChartBuilder從這個建構工具修改的圖表中移除指定範圍。
reverseCategories()EmbeddedAreaChartBuilder反轉在網域軸上繪製序列的方向。
setBackgroundColor(cssValue)EmbeddedAreaChartBuilder設定圖表的背景顏色。
setChartType(type)EmbeddedChartBuilder變更圖表類型。
setColors(cssValues)EmbeddedAreaChartBuilder設定圖表中折線的顏色。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder設定要用於隱藏資料列和資料欄的策略。
setLegendPosition(position)EmbeddedAreaChartBuilder設定圖例相對於圖表的位置。
setLegendTextStyle(textStyle)EmbeddedAreaChartBuilder設定圖表圖例的文字樣式。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder設定在有多個範圍時要使用的合併策略。
setNumHeaders(headers)EmbeddedChartBuilder設定要視為標頭的範圍列數或欄數。
setOption(option, value)EmbeddedChartBuilder設定這張圖表的進階選項。
setPointStyle(style)EmbeddedAreaChartBuilder設定線條中點的樣式。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder設定位置,變更圖表在工作表中顯示的位置。
setRange(start, end)EmbeddedAreaChartBuilder設定圖表的範圍。
setStacked()EmbeddedAreaChartBuilder使用堆疊線條,也就是說,線條和長條圖的值會堆疊 (累加)。
setTitle(chartTitle)EmbeddedAreaChartBuilder設定圖表的標題。
setTitleTextStyle(textStyle)EmbeddedAreaChartBuilder設定圖表標題的文字樣式。
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilder設定是否要將圖表的資料列和資料欄互換。
setXAxisTextStyle(textStyle)EmbeddedAreaChartBuilder設定橫軸的文字樣式。
setXAxisTitle(title)EmbeddedAreaChartBuilder在水平軸上新增標題。
setXAxisTitleTextStyle(textStyle)EmbeddedAreaChartBuilder設定水平軸標題的文字樣式。
setYAxisTextStyle(textStyle)EmbeddedAreaChartBuilder設定垂直軸文字樣式。
setYAxisTitle(title)EmbeddedAreaChartBuilder為垂直軸新增標題。
setYAxisTitleTextStyle(textStyle)EmbeddedAreaChartBuilder設定垂直軸標題的文字樣式。
useLogScale()EmbeddedAreaChartBuilder將範圍軸設為對數刻度 (所有值都必須為正值)。

EmbeddedBarChartBuilder

方法

方法傳回類型簡短說明
addRange(range)EmbeddedChartBuilder在這個建構工具修改的圖表中新增範圍。
asAreaChart()EmbeddedAreaChartBuilder將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder
asBarChart()EmbeddedBarChartBuilder將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder將圖表類型設為 ColumnChart,並傳回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder將圖表類型設為 HistogramChart,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為 LineChart,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為 ScatterChart,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建立圖表,反映所有對圖表所做的變更。
clearRanges()EmbeddedChartBuilder從這個建構工具修改的圖表中移除所有區間。
getChartType()ChartType傳回目前的圖表類型。
getContainer()ContainerInfo傳回圖表 ContainerInfo,該圖表會封裝圖表在工作表中顯示的位置。
getRanges()Range[]傳回目前為此圖表提供資料的範圍清單副本。
removeRange(range)EmbeddedChartBuilder從這個建構工具修改的圖表中移除指定範圍。
reverseCategories()EmbeddedBarChartBuilder反轉在網域軸上繪製序列的方向。
reverseDirection()EmbeddedBarChartBuilder將沿著水平軸放大的長條圖反轉方向。
setBackgroundColor(cssValue)EmbeddedBarChartBuilder設定圖表的背景顏色。
setChartType(type)EmbeddedChartBuilder變更圖表類型。
setColors(cssValues)EmbeddedBarChartBuilder設定圖表中折線的顏色。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder設定要用於隱藏資料列和資料欄的策略。
setLegendPosition(position)EmbeddedBarChartBuilder設定圖例相對於圖表的位置。
setLegendTextStyle(textStyle)EmbeddedBarChartBuilder設定圖表圖例的文字樣式。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder設定在有多個範圍時要使用的合併策略。
setNumHeaders(headers)EmbeddedChartBuilder設定要視為標頭的範圍列數或欄數。
setOption(option, value)EmbeddedChartBuilder設定這張圖表的進階選項。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder設定位置,變更圖表在工作表中顯示的位置。
setRange(start, end)EmbeddedBarChartBuilder設定圖表的範圍。
setStacked()EmbeddedBarChartBuilder使用堆疊線條,也就是說,線條和長條圖的值會堆疊 (累加)。
setTitle(chartTitle)EmbeddedBarChartBuilder設定圖表的標題。
setTitleTextStyle(textStyle)EmbeddedBarChartBuilder設定圖表標題的文字樣式。
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilder設定是否要將圖表的資料列和資料欄互換。
setXAxisTextStyle(textStyle)EmbeddedBarChartBuilder設定橫軸的文字樣式。
setXAxisTitle(title)EmbeddedBarChartBuilder在水平軸上新增標題。
setXAxisTitleTextStyle(textStyle)EmbeddedBarChartBuilder設定水平軸標題的文字樣式。
setYAxisTextStyle(textStyle)EmbeddedBarChartBuilder設定垂直軸文字樣式。
setYAxisTitle(title)EmbeddedBarChartBuilder為垂直軸新增標題。
setYAxisTitleTextStyle(textStyle)EmbeddedBarChartBuilder設定垂直軸標題的文字樣式。
useLogScale()EmbeddedBarChartBuilder將範圍軸設為對數刻度 (所有值都必須為正值)。

EmbeddedChart

方法

方法傳回類型簡短說明
asDataSourceChart()DataSourceChart如果圖表是資料來源圖表,則會轉換為資料來源圖表例項,否則會轉換為 null
getAs(contentType)Blob將此物件內的資料傳回為轉換為指定內容類型的 Blob。
getBlob()Blob將此物件內的資料以 blob 格式傳回。
getChartId()Integer傳回圖表的穩定 ID,該 ID 在包含圖表的試算表中是唯一的,如果圖表不在試算表中,則傳回 null
getContainerInfo()ContainerInfo傳回圖表在試算表中的位置資訊。
getHiddenDimensionStrategy()ChartHiddenDimensionStrategy傳回用於處理隱藏資料列和資料欄的策略。
getMergeStrategy()ChartMergeStrategy傳回多個範圍存在時所用的合併策略。
getNumHeaders()Integer傳回範圍中視為標頭的列數或列數。
getOptions()ChartOptions傳回這張圖表的選項,例如高度、顏色和軸。
getRanges()Range[]傳回此圖表用來做為資料來源的範圍。
getTransposeRowsAndColumns()Boolean如果為 true,則會切換用於填入圖表的資料列和資料欄。
modify()EmbeddedChartBuilder會傳回可用於修改此圖表的 EmbeddedChartBuilder

EmbeddedChartBuilder

方法

方法傳回類型簡短說明
addRange(range)EmbeddedChartBuilder在這個建構工具修改的圖表中新增範圍。
asAreaChart()EmbeddedAreaChartBuilder將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder
asBarChart()EmbeddedBarChartBuilder將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder將圖表類型設為 ColumnChart,並傳回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder將圖表類型設為 HistogramChart,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為 LineChart,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為 ScatterChart,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建立圖表,反映所有對圖表所做的變更。
clearRanges()EmbeddedChartBuilder從這個建構工具修改的圖表中移除所有區間。
getChartType()ChartType傳回目前的圖表類型。
getContainer()ContainerInfo傳回圖表 ContainerInfo,該圖表會封裝圖表在工作表中顯示的位置。
getRanges()Range[]傳回目前為此圖表提供資料的範圍清單副本。
removeRange(range)EmbeddedChartBuilder從這個建構工具修改的圖表中移除指定範圍。
setChartType(type)EmbeddedChartBuilder變更圖表類型。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder設定要用於隱藏資料列和資料欄的策略。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder設定在有多個範圍時要使用的合併策略。
setNumHeaders(headers)EmbeddedChartBuilder設定要視為標頭的範圍列數或欄數。
setOption(option, value)EmbeddedChartBuilder設定這張圖表的進階選項。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder設定位置,變更圖表在工作表中顯示的位置。
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilder設定是否要將圖表的資料列和資料欄互換。

EmbeddedColumnChartBuilder

方法

方法傳回類型簡短說明
addRange(range)EmbeddedChartBuilder在這個建構工具修改的圖表中新增範圍。
asAreaChart()EmbeddedAreaChartBuilder將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder
asBarChart()EmbeddedBarChartBuilder將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder將圖表類型設為 ColumnChart,並傳回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder將圖表類型設為 HistogramChart,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為 LineChart,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為 ScatterChart,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建立圖表,反映所有對圖表所做的變更。
clearRanges()EmbeddedChartBuilder從這個建構工具修改的圖表中移除所有區間。
getChartType()ChartType傳回目前的圖表類型。
getContainer()ContainerInfo傳回圖表 ContainerInfo,該圖表會封裝圖表在工作表中顯示的位置。
getRanges()Range[]傳回目前為此圖表提供資料的範圍清單副本。
removeRange(range)EmbeddedChartBuilder從這個建構工具修改的圖表中移除指定範圍。
reverseCategories()EmbeddedColumnChartBuilder反轉在網域軸上繪製序列的方向。
setBackgroundColor(cssValue)EmbeddedColumnChartBuilder設定圖表的背景顏色。
setChartType(type)EmbeddedChartBuilder變更圖表類型。
setColors(cssValues)EmbeddedColumnChartBuilder設定圖表中折線的顏色。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder設定要用於隱藏資料列和資料欄的策略。
setLegendPosition(position)EmbeddedColumnChartBuilder設定圖例相對於圖表的位置。
setLegendTextStyle(textStyle)EmbeddedColumnChartBuilder設定圖表圖例的文字樣式。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder設定在有多個範圍時要使用的合併策略。
setNumHeaders(headers)EmbeddedChartBuilder設定要視為標頭的範圍列數或欄數。
setOption(option, value)EmbeddedChartBuilder設定這張圖表的進階選項。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder設定位置,變更圖表在工作表中顯示的位置。
setRange(start, end)EmbeddedColumnChartBuilder設定圖表的範圍。
setStacked()EmbeddedColumnChartBuilder使用堆疊線條,也就是說,線條和長條圖的值會堆疊 (累加)。
setTitle(chartTitle)EmbeddedColumnChartBuilder設定圖表的標題。
setTitleTextStyle(textStyle)EmbeddedColumnChartBuilder設定圖表標題的文字樣式。
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilder設定是否要將圖表的資料列和資料欄互換。
setXAxisTextStyle(textStyle)EmbeddedColumnChartBuilder設定橫軸的文字樣式。
setXAxisTitle(title)EmbeddedColumnChartBuilder在水平軸上新增標題。
setXAxisTitleTextStyle(textStyle)EmbeddedColumnChartBuilder設定水平軸標題的文字樣式。
setYAxisTextStyle(textStyle)EmbeddedColumnChartBuilder設定垂直軸文字樣式。
setYAxisTitle(title)EmbeddedColumnChartBuilder為垂直軸新增標題。
setYAxisTitleTextStyle(textStyle)EmbeddedColumnChartBuilder設定垂直軸標題的文字樣式。
useLogScale()EmbeddedColumnChartBuilder將範圍軸設為對數刻度 (所有值都必須為正值)。

EmbeddedComboChartBuilder

方法

方法傳回類型簡短說明
addRange(range)EmbeddedChartBuilder在這個建構工具修改的圖表中新增範圍。
asAreaChart()EmbeddedAreaChartBuilder將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder
asBarChart()EmbeddedBarChartBuilder將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder將圖表類型設為 ColumnChart,並傳回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder將圖表類型設為 HistogramChart,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為 LineChart,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為 ScatterChart,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建立圖表,反映所有對圖表所做的變更。
clearRanges()EmbeddedChartBuilder從這個建構工具修改的圖表中移除所有區間。
getChartType()ChartType傳回目前的圖表類型。
getContainer()ContainerInfo傳回圖表 ContainerInfo,該圖表會封裝圖表在工作表中顯示的位置。
getRanges()Range[]傳回目前為此圖表提供資料的範圍清單副本。
removeRange(range)EmbeddedChartBuilder從這個建構工具修改的圖表中移除指定範圍。
reverseCategories()EmbeddedComboChartBuilder反轉在網域軸上繪製序列的方向。
setBackgroundColor(cssValue)EmbeddedComboChartBuilder設定圖表的背景顏色。
setChartType(type)EmbeddedChartBuilder變更圖表類型。
setColors(cssValues)EmbeddedComboChartBuilder設定圖表中折線的顏色。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder設定要用於隱藏資料列和資料欄的策略。
setLegendPosition(position)EmbeddedComboChartBuilder設定圖例相對於圖表的位置。
setLegendTextStyle(textStyle)EmbeddedComboChartBuilder設定圖表圖例的文字樣式。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder設定在有多個範圍時要使用的合併策略。
setNumHeaders(headers)EmbeddedChartBuilder設定要視為標頭的範圍列數或欄數。
setOption(option, value)EmbeddedChartBuilder設定這張圖表的進階選項。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder設定位置,變更圖表在工作表中顯示的位置。
setRange(start, end)EmbeddedComboChartBuilder設定圖表的範圍。
setStacked()EmbeddedComboChartBuilder使用堆疊線條,也就是說,線條和長條圖的值會堆疊 (累加)。
setTitle(chartTitle)EmbeddedComboChartBuilder設定圖表的標題。
setTitleTextStyle(textStyle)EmbeddedComboChartBuilder設定圖表標題的文字樣式。
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilder設定是否要將圖表的資料列和資料欄互換。
setXAxisTextStyle(textStyle)EmbeddedComboChartBuilder設定橫軸的文字樣式。
setXAxisTitle(title)EmbeddedComboChartBuilder在水平軸上新增標題。
setXAxisTitleTextStyle(textStyle)EmbeddedComboChartBuilder設定水平軸標題的文字樣式。
setYAxisTextStyle(textStyle)EmbeddedComboChartBuilder設定垂直軸文字樣式。
setYAxisTitle(title)EmbeddedComboChartBuilder為垂直軸新增標題。
setYAxisTitleTextStyle(textStyle)EmbeddedComboChartBuilder設定垂直軸標題的文字樣式。
useLogScale()EmbeddedComboChartBuilder將範圍軸設為對數刻度 (所有值都必須為正值)。

EmbeddedHistogramChartBuilder

方法

方法傳回類型簡短說明
addRange(range)EmbeddedChartBuilder在這個建構工具修改的圖表中新增範圍。
asAreaChart()EmbeddedAreaChartBuilder將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder
asBarChart()EmbeddedBarChartBuilder將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder將圖表類型設為 ColumnChart,並傳回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder將圖表類型設為 HistogramChart,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為 LineChart,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為 ScatterChart,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建立圖表,反映所有對圖表所做的變更。
clearRanges()EmbeddedChartBuilder從這個建構工具修改的圖表中移除所有區間。
getChartType()ChartType傳回目前的圖表類型。
getContainer()ContainerInfo傳回圖表 ContainerInfo,該圖表會封裝圖表在工作表中顯示的位置。
getRanges()Range[]傳回目前為此圖表提供資料的範圍清單副本。
removeRange(range)EmbeddedChartBuilder從這個建構工具修改的圖表中移除指定範圍。
reverseCategories()EmbeddedHistogramChartBuilder反轉在網域軸上繪製序列的方向。
setBackgroundColor(cssValue)EmbeddedHistogramChartBuilder設定圖表的背景顏色。
setChartType(type)EmbeddedChartBuilder變更圖表類型。
setColors(cssValues)EmbeddedHistogramChartBuilder設定圖表中折線的顏色。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder設定要用於隱藏資料列和資料欄的策略。
setLegendPosition(position)EmbeddedHistogramChartBuilder設定圖例相對於圖表的位置。
setLegendTextStyle(textStyle)EmbeddedHistogramChartBuilder設定圖表圖例的文字樣式。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder設定在有多個範圍時要使用的合併策略。
setNumHeaders(headers)EmbeddedChartBuilder設定要視為標頭的範圍列數或欄數。
setOption(option, value)EmbeddedChartBuilder設定這張圖表的進階選項。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder設定位置,變更圖表在工作表中顯示的位置。
setRange(start, end)EmbeddedHistogramChartBuilder設定圖表的範圍。
setStacked()EmbeddedHistogramChartBuilder使用堆疊線條,也就是說,線條和長條圖的值會堆疊 (累加)。
setTitle(chartTitle)EmbeddedHistogramChartBuilder設定圖表的標題。
setTitleTextStyle(textStyle)EmbeddedHistogramChartBuilder設定圖表標題的文字樣式。
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilder設定是否要將圖表的資料列和資料欄互換。
setXAxisTextStyle(textStyle)EmbeddedHistogramChartBuilder設定橫軸的文字樣式。
setXAxisTitle(title)EmbeddedHistogramChartBuilder在水平軸上新增標題。
setXAxisTitleTextStyle(textStyle)EmbeddedHistogramChartBuilder設定水平軸標題的文字樣式。
setYAxisTextStyle(textStyle)EmbeddedHistogramChartBuilder設定垂直軸文字樣式。
setYAxisTitle(title)EmbeddedHistogramChartBuilder為垂直軸新增標題。
setYAxisTitleTextStyle(textStyle)EmbeddedHistogramChartBuilder設定垂直軸標題的文字樣式。
useLogScale()EmbeddedHistogramChartBuilder將範圍軸設為對數刻度 (所有值都必須為正值)。

EmbeddedLineChartBuilder

方法

方法傳回類型簡短說明
addRange(range)EmbeddedChartBuilder在這個建構工具修改的圖表中新增範圍。
asAreaChart()EmbeddedAreaChartBuilder將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder
asBarChart()EmbeddedBarChartBuilder將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder將圖表類型設為 ColumnChart,並傳回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder將圖表類型設為 HistogramChart,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為 LineChart,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為 ScatterChart,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建立圖表,反映所有對圖表所做的變更。
clearRanges()EmbeddedChartBuilder從這個建構工具修改的圖表中移除所有區間。
getChartType()ChartType傳回目前的圖表類型。
getContainer()ContainerInfo傳回圖表 ContainerInfo,該圖表會封裝圖表在工作表中顯示的位置。
getRanges()Range[]傳回目前為此圖表提供資料的範圍清單副本。
removeRange(range)EmbeddedChartBuilder從這個建構工具修改的圖表中移除指定範圍。
reverseCategories()EmbeddedLineChartBuilder反轉在網域軸上繪製序列的方向。
setBackgroundColor(cssValue)EmbeddedLineChartBuilder設定圖表的背景顏色。
setChartType(type)EmbeddedChartBuilder變更圖表類型。
setColors(cssValues)EmbeddedLineChartBuilder設定圖表中折線的顏色。
setCurveStyle(style)EmbeddedLineChartBuilder設定圖表中曲線的樣式。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder設定要用於隱藏資料列和資料欄的策略。
setLegendPosition(position)EmbeddedLineChartBuilder設定圖例相對於圖表的位置。
setLegendTextStyle(textStyle)EmbeddedLineChartBuilder設定圖表圖例的文字樣式。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder設定在有多個範圍時要使用的合併策略。
setNumHeaders(headers)EmbeddedChartBuilder設定要視為標頭的範圍列數或欄數。
setOption(option, value)EmbeddedChartBuilder設定這張圖表的進階選項。
setPointStyle(style)EmbeddedLineChartBuilder設定線條中點的樣式。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder設定位置,變更圖表在工作表中顯示的位置。
setRange(start, end)EmbeddedLineChartBuilder設定圖表的範圍。
setTitle(chartTitle)EmbeddedLineChartBuilder設定圖表的標題。
setTitleTextStyle(textStyle)EmbeddedLineChartBuilder設定圖表標題的文字樣式。
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilder設定是否要將圖表的資料列和資料欄互換。
setXAxisTextStyle(textStyle)EmbeddedLineChartBuilder設定橫軸的文字樣式。
setXAxisTitle(title)EmbeddedLineChartBuilder在水平軸上新增標題。
setXAxisTitleTextStyle(textStyle)EmbeddedLineChartBuilder設定水平軸標題的文字樣式。
setYAxisTextStyle(textStyle)EmbeddedLineChartBuilder設定垂直軸文字樣式。
setYAxisTitle(title)EmbeddedLineChartBuilder為垂直軸新增標題。
setYAxisTitleTextStyle(textStyle)EmbeddedLineChartBuilder設定垂直軸標題的文字樣式。
useLogScale()EmbeddedLineChartBuilder將範圍軸設為對數刻度 (所有值都必須為正值)。

EmbeddedPieChartBuilder

方法

方法傳回類型簡短說明
addRange(range)EmbeddedChartBuilder在這個建構工具修改的圖表中新增範圍。
asAreaChart()EmbeddedAreaChartBuilder將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder
asBarChart()EmbeddedBarChartBuilder將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder將圖表類型設為 ColumnChart,並傳回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder將圖表類型設為 HistogramChart,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為 LineChart,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為 ScatterChart,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建立圖表,反映所有對圖表所做的變更。
clearRanges()EmbeddedChartBuilder從這個建構工具修改的圖表中移除所有區間。
getChartType()ChartType傳回目前的圖表類型。
getContainer()ContainerInfo傳回圖表 ContainerInfo,該圖表會封裝圖表在工作表中顯示的位置。
getRanges()Range[]傳回目前為此圖表提供資料的範圍清單副本。
removeRange(range)EmbeddedChartBuilder從這個建構工具修改的圖表中移除指定範圍。
reverseCategories()EmbeddedPieChartBuilder反轉在網域軸上繪製序列的方向。
set3D()EmbeddedPieChartBuilder將圖表設為 3D。
setBackgroundColor(cssValue)EmbeddedPieChartBuilder設定圖表的背景顏色。
setChartType(type)EmbeddedChartBuilder變更圖表類型。
setColors(cssValues)EmbeddedPieChartBuilder設定圖表中折線的顏色。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder設定要用於隱藏資料列和資料欄的策略。
setLegendPosition(position)EmbeddedPieChartBuilder設定圖例相對於圖表的位置。
setLegendTextStyle(textStyle)EmbeddedPieChartBuilder設定圖表圖例的文字樣式。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder設定在有多個範圍時要使用的合併策略。
setNumHeaders(headers)EmbeddedChartBuilder設定要視為標頭的範圍列數或欄數。
setOption(option, value)EmbeddedChartBuilder設定這張圖表的進階選項。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder設定位置,變更圖表在工作表中顯示的位置。
setTitle(chartTitle)EmbeddedPieChartBuilder設定圖表的標題。
setTitleTextStyle(textStyle)EmbeddedPieChartBuilder設定圖表標題的文字樣式。
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilder設定是否要將圖表的資料列和資料欄互換。

EmbeddedScatterChartBuilder

方法

方法傳回類型簡短說明
addRange(range)EmbeddedChartBuilder在這個建構工具修改的圖表中新增範圍。
asAreaChart()EmbeddedAreaChartBuilder將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder
asBarChart()EmbeddedBarChartBuilder將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder將圖表類型設為 ColumnChart,並傳回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder將圖表類型設為 HistogramChart,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為 LineChart,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為 ScatterChart,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建立圖表,反映所有對圖表所做的變更。
clearRanges()EmbeddedChartBuilder從這個建構工具修改的圖表中移除所有區間。
getChartType()ChartType傳回目前的圖表類型。
getContainer()ContainerInfo傳回圖表 ContainerInfo,該圖表會封裝圖表在工作表中顯示的位置。
getRanges()Range[]傳回目前為此圖表提供資料的範圍清單副本。
removeRange(range)EmbeddedChartBuilder從這個建構工具修改的圖表中移除指定範圍。
setBackgroundColor(cssValue)EmbeddedScatterChartBuilder設定圖表的背景顏色。
setChartType(type)EmbeddedChartBuilder變更圖表類型。
setColors(cssValues)EmbeddedScatterChartBuilder設定圖表中折線的顏色。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder設定要用於隱藏資料列和資料欄的策略。
setLegendPosition(position)EmbeddedScatterChartBuilder設定圖例相對於圖表的位置。
setLegendTextStyle(textStyle)EmbeddedScatterChartBuilder設定圖表圖例的文字樣式。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder設定在有多個範圍時要使用的合併策略。
setNumHeaders(headers)EmbeddedChartBuilder設定要視為標頭的範圍列數或欄數。
setOption(option, value)EmbeddedChartBuilder設定這張圖表的進階選項。
setPointStyle(style)EmbeddedScatterChartBuilder設定線條中點的樣式。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder設定位置,變更圖表在工作表中顯示的位置。
setTitle(chartTitle)EmbeddedScatterChartBuilder設定圖表的標題。
setTitleTextStyle(textStyle)EmbeddedScatterChartBuilder設定圖表標題的文字樣式。
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilder設定是否要將圖表的資料列和資料欄互換。
setXAxisLogScale()EmbeddedScatterChartBuilder將水平軸設為對數刻度 (所有值都必須為正值)。
setXAxisRange(start, end)EmbeddedScatterChartBuilder設定圖表的水平軸範圍。
setXAxisTextStyle(textStyle)EmbeddedScatterChartBuilder設定橫軸的文字樣式。
setXAxisTitle(title)EmbeddedScatterChartBuilder在水平軸上新增標題。
setXAxisTitleTextStyle(textStyle)EmbeddedScatterChartBuilder設定水平軸標題的文字樣式。
setYAxisLogScale()EmbeddedScatterChartBuilder將垂直軸設為對數刻度 (所有值都必須為正值)。
setYAxisRange(start, end)EmbeddedScatterChartBuilder設定圖表垂直軸的範圍。
setYAxisTextStyle(textStyle)EmbeddedScatterChartBuilder設定垂直軸文字樣式。
setYAxisTitle(title)EmbeddedScatterChartBuilder為垂直軸新增標題。
setYAxisTitleTextStyle(textStyle)EmbeddedScatterChartBuilder設定垂直軸標題的文字樣式。

EmbeddedTableChartBuilder

方法

方法傳回類型簡短說明
addRange(range)EmbeddedChartBuilder在這個建構工具修改的圖表中新增範圍。
asAreaChart()EmbeddedAreaChartBuilder將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder
asBarChart()EmbeddedBarChartBuilder將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder將圖表類型設為 ColumnChart,並傳回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder將圖表類型設為 HistogramChart,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為 LineChart,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為 ScatterChart,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建立圖表,反映所有對圖表所做的變更。
clearRanges()EmbeddedChartBuilder從這個建構工具修改的圖表中移除所有區間。
enablePaging(enablePaging)EmbeddedTableChartBuilder設定是否要啟用資料分頁功能。
enablePaging(pageSize)EmbeddedTableChartBuilder啟用分頁功能,並設定每個頁面中的資料列數量。
enablePaging(pageSize, startPage)EmbeddedTableChartBuilder啟用分頁功能,設定每個頁面的列數和要顯示的第一個表格頁面 (頁碼以零為基底)。
enableRtlTable(rtlEnabled)EmbeddedTableChartBuilder為由右至左的語言 (例如阿拉伯文或希伯來文) 新增基本支援功能,方法是將表格的欄順序倒轉,讓第 0 欄成為最右邊的欄,而最後一欄則是位於最左邊。
enableSorting(enableSorting)EmbeddedTableChartBuilder設定使用者點選資料欄標題時是否要排序資料欄。
getChartType()ChartType傳回目前的圖表類型。
getContainer()ContainerInfo傳回圖表 ContainerInfo,該圖表會封裝圖表在工作表中顯示的位置。
getRanges()Range[]傳回目前為此圖表提供資料的範圍清單副本。
removeRange(range)EmbeddedChartBuilder從這個建構工具修改的圖表中移除指定範圍。
setChartType(type)EmbeddedChartBuilder變更圖表類型。
setFirstRowNumber(number)EmbeddedTableChartBuilder設定資料表中第一列的資料列號。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder設定要用於隱藏資料列和資料欄的策略。
setInitialSortingAscending(column)EmbeddedTableChartBuilder根據表格應初始排序的欄索引 (遞增) 進行設定。
setInitialSortingDescending(column)EmbeddedTableChartBuilder設定表格應依據哪個欄的索引進行初始排序 (遞減)。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder設定在有多個範圍時要使用的合併策略。
setNumHeaders(headers)EmbeddedChartBuilder設定要視為標頭的範圍列數或欄數。
setOption(option, value)EmbeddedChartBuilder設定這張圖表的進階選項。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder設定位置,變更圖表在工作表中顯示的位置。
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilder設定是否要將圖表的資料列和資料欄互換。
showRowNumberColumn(showRowNumber)EmbeddedTableChartBuilder設定是否要將資料列編號顯示為表格的第一欄。
useAlternatingRowStyle(alternate)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

方法

方法傳回類型簡短說明
build()FilterCriteria使用您在條件建構工具中新增的設定,組合篩選條件。
copy()FilterCriteriaBuilder複製這個篩選條件,並建立可套用至其他篩選器的條件建構工具。
getCriteriaType()BooleanCriteria傳回條件的布林值型別,例如 CELL_EMPTY
getCriteriaValues()Object[]傳回布林條件的引數陣列。
getHiddenValues()String[]傳回篩除器隱藏的值。
getVisibleBackgroundColor()Color傳回用於篩選條件的背景顏色。
getVisibleForegroundColor()Color傳回做為篩選條件使用的前景顏色。
getVisibleValues()String[]傳回資料透視表篩選器顯示的值。
setHiddenValues(values)FilterCriteriaBuilder設定要隱藏的值。
setVisibleBackgroundColor(visibleBackgroundColor)FilterCriteriaBuilder設定用於篩選條件的背景顏色。
setVisibleForegroundColor(visibleForegroundColor)FilterCriteriaBuilder設定用於篩選條件的前景色。
setVisibleValues(values)FilterCriteriaBuilder設定資料透視表中要顯示的值。
whenCellEmpty()FilterCriteriaBuilder設定篩選條件,以便顯示空白儲存格。
whenCellNotEmpty()FilterCriteriaBuilder設定篩選條件,顯示非空白的儲存格。
whenDateAfter(date)FilterCriteriaBuilder設定篩選條件,顯示日期大於指定日期的儲存格。
whenDateAfter(date)FilterCriteriaBuilder設定篩選條件,顯示日期大於指定相對日期的儲存格。
whenDateBefore(date)FilterCriteriaBuilder設定篩選條件,顯示日期早於指定日期的儲存格。
whenDateBefore(date)FilterCriteriaBuilder設定篩選條件,顯示日期早於指定相對日期的儲存格。
whenDateEqualTo(date)FilterCriteriaBuilder設定篩選器條件,顯示日期等於指定日期的儲存格。
whenDateEqualTo(date)FilterCriteriaBuilder設定篩選器條件,顯示日期等於指定相對日期的儲存格。
whenDateEqualToAny(dates)FilterCriteriaBuilder設定篩選器條件,顯示日期等於任何指定日期的儲存格。
whenDateNotEqualTo(date)FilterCriteriaBuilder設定篩選條件,顯示不等於指定日期的儲存格。
whenDateNotEqualToAny(dates)FilterCriteriaBuilder設定篩選器條件,顯示日期不等於任何指定日期的儲存格。
whenFormulaSatisfied(formula)FilterCriteriaBuilder設定篩選條件,以便顯示使用特定公式 (例如 =B:B<C:C) 且評估結果為 true 的儲存格。
whenNumberBetween(start, end)FilterCriteriaBuilder設定篩選器條件,顯示數字介於 2 個指定數字之間,或為其中任一數字的儲存格。
whenNumberEqualTo(number)FilterCriteriaBuilder設定篩選器條件,顯示數字等於指定數字的儲存格。
whenNumberEqualToAny(numbers)FilterCriteriaBuilder設定篩選條件,顯示數字等於任何指定數字的儲存格。
whenNumberGreaterThan(number)FilterCriteriaBuilder設定篩選條件,只顯示數字大於指定數字的儲存格
whenNumberGreaterThanOrEqualTo(number)FilterCriteriaBuilder設定篩選條件,顯示數字大於或等於指定數字的儲存格。
whenNumberLessThan(number)FilterCriteriaBuilder設定篩選器條件,顯示數字小於指定數字的儲存格。
whenNumberLessThanOrEqualTo(number)FilterCriteriaBuilder設定篩選條件,顯示數字小於或等於指定數字的儲存格。
whenNumberNotBetween(start, end)FilterCriteriaBuilder設定篩選條件,顯示儲存格內的數字不介於 2 個指定數字之間,且不等於這 2 個數字。
whenNumberNotEqualTo(number)FilterCriteriaBuilder設定篩選條件,顯示數字不等於指定數字的儲存格。
whenNumberNotEqualToAny(numbers)FilterCriteriaBuilder設定篩選條件,顯示數字不等於任何指定數字的儲存格。
whenTextContains(text)FilterCriteriaBuilder設定篩選條件,顯示文字中含有指定文字的儲存格。
whenTextDoesNotContain(text)FilterCriteriaBuilder設定篩選條件,顯示文字不含指定文字的儲存格。
whenTextEndsWith(text)FilterCriteriaBuilder設定篩選條件,只顯示結尾為指定文字的文字儲存格。
whenTextEqualTo(text)FilterCriteriaBuilder設定篩選條件,只顯示文字等於指定文字的儲存格。
whenTextEqualToAny(texts)FilterCriteriaBuilder設定篩選條件,顯示文字等於任何指定文字值的儲存格。
whenTextNotEqualTo(text)FilterCriteriaBuilder設定篩選條件,顯示文字不等於指定文字的儲存格。
whenTextNotEqualToAny(texts)FilterCriteriaBuilder設定篩選條件,顯示文字不等於任何指定值的儲存格。
whenTextStartsWith(text)FilterCriteriaBuilder設定篩選條件,只顯示文字以指定文字開頭的儲存格。
withCriteria(criteria, args)FilterCriteriaBuilder將篩選條件設為由 BooleanCriteria 值 (例如 CELL_EMPTYNUMBER_GREATER_THAN) 定義的布林值條件。

FrequencyType

屬性

屬性類型說明
FREQUENCY_TYPE_UNSUPPORTEDEnum系統不支援頻率類型。
DAILYEnum每天重新整理。
WEEKLYEnum每週在特定幾天更新。
MONTHLYEnum每月在特定日期更新。

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

屬性

屬性類型說明
BEFOREEnum控制切換鈕位於群組之前的位置 (較低的索引)。
AFTEREnum控制切換鈕在群組後方的位址 (較高的索引)。

InterpolationType

屬性

屬性類型說明
NUMBEREnum將該數字用於漸層條件的特定插補點。
PERCENTEnum將該數字用於漸層條件的百分比插補點。
PERCENTILEEnum將該數字用於漸層條件的百分比插補點。
MINEnum將最小值推論為漸層條件的特定插補點。
MAXEnum將數量上限推論為漸層條件的特定插補點。

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

方法

方法傳回類型簡短說明
assignScript(functionName)OverGridImage將具有指定函式名稱的函式指派給這個映像檔。
getAltTextDescription()String傳回此圖片的替代文字說明。
getAltTextTitle()String傳回圖片的替代文字標題。
getAnchorCell()Range傳回圖片錨定位置的儲存格。
getAnchorCellXOffset()Integer傳回錨定儲存格水平像素偏移量。
getAnchorCellYOffset()Integer傳回錨定儲存格垂直方向的像素偏移量。
getHeight()Integer以像素為單位,傳回此圖片的實際高度。
getInherentHeight()Integer以像素為單位,傳回此圖片的固有高度。
getInherentWidth()Integer以像素為單位,傳回此圖片的固有高度。
getScript()String傳回指派給此圖片的函式名稱。
getSheet()Sheet傳回這張圖片所在的工作表。
getUrl()String取得圖片的來源網址;如果網址無法使用,則會傳回 null
getWidth()Integer以像素為單位,傳回此圖片的實際寬度。
remove()void從試算表中刪除這張圖片。
replace(blob)OverGridImage將這張圖片替換為由提供的 BlobSource 指定的圖片。
replace(url)OverGridImage將此圖片替換為指定網址中的圖片。
resetSize()OverGridImage將圖片重設為其固有尺寸。
setAltTextDescription(description)OverGridImage設定圖片的替代文字說明。
setAltTextTitle(title)OverGridImage設定圖片的替代文字標題。
setAnchorCell(cell)OverGridImage設定圖片錨定的儲存格。
setAnchorCellXOffset(offset)OverGridImage設定錨定儲存格水平像素偏移量。
setAnchorCellYOffset(offset)OverGridImage設定錨定儲存格垂直像素偏移量。
setHeight(height)OverGridImage以像素為單位,設定此圖片的實際高度。
setWidth(width)OverGridImage設定圖片的實際寬度,以像素為單位。

PageProtection

PivotFilter

方法

方法傳回類型簡短說明
getFilterCriteria()FilterCriteria傳回此樞紐篩選器的篩選條件。
getPivotTable()PivotTable傳回此篩選器所屬的 PivotTable
getSourceDataColumn()Integer傳回這個篩選器所處理的來源資料欄數量。
getSourceDataSourceColumn()DataSourceColumn傳回篩選器運作的資料來源欄。
remove()void從資料透視表中移除這個資料透視篩選器。
setFilterCriteria(filterCriteria)PivotFilter設定樞紐篩選器的篩選條件。

PivotGroup

方法

方法傳回類型簡短說明
addManualGroupingRule(groupName, groupMembers)PivotGroup為這個資料透視表群組新增手動分組規則。
areLabelsRepeated()Boolean傳回標籤是否以重複方式顯示。
clearGroupingRule()PivotGroup從這個資料透視表元素群組中移除任何分組規則。
clearSort()PivotGroup移除套用至這個群組的任何排序。
getDateTimeGroupingRule()DateTimeGroupingRule傳回資料透視表群組的日期時間分組規則,如果未設定日期時間分組規則,則傳回 null
getDimension()Dimension傳回這是否為列或欄組。
getGroupLimit()PivotGroupLimit傳回資料透視表元素群組的資料透視表元素群組限制。
getIndex()Integer傳回這個資料透視表元素群組在目前群組順序中的索引。
getPivotTable()PivotTable傳回這個分組所屬的 PivotTable
getSourceDataColumn()Integer傳回這個群組匯總的來源資料欄數量。
getSourceDataSourceColumn()DataSourceColumn傳回資料透視群組運作的資料來源欄。
hideRepeatedLabels()PivotGroup隱藏此分組的重複標籤。
isSortAscending()Boolean如果排序方式是遞增,則會傳回 true;如果排序順序是遞減,則會傳回 false
moveToIndex(index)PivotGroup將這個群組移至目前資料列或資料欄群組清單中的指定位置。
remove()void從資料表中移除這個資料透視表元素群組。
removeManualGroupingRule(groupName)PivotGroup移除含有指定 groupName 的手動分組規則。
resetDisplayName()PivotGroup將資料透視表中這個群組的顯示名稱重設為預設值。
setDateTimeGroupingRule(dateTimeGroupingRuleType)PivotGroup設定資料透視表元素的分組日期時間規則。
setDisplayName(name)PivotGroup設定樞紐分析表中這個群組的顯示名稱。
setGroupLimit(countLimit)PivotGroup為資料透視表元素群組設定資料透視表元素群組限制。
setHistogramGroupingRule(minValue, maxValue, intervalSize)PivotGroup為這個資料透視群組設定直方圖分組規則。
showRepeatedLabels()PivotGroup如果有兩個以上的資料列或資料欄群組,這個方法會針對後續群組的每個項目顯示這個群組的標籤。
showTotals(showTotals)PivotGroup設定是否要在表格中顯示此資料透視群組的總值。
sortAscending()PivotGroup將排序順序設為遞增。
sortBy(value, oppositeGroupValues)PivotGroup依據 oppositeGroupValues 的值,按照指定的 PivotValue 對這個群組進行排序。
sortDescending()PivotGroup將排序順序設為遞減。
totalsAreShown()Boolean傳回目前是否顯示此樞紐群組的總值。

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

屬性

屬性類型說明
CUSTOMEnum自訂函式,這個值僅適用於計算結果欄位。
SUMEnumSUM 函式
COUNTAEnumCOUNTA 函式
COUNTEnumCOUNT 函式
COUNTUNIQUEEnumCOUNTUNIQUE 函式
AVERAGEEnumAVERAGE 函式
MAXEnumMAX 函式
MINEnumMIN 函式
MEDIANEnumMEDIAN 函式
PRODUCTEnumPRODUCT 函式
STDEVEnumSTDEV 函式
STDEVPEnumSTDEVP 函式
VAREnumVAR 函式
VARPEnumVARP 函式

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

屬性

屬性類型說明
DEFAULTEnum預設值。
PERCENT_OF_ROW_TOTALEnum以該列總數的百分比顯示透視值。
PERCENT_OF_COLUMN_TOTALEnum以百分比的形式顯示該欄的總數的透視值。
PERCENT_OF_GRAND_TOTALEnum以總和的百分比顯示樞紐值。

Protection

方法

方法傳回類型簡短說明
addEditor(emailAddress)Protection將指定使用者新增至受保護工作表或範圍的編輯者清單。
addEditor(user)Protection將指定使用者新增至受保護工作表或範圍的編輯者清單。
addEditors(emailAddresses)Protection將指定的使用者陣列新增至受保護工作表或範圍的編輯者清單。
addTargetAudience(audienceId)Protection將指定的目標對象新增為受保護範圍的編輯者。
canDomainEdit()Boolean判斷擁有試算表的網域中,所有使用者是否有權編輯受保護的範圍或試算表。
canEdit()Boolean判斷使用者是否有權編輯受保護的範圍或工作表。
getDescription()String取得受保護範圍或工作表的說明。
getEditors()User[]取得受保護範圍或工作表的編輯者清單。
getProtectionType()ProtectionType取得受保護區的類型,可能是 RANGESHEET
getRange()Range取得受保護的範圍。
getRangeName()String取得已命名範圍的名稱 (如果已命名範圍與受保護範圍相關聯的話)。
getTargetAudiences()TargetAudience[]傳回可編輯受保護範圍的目標對象 ID。
getUnprotectedRanges()Range[]取得受保護工作表中未受保護的範圍陣列。
isWarningOnly()Boolean判斷受保護區是否使用「警告式」保護機制。
remove()void解除範圍或工作表的保護設定。
removeEditor(emailAddress)Protection將指定使用者從受保護的工作表或範圍的編輯者清單中移除。
removeEditor(user)Protection將指定使用者從受保護的工作表或範圍的編輯者清單中移除。
removeEditors(emailAddresses)Protection將指定的使用者陣列從受保護的工作表或範圍編輯者清單中移除。
removeTargetAudience(audienceId)Protection移除指定目標對象,以免其編輯受保護的範圍。
setDescription(description)Protection設定受保護範圍或工作表的說明。
setDomainEdit(editable)Protection設定試算表擁有者網域中的所有使用者是否有權編輯受保護的範圍或試算表。
setNamedRange(namedRange)Protection將受保護的範圍與現有的命名範圍建立關聯。
setRange(range)Protection調整受保護的範圍。
setRangeName(rangeName)Protection將受保護的範圍與現有的命名範圍建立關聯。
setUnprotectedRanges(ranges)Protection解除受保護工作表中指定的範圍陣列。
setWarningOnly(warningOnly)Protection設定這個受保護的範圍是否使用「警告」保護機制。

ProtectionType

屬性

屬性類型說明
RANGEEnum保護範圍。
SHEETEnum工作表的保護措施。

Range

方法

方法傳回類型簡短說明
activate()Range將指定的範圍設為 active range,範圍內的左上方儲存格為 current cell
activateAsCurrentCell()Range將指定的儲存格設為 current cell
addDeveloperMetadata(key)Range將含有指定鍵的開發人員中繼資料新增至範圍。
addDeveloperMetadata(key, visibility)Range將開發人員中繼資料加入範圍,並指定鍵和瀏覽權限。
addDeveloperMetadata(key, value)Range將開發人員中繼資料新增至指定範圍,其中包含指定的鍵和值。
addDeveloperMetadata(key, value, visibility)Range為指定範圍新增開發人員中繼資料,並指定鍵、值和瀏覽權限。
applyColumnBanding()Banding將預設的欄帶主題套用至指定範圍。
applyColumnBanding(bandingTheme)Banding將指定的資料欄帶狀主題套用至指定範圍。
applyColumnBanding(bandingTheme, showHeader, showFooter)Banding將指定的資料欄分欄主題套用至範圍,並設定指定的頁首和頁尾。
applyRowBanding()Banding將預設的列分割主題套用至指定範圍。
applyRowBanding(bandingTheme)Banding將指定的列分割主題套用至指定範圍。
applyRowBanding(bandingTheme, showHeader, showFooter)Banding將指定的列分割主題套用至範圍,並套用指定的頁首和頁尾設定。
autoFill(destination, series)void根據這個範圍內的資料,為 destinationRange 填入資料。
autoFillToNeighbor(series)void計算範圍,以便根據相鄰儲存格填入新資料,並根據該範圍內的資料,自動為該範圍填入新值。
breakApart()Range再次將範圍內的多欄儲存格拆分為個別儲存格。
canEdit()Boolean判斷使用者是否有權編輯指定範圍中的每個儲存格。
check()Range將範圍內的核取方塊狀態變更為「已勾選」。
clear()Range清除內容和格式範圍。
clear(options)Range清除指定進階選項所指定的內容範圍、格式、資料驗證規則和/或註解。
clearContent()Range清除指定範圍的內容,但保留格式設定。
clearDataValidations()Range清除指定範圍的資料驗證規則。
clearFormat()Range清除這個範圍的格式。
clearNote()Range清除指定儲存格或儲存格中的備註。
collapseGroups()Range收合完全包含在範圍內的所有群組。
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)void將範圍的格式複製到指定位置。
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)void將範圍的格式複製到指定位置。
copyTo(destination)void將資料從某個儲存格範圍複製到另一個儲存格範圍。
copyTo(destination, copyPasteType, transposed)void將資料從某個儲存格範圍複製到另一個儲存格範圍。
copyTo(destination, options)void將資料從某個儲存格範圍複製到另一個儲存格範圍。
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)void將指定範圍的內容複製到指定位置。
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)void將指定範圍的內容複製到指定位置。
createDataSourcePivotTable(dataSource)DataSourcePivotTable從資料來源建立空白資料來源資料透視表,並將其固定在這個範圍中的第一個儲存格。
createDataSourceTable(dataSource)DataSourceTable從資料來源建立空白資料來源資料表,並將錨點設為此範圍中的第一個儲存格。
createDeveloperMetadataFinder()DeveloperMetadataFinder傳回 DeveloperMetadataFinderApi,用於在這個範圍內尋找開發人員中繼資料。
createFilter()Filter建立篩選器,並套用至工作表的指定範圍。
createPivotTable(sourceData)PivotTable從指定的 sourceData 建立空白資料透視表,該 sourceData 錨定於此範圍中的第一個儲存格。
createTextFinder(findText)TextFinder為指定範圍建立文字搜尋工具,以便尋找及取代該範圍內的文字。
deleteCells(shiftDimension)void刪除這個儲存格範圍。
expandGroups()Range展開範圍或控制切換按鈕與此範圍相交的收合群組。
getA1Notation()String以 A1 標記法傳回指定範圍的字串說明。
getBackground()String傳回指定範圍內左上角儲存格的背景顏色 (例如 '#ffffff')。
getBackgroundObject()Color傳回指定範圍中左上方儲存格的背景顏色。
getBackgroundObjects()Color[][]傳回指定範圍內儲存格的背景顏色。
getBackgrounds()String[][]傳回範圍內儲存格的背景顏色 (例如 '#ffffff')。
getBandings()Banding[]傳回套用至此範圍內任何儲存格中的所有區塊。
getCell(row, column)Range傳回範圍內指定的儲存格。
getColumn()Integer傳回這個範圍的起始欄位置。
getDataRegion()Range傳回在四個主要 Direction 中擴展的範圍副本,涵蓋所有含有資料的鄰近儲存格。
getDataRegion(dimension)Range如果指定的維度為 Dimension.ROWS,則會傳回範圍展開的副本 Direction.UPDirection.DOWN;如果維度為 Dimension.COLUMNS,則會傳回 Direction.NEXTDirection.PREVIOUS
getDataSourceFormula()DataSourceFormula傳回範圍中第一個儲存格的 DataSourceFormula,如果儲存格不包含資料來源公式,則傳回 null
getDataSourceFormulas()DataSourceFormula[]傳回範圍內儲存格中的 DataSourceFormula
getDataSourcePivotTables()DataSourcePivotTable[]取得與範圍相交的所有資料來源資料透視表。
getDataSourceTables()DataSourceTable[]取得與範圍相交的所有資料來源資料表。
getDataSourceUrl()String傳回這個範圍內資料的網址,可用於建立圖表和查詢。
getDataTable()DataTable將這個物件內的資料以 DataTable 的形式傳回。
getDataTable(firstRowIsHeader)DataTable以 DataTable 的形式傳回此範圍內的資料。
getDataValidation()DataValidation傳回指定範圍中左上方儲存格的資料驗證規則。
getDataValidations()DataValidation[][]傳回指定範圍內所有儲存格的資料驗證規則。
getDeveloperMetadata()DeveloperMetadata[]取得與此範圍相關聯的開發人員中繼資料。
getDisplayValue()String傳回範圍中左上方儲存格的顯示值。
getDisplayValues()String[][]傳回這個範圍的值矩形格線。
getFilter()Filter傳回此範圍所屬工作表的篩選器,如果工作表上沒有篩選器,則傳回 null
getFontColorObject()Color傳回指定範圍左上角儲存格的字型顏色。
getFontColorObjects()Color[][]傳回指定範圍內儲存格的字型顏色。
getFontFamilies()String[][]傳回指定範圍內儲存格的字型系列。
getFontFamily()String傳回指定範圍左上角儲存格中的字型系列。
getFontLine()String取得範圍左上角儲存格 ('underline''line-through''none') 的線條樣式。
getFontLines()String[][]取得範圍內儲存格的線條樣式 ('underline''line-through''none')。
getFontSize()Integer傳回範圍左上角儲存格的字型大小 (以點為單位)。
getFontSizes()Integer[][]傳回指定範圍內儲存格的字型大小。
getFontStyle()String傳回範圍左上角儲存格的字型樣式 ('italic''normal')。
getFontStyles()String[][]傳回指定範圍內儲存格的字型樣式。
getFontWeight()String傳回指定範圍左上角儲存格的字型粗細 (一般/粗體)。
getFontWeights()String[][]傳回指定範圍內儲存格字型的粗細。
getFormula()String傳回指定範圍左上角儲存格的公式 (A1 標記法),如果儲存格為空白或不含公式,則傳回空字串。
getFormulaR1C1()String傳回指定儲存格中的公式 (R1C1 標記法),如果沒有則傳回 null
getFormulas()String[][]傳回範圍內儲存格中的公式 (A1 標記法)。
getFormulasR1C1()String[][]傳回範圍內儲存格中的公式 (R1C1 標記法)。
getGridId()Integer傳回範圍父工作表的格狀 ID。
getHeight()Integer傳回範圍的高度。
getHorizontalAlignment()String傳回指定區間左上角儲存格文字的水平對齊方式 (左/置中/右)。
getHorizontalAlignments()String[][]傳回範圍內儲存格水平對齊方式。
getLastColumn()Integer傳回結束的資料欄位置。
getLastRow()Integer傳回結束列位置。
getMergedRanges()Range[]傳回 Range 物件的陣列,代表完全位於目前範圍內的合併儲存格,或在目前範圍內至少包含一個儲存格。
getNextDataCell(direction)Range從範圍第一列和第一行的儲存格開始,傳回指定方向中的下一個儲存格,該儲存格是含有資料的連續儲存格範圍邊緣,或試算表在該方向邊緣的儲存格。
getNote()String傳回與指定範圍相關聯的附註。
getNotes()String[][]傳回與範圍內儲存格相關聯的附註。
getNumColumns()Integer傳回這個範圍內的欄數。
getNumRows()Integer傳回這個範圍內的列數。
getNumberFormat()String取得指定範圍左上方儲存格的數字或日期格式。
getNumberFormats()String[][]傳回指定範圍內儲存格中的數字或日期格式。
getRichTextValue()RichTextValue傳回範圍左上角儲存格的富文字值,如果儲存格值不是文字,則傳回 null
getRichTextValues()RichTextValue[][]傳回指定範圍內儲存格中的 RTF 值。
getRow()Integer傳回此範圍的列位置。
getRowIndex()Integer傳回此範圍的列位置。
getSheet()Sheet傳回這個範圍所屬的工作表。
getTextDirection()TextDirection傳回指定範圍左上角儲存格的文字方向。
getTextDirections()TextDirection[][]傳回指定範圍內儲存格中的文字方向。
getTextRotation()TextRotation傳回指定範圍左上方儲存格的文字旋轉設定。
getTextRotations()TextRotation[][]傳回指定範圍內儲存格文字旋轉設定。
getTextStyle()TextStyle傳回指定範圍左上角儲存格的文字樣式。
getTextStyles()TextStyle[][]傳回指定範圍內儲存格文字樣式。
getValue()Object傳回範圍中左上方儲存格的值。
getValues()Object[][]傳回這個範圍的值矩形格線。
getVerticalAlignment()String傳回指定區間左上角儲存格垂直對齊方式 (頂端/中間/底部)。
getVerticalAlignments()String[][]傳回指定範圍內儲存格的垂直對齊方式。
getWidth()Integer傳回資料欄範圍的寬度。
getWrap()Boolean傳回儲存格中的文字是否會換行。
getWrapStrategies()WrapStrategy[][]傳回範圍內儲存格適用的文字斷行策略。
getWrapStrategy()WrapStrategy傳回指定範圍左上角儲存格的文字斷行策略。
getWraps()Boolean[][]傳回儲存格中的文字是否會換行。
insertCells(shiftDimension)Range在這個範圍內插入空白儲存格。
insertCheckboxes()Range在範圍內的每個儲存格中插入核取方塊,並以 true 代表已勾選,以 false 代表未勾選。
insertCheckboxes(checkedValue)Range在指定範圍內的每個儲存格中插入核取方塊,並設定勾選狀態為已勾選的自訂值,未勾選狀態為空字串。
insertCheckboxes(checkedValue, uncheckedValue)Range在範圍內的每個儲存格中插入核取方塊,並為已勾選和未勾選狀態設定自訂值。
isBlank()Boolean如果範圍完全空白,就會傳回 true
isChecked()Boolean傳回範圍內所有儲存格的核取方塊狀態是否為「已勾選」。
isEndColumnBounded()Boolean判斷範圍的結尾是否已繫結至特定欄。
isEndRowBounded()Boolean判斷範圍的結尾是否已繫結至特定資料列。
isPartOfMerge()Boolean如果目前範圍內的儲存格與任何合併儲存格重疊,就會傳回 true
isStartColumnBounded()Boolean判斷範圍的起始值是否已繫結至特定欄。
isStartRowBounded()Boolean判斷範圍的起始值是否已繫結至特定資料列。
merge()Range將範圍內的儲存格合併為單一區塊。
mergeAcross()Range合併範圍內的儲存格,跨越範圍內的資料欄。
mergeVertically()Range將範圍內的儲存格合併在一起。
moveTo(target)void將這個範圍的格式和值剪下,貼到目標範圍。
offset(rowOffset, columnOffset)Range傳回從這個範圍偏移指定的列數和欄數 (可能為負值) 的新範圍。
offset(rowOffset, columnOffset, numRows)Range傳回相對於目前範圍的新範圍,其左上角點會從目前範圍偏移指定的列數和欄數,且儲存格高度為指定的高度。
offset(rowOffset, columnOffset, numRows, numColumns)Range傳回相對於目前範圍的新範圍,其左上角點會從目前範圍偏移指定的列數和欄數,且儲存格具有指定的高度和寬度。
protect()Protection建立可保護範圍的物件,只有具備權限的使用者才能編輯該範圍。
randomize()Range將指定範圍內的資料列隨機排序。
removeCheckboxes()Range從指定範圍移除所有核取方塊。
removeDuplicates()Range移除此範圍內的資料列,如果其中的值與任何前一個資料列的重複值相同,就會遭到移除。
removeDuplicates(columnsToCompare)Range移除指定範圍內的資料列,這些資料列在指定欄中的值與任何先前資料列的值重複。
setBackground(color)Range使用 CSS 符號 (例如 '#ffffff''white') 設定指定範圍內所有儲存格的背景顏色。
setBackgroundObject(color)Range設定範圍內所有儲存格的背景顏色。
setBackgroundObjects(color)Range設定背景顏色的矩形格線 (必須符合此範圍的尺寸)。
setBackgroundRGB(red, green, blue)Range使用 RGB 值 (整數介於 0 和 255 之間) 將背景設為指定的顏色。
setBackgrounds(color)Range設定背景顏色的矩形格線 (必須符合此範圍的尺寸)。
setBorder(top, left, bottom, right, vertical, horizontal)Range設定邊框屬性。
setBorder(top, left, bottom, right, vertical, horizontal, color, style)Range使用顏色和/或樣式設定邊框屬性。
setDataValidation(rule)Range為範圍內的所有儲存格設定一個資料驗證規則。
setDataValidations(rules)Range為範圍內的所有儲存格設定資料驗證規則。
setFontColor(color)Range以 CSS 符號 (例如 '#ffffff''white') 設定字型顏色。
setFontColorObject(color)Range設定指定範圍的字型顏色。
setFontColorObjects(colors)Range設定矩形格狀的字型顏色 (必須符合此範圍的尺寸)。
setFontColors(colors)Range設定矩形格狀的字型顏色 (必須符合此範圍的尺寸)。
setFontFamilies(fontFamilies)Range設定字型系列的矩形格線 (必須符合此範圍的尺寸)。
setFontFamily(fontFamily)Range設定字型系列,例如「Arial」或「Helvetica」。
setFontLine(fontLine)Range設定指定範圍的字型線條樣式 ('underline''line-through''none')。
setFontLines(fontLines)Range設定線條樣式的矩形格線 (必須符合此範圍的尺寸)。
setFontSize(size)Range設定字型大小,大小為要使用的點大小。
setFontSizes(sizes)Range設定矩形格線的字型大小 (必須符合此範圍的尺寸)。
setFontStyle(fontStyle)Range為指定範圍 ('italic''normal') 設定字型樣式。
setFontStyles(fontStyles)Range設定矩形格狀的字型樣式 (必須符合此範圍的尺寸)。
setFontWeight(fontWeight)Range設定指定範圍的字型粗細 (一般/粗體)。
setFontWeights(fontWeights)Range設定字型粗細的矩形格線 (必須符合此範圍的尺寸)。
setFormula(formula)Range更新這個範圍的公式。
setFormulaR1C1(formula)Range更新這個範圍的公式。
setFormulas(formulas)Range設定公式的矩形格狀 (必須與此範圍的維度相符)。
setFormulasR1C1(formulas)Range設定公式的矩形格狀 (必須與此範圍的維度相符)。
setHorizontalAlignment(alignment)Range為指定範圍 (左/置中/右) 設定水平 (由左至右) 對齊方式。
setHorizontalAlignments(alignments)Range設定水平對齊的矩形格線。
setNote(note)Range將附註設為指定的值。
setNotes(notes)Range設定矩形的筆記格狀 (必須符合此範圍的尺寸)。
setNumberFormat(numberFormat)Range將數字或日期格式設為指定的格式字串。
setNumberFormats(numberFormats)Range設定數字或日期格式的矩形格狀 (必須與此範圍的維度相符)。
setRichTextValue(value)Range為範圍內的儲存格設定 RTF 格式值。
setRichTextValues(values)Range設定 RTF 格式值的矩形格線。
setShowHyperlink(showHyperlink)Range設定範圍是否應顯示超連結。
setTextDirection(direction)Range設定指定範圍內的儲存格文字方向。
setTextDirections(directions)Range設定文字方向的矩形網格。
setTextRotation(degrees)Range為指定範圍中的儲存格設定文字旋轉設定。
setTextRotation(rotation)Range為指定範圍中的儲存格設定文字旋轉角度。
setTextRotations(rotations)Range設定文字旋轉的矩形格線。
setTextStyle(style)Range為範圍內的儲存格設定文字樣式。
setTextStyles(styles)Range設定文字樣式的矩形格線。
setValue(value)Range設定範圍的值。
setValues(values)Range設定矩形值格狀圖 (必須符合此範圍的維度)。
setVerticalAlignment(alignment)Range為指定範圍 (頂端/中間/底部) 設定垂直 (由上至下) 對齊方式。
setVerticalAlignments(alignments)Range設定垂直對齊的矩形格線 (必須符合此範圍的尺寸)。
setVerticalText(isVertical)Range設定是否要為範圍內的儲存格堆疊文字。
setWrap(isWrapEnabled)Range設定指定範圍的單元格換行。
setWrapStrategies(strategies)Range設定矩形網格包覆策略。
setWrapStrategy(strategy)Range為指定範圍內的儲存格設定文字斷行策略。
setWraps(isWrapEnabled)Range設定文字斷行政策的矩形格線 (必須符合此範圍的尺寸)。
shiftColumnGroupDepth(delta)Range以指定幅度變更範圍的欄群組深度。
shiftRowGroupDepth(delta)Range以指定幅度變更範圍的列分組深度。
sort(sortSpecObj)Range依指定的資料欄和順序,排序指定範圍內的儲存格。
splitTextToColumns()void根據自動偵測的分隔符號,將一欄文字分割為多個資料欄。
splitTextToColumns(delimiter)void使用指定的字串做為自訂分隔符號,將一欄文字分割為多個資料欄。
splitTextToColumns(delimiter)void根據指定的分隔符號,將一欄文字分割為多個資料欄。
trimWhitespace()Range會修剪指定範圍內每個儲存格中的空白字元 (例如空格、Tab 或換行符號)。
uncheck()Range將指定範圍內的核取方塊狀態變更為「未勾選」。

RangeList

方法

方法傳回類型簡短說明
activate()RangeList選取 Range 例項清單。
breakApart()RangeList將範圍清單中所有水平或垂直合併的儲存格,再次分割為個別儲存格。
check()RangeList將範圍內的核取方塊狀態變更為「已勾選」。
clear()RangeList清除範圍清單中每個 Range 的內容範圍、格式和資料驗證規則。
clear(options)RangeList清除指定選項指定的內容範圍、格式、資料驗證規則和註解。
clearContent()RangeList清除範圍清單中每個 Range 的內容,但格式保持不變。
clearDataValidations()RangeList清除指定範圍清單中每個 Range 的資料驗證規則。
clearFormat()RangeList清除指定範圍清單中每個 Range 的文字格式。
clearNote()RangeList清除範圍清單中每個 Range 的附註。
getRanges()Range[]傳回同一個工作表中一或多個 Range 例項的清單。
insertCheckboxes()RangeList在範圍內的每個儲存格中插入核取方塊,並以 true 代表已勾選,以 false 代表未勾選。
insertCheckboxes(checkedValue)RangeList在指定範圍內的每個儲存格中插入核取方塊,並設定勾選狀態為已勾選的自訂值,未勾選狀態為空字串。
insertCheckboxes(checkedValue, uncheckedValue)RangeList在範圍內的每個儲存格中插入核取方塊,並為已勾選和未勾選狀態設定自訂值。
removeCheckboxes()RangeList從指定範圍移除所有核取方塊。
setBackground(color)RangeList設定範圍清單中每個 Range 的背景顏色。
setBackgroundRGB(red, green, blue)RangeList將背景設為指定的 RGB 顏色。
setBorder(top, left, bottom, right, vertical, horizontal)RangeList為範圍清單中的每個 Range 設定邊框屬性。
setBorder(top, left, bottom, right, vertical, horizontal, color, style)RangeList為範圍清單中的每個 Range 設定邊框屬性,包括顏色和/或樣式。
setFontColor(color)RangeList設定範圍清單中每個 Range 的字型顏色。
setFontFamily(fontFamily)RangeList設定範圍清單中每個 Range 的字型系列。
setFontLine(fontLine)RangeList設定範圍清單中每個 Range 的字型線條樣式。
setFontSize(size)RangeList設定範圍清單中每個 Range 的字型大小 (以點為單位)。
setFontStyle(fontStyle)RangeList設定範圍清單中每個 Range 的字型樣式。
setFontWeight(fontWeight)RangeList為範圍清單中的每個 Range 設定字型粗細。
setFormula(formula)RangeList更新範圍清單中每個 Range 的公式。
setFormulaR1C1(formula)RangeList更新範圍清單中每個 Range 的公式。
setHorizontalAlignment(alignment)RangeList設定範圍清單中每個 Range 的水平對齊方式。
setNote(note)RangeList設定範圍清單中每個 Range 的註解文字。
setNumberFormat(numberFormat)RangeList為範圍清單中的每個 Range 設定數字或日期格式。
setShowHyperlink(showHyperlink)RangeList設定範圍清單中的每個 Range 是否應顯示超連結。
setTextDirection(direction)RangeList設定範圍清單中每個 Range 中儲存格文字的方向。
setTextRotation(degrees)RangeList為範圍清單中每個 Range 中的儲存格設定文字旋轉設定。
setValue(value)RangeList設定範圍清單中每個 Range 的值。
setVerticalAlignment(alignment)RangeList設定範圍清單中每個 Range 的垂直對齊方式。
setVerticalText(isVertical)RangeList設定是否要為範圍清單中的每個 Range 的儲存格堆疊文字。
setWrap(isWrapEnabled)RangeList為範圍清單中的每個 Range 設定文字斷行。
setWrapStrategy(strategy)RangeList為範圍清單中的每個 Range 設定文字斷行策略。
trimWhitespace()RangeList這個範圍清單中的每個儲存格都會去除空白字元 (例如空格、tab 或換行符號)。
uncheck()RangeList將指定範圍內的核取方塊狀態變更為「未勾選」。

RecalculationInterval

屬性

屬性類型說明
ON_CHANGEEnum僅在值變更時重新計算。
MINUTEEnum在值有變動時和每分鐘重新計算。
HOUREnum在值變更時和每小時重新計算。

RelativeDate

屬性

屬性類型說明
TODAYEnum與目前日期比較的日期。
TOMORROWEnum與目前日期後的日期進行比較的日期。
YESTERDAYEnum與目前日期之前的日期進行比較的日期。
PAST_WEEKEnum過去一週內的日期。
PAST_MONTHEnum過去一個月內的日期。
PAST_YEAREnum過去一年內的日期。

RichTextValue

方法

方法傳回類型簡短說明
copy()RichTextValueBuilder傳回 RTF 格式值的建構工具,該值會使用此 RTF 格式值的值進行初始化。
getEndIndex()Integer取得儲存格中此值的結尾索引。
getLinkUrl()String傳回這個值的連結網址。
getLinkUrl(startOffset, endOffset)String傳回文字的連結網址,從 startOffsetendOffset
getRuns()RichTextValue[]傳回已分割成陣列的富文字字串,其中每個子序列都是具有一致文字樣式的最長子字串。
getStartIndex()Integer取得儲存格中這個值的起始索引。
getText()String傳回這個值的文字。
getTextStyle()TextStyle傳回此值的文字樣式。
getTextStyle(startOffset, endOffset)TextStyle傳回文字的文字樣式,從 startOffset 變更為 endOffset

RichTextValueBuilder

方法

方法傳回類型簡短說明
build()RichTextValue使用這個建構工具建立富文字格式值。
setLinkUrl(startOffset, endOffset, linkUrl)RichTextValueBuilder為這個值的指定子字串設定連結網址,如果 linkUrlnull,則會清除。
setLinkUrl(linkUrl)RichTextValueBuilder為整個值設定連結網址,如果 linkUrlnull,則會清除連結網址。
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)Rangecurrent cellactive range 開始,並朝指定方向移動,傳回經過調整的範圍,其中範圍的適當邊緣已移至涵蓋 next data cell,同時仍涵蓋目前的儲存格。

Sheet

方法

方法傳回類型簡短說明
activate()Sheet啟用這個工作表。
addDeveloperMetadata(key)Sheet將含有指定鍵的開發人員中繼資料新增至工作表。
addDeveloperMetadata(key, visibility)Sheet將含有指定鍵和瀏覽權限的開發人員中繼資料新增至工作表。
addDeveloperMetadata(key, value)Sheet將開發人員中繼資料和指定的鍵/值新增至工作表。
addDeveloperMetadata(key, value, visibility)Sheet將含有指定鍵、值和瀏覽權限的開發人員中繼資料新增至工作表。
appendRow(rowContents)Sheet將資料列附加至工作表中目前資料區域的底部。
asDataSourceSheet()DataSourceSheet如果工作表的類型為 SheetType.DATASOURCE,則會傳回工作表為 DataSourceSheet;否則會傳回 null
autoResizeColumn(columnPosition)Sheet將指定欄的寬度設為適合其內容的寬度。
autoResizeColumns(startColumn, numColumns)Sheet設定從指定資料欄位置開始的所有資料欄寬度,以便容納內容。
autoResizeRows(startRow, numRows)Sheet設定從指定列位置開始的所有列高度,以便容納內容。
clear()Sheet清除工作表的內容和格式資訊。
clear(options)Sheet清除工作表的內容和/或格式,如指定的進階選項所述。
clearConditionalFormatRules()void從工作表中移除所有條件式格式規則。
clearContents()Sheet清除工作表內容,但保留格式資訊。
clearFormats()Sheet清除工作表的格式設定,但保留內容。
clearNotes()Sheet清除所有筆記的工作表。
collapseAllColumnGroups()Sheet收合工作表中的所有欄群組。
collapseAllRowGroups()Sheet收合工作表中的所有列群組。
copyTo(spreadsheet)Sheet將工作表複製到指定的試算表,該試算表可以是來源試算表。
createDeveloperMetadataFinder()DeveloperMetadataFinder傳回 DeveloperMetadataFinder,用於在這個工作表的範圍內尋找開發人員中繼資料。
createTextFinder(findText)TextFinder為工作表建立文字搜尋器,可在工作表中尋找及取代文字。
deleteColumn(columnPosition)Sheet刪除指定欄位置的資料欄。
deleteColumns(columnPosition, howMany)void從指定的欄位開始,刪除多個欄。
deleteRow(rowPosition)Sheet刪除指定資料列位置的資料列。
deleteRows(rowPosition, howMany)void從指定的資料列位置開始,刪除多個資料列。
expandAllColumnGroups()Sheet展開工作表中的所有欄群組。
expandAllRowGroups()Sheet展開工作表中的所有列群組。
expandColumnGroupsUpToDepth(groupDepth)Sheet展開指定深度的所有欄群組,並收合其他所有欄群組。
expandRowGroupsUpToDepth(groupDepth)Sheet展開所有列群組至指定深度,並摺疊所有其他列群組。
getActiveCell()Range傳回這個工作表中目前的儲存格。
getActiveRange()Range傳回有效工作表中的選取範圍,如果沒有有效範圍,則傳回 null
getActiveRangeList()RangeList傳回有效工作表中有效範圍的清單,如果沒有有效範圍,則傳回 null
getBandings()Banding[]傳回這個工作表中的所有分割線。
getCharts()EmbeddedChart[]傳回這個工作表上的圖表陣列。
getColumnGroup(columnIndex, groupDepth)Group傳回指定索引和群組深度的欄群組。
getColumnGroupControlPosition()GroupControlTogglePosition傳回工作表上所有欄群組的 GroupControlTogglePosition
getColumnGroupDepth(columnIndex)Integer傳回指定索引的資料欄群組深度。
getColumnWidth(columnPosition)Integer取得指定欄的寬度 (以像素為單位)。
getConditionalFormatRules()ConditionalFormatRule[]取得這個試算表中的所有條件式格式規則。
getCurrentCell()Range傳回目前工作表中的目前儲存格,如果沒有目前儲存格,則傳回 null
getDataRange()Range傳回與資料所在維度相對應的 Range
getDataSourceFormulas()DataSourceFormula[]取得所有資料來源公式。
getDataSourcePivotTables()DataSourcePivotTable[]取得所有資料來源資料透視表。
getDataSourceTables()DataSourceTable[]取得所有資料來源資料表。
getDeveloperMetadata()DeveloperMetadata[]取得與這份試算表相關的所有開發人員中繼資料。
getDrawings()Drawing[]傳回工作表上的圖表陣列。
getFilter()Filter傳回這個工作表中的篩選器,如果沒有篩選器,則傳回 null
getFormUrl()String傳回表單的網址,該表單會將回覆傳送至此工作表;如果此工作表沒有關聯表單,則傳回 null
getFrozenColumns()Integer傳回已凍結欄的數量。
getFrozenRows()Integer傳回已凍結的資料列數。
getImages()OverGridImage[]傳回工作表上所有格線外的圖片。
getIndex()Integer取得工作表在其上層試算表中的位置。
getLastColumn()Integer傳回最後一列的內容位置。
getLastRow()Integer傳回含有內容的最後一列位置。
getMaxColumns()Integer傳回工作表中目前的欄數,不論內容為何。
getMaxRows()Integer傳回工作表中目前的列數,不論內容為何。
getName()String傳回工作表名稱。
getNamedRanges()NamedRange[]取得此工作表中的所有已命名範圍。
getParent()Spreadsheet傳回包含此試算表的 Spreadsheet
getPivotTables()PivotTable[]傳回這個工作表上的所有資料透視表。
getProtections(type)Protection[]取得代表工作表中所有受保護範圍的物件陣列,或是代表工作表本身保護狀態的單一元素陣列。
getRange(row, column)Range傳回指定座標左上角儲存格的範圍。
getRange(row, column, numRows)Range傳回範圍,其中左上角儲存格位於指定座標,且有指定的列數。
getRange(row, column, numRows, numColumns)Range傳回範圍,其中左上角儲存格位於指定座標,並具有指定的列數和欄數。
getRange(a1Notation)Range傳回 A1 或 R1C1 符號指定的範圍。
getRangeList(a1Notations)RangeList傳回 RangeList 集合,代表由非空白的 A1 符號或 R1C1 符號指定的同一工作表中的範圍。
getRowGroup(rowIndex, groupDepth)Group傳回指定索引和群組深度的列群組。
getRowGroupControlPosition()GroupControlTogglePosition傳回工作表中所有列群組的 GroupControlTogglePosition
getRowGroupDepth(rowIndex)Integer傳回指定索引的資料列群組深度。
getRowHeight(rowPosition)Integer取得指定資料列的高度 (以像素為單位)。
getSelection()Selection傳回試算表中目前的 Selection
getSheetId()Integer傳回此物件所代表的工作表 ID。
getSheetName()String傳回工作表名稱。
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]傳回這個範圍的矩形格狀值,從指定座標開始。
getSlicers()Slicer[]傳回工作表上的切片器陣列。
getTabColorObject()Color取得工作表分頁的顏色,如果工作表分頁沒有顏色,則會取得 null
getType()SheetType傳回工作表的類型。
hasHiddenGridlines()Boolean如果工作表的格線處於隱藏狀態,就會傳回 true;否則會傳回 false
hideColumn(column)void隱藏指定範圍內的資料欄。
hideColumns(columnIndex)void隱藏指定索引的單一資料欄。
hideColumns(columnIndex, numColumns)void隱藏從指定索引開始的一或多個連續資料欄。
hideRow(row)void隱藏指定範圍內的資料列。
hideRows(rowIndex)void隱藏指定索引的資料列。
hideRows(rowIndex, numRows)void隱藏從指定索引開始的一或多個連續資料列。
hideSheet()Sheet隱藏這個工作表。
insertChart(chart)void在這個工作表中新增圖表。
insertColumnAfter(afterPosition)Sheet在指定的資料欄位置後插入資料欄。
insertColumnBefore(beforePosition)Sheet在指定的資料欄位置前插入資料欄。
insertColumns(columnIndex)void在工作表中指定位置插入空白資料欄。
insertColumns(columnIndex, numColumns)void在工作表中從指定位置開始,插入一或多個連續的空白欄。
insertColumnsAfter(afterPosition, howMany)Sheet在指定的資料欄位置後方插入指定數量的資料欄。
insertColumnsBefore(beforePosition, howMany)Sheet在指定的資料欄位置前插入多個資料欄。
insertImage(blobSource, column, row)OverGridImage在指定的資料列和欄中,將 BlobSource 插入文件中做為圖片。
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImage在指定的資料列和資料欄中,以圖片形式插入 BlobSource,並加上像素偏移。
insertImage(url, column, row)OverGridImage在文件中插入圖片,位置為指定的列和欄。
insertImage(url, column, row, offsetX, offsetY)OverGridImage在文件中插入圖片,並指定圖片的列和欄以及像素偏移量。
insertRowAfter(afterPosition)Sheet在指定的資料列位置後插入資料列。
insertRowBefore(beforePosition)Sheet在指定的資料列位置前插入資料列。
insertRows(rowIndex)void在工作表中指定位置插入空白資料列。
insertRows(rowIndex, numRows)void在工作表中插入一或多個連續空白資料列,從指定位置開始。
insertRowsAfter(afterPosition, howMany)Sheet在指定的資料列位置後插入多個資料列。
insertRowsBefore(beforePosition, howMany)Sheet在指定的資料列位置前插入多個資料列。
insertSlicer(range, anchorRowPos, anchorColPos)Slicer在這個工作表中新增切片器。
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)Slicer在這個工作表中新增切片器。
isColumnHiddenByUser(columnPosition)Boolean傳回使用者是否隱藏指定資料欄。
isRightToLeft()Boolean如果這個工作表版面配置是從右至左,則會傳回 true
isRowHiddenByFilter(rowPosition)Boolean傳回指定資料列是否遭到篩選器 (而非篩選器檢視畫面) 隱藏。
isRowHiddenByUser(rowPosition)Boolean傳回使用者是否隱藏指定資料列。
isSheetHidden()Boolean如果工作表目前處於隱藏狀態,則會傳回 true
moveColumns(columnSpec, destinationIndex)void將指定範圍所選取的資料欄移至 destinationIndex 所指示的位置。
moveRows(rowSpec, destinationIndex)void將指定範圍所選取的資料列移至 destinationIndex 所指示的位置。
newChart()EmbeddedChartBuilder傳回建構工具,用於為這個工作表建立新的圖表。
protect()Protection建立可保護試算表的物件,只有擁有權限的使用者才能編輯。
removeChart(chart)void從上層工作表移除圖表。
setActiveRange(range)Range將指定的範圍設為有效工作表中的 active range,範圍內左上角的儲存格為 current cell
setActiveRangeList(rangeList)RangeList將指定的範圍清單設為作用中工作表中的 active ranges
setActiveSelection(range)Range設定此工作表的有效選取區域。
setActiveSelection(a1Notation)Range根據 A1 或 R1C1 符號指定,設定有效的選取範圍。
setColumnGroupControlPosition(position)Sheet設定工作表上欄群組控制切換鈕的位置。
setColumnWidth(columnPosition, width)Sheet以像素為單位,設定指定欄的寬度。
setColumnWidths(startColumn, numColumns, width)Sheet以像素為單位,設定指定欄的寬度。
setConditionalFormatRules(rules)void將工作表中目前所有現有的條件式格式規則,替換為輸入的規則。
setCurrentCell(cell)Range將指定的儲存格設為 current cell
setFrozenColumns(columns)void凍結指定數量的資料欄。
setFrozenRows(rows)void凍結指定的資料列數。
setHiddenGridlines(hideGridlines)Sheet隱藏或顯示工作表格線。
setName(name)Sheet設定工作表名稱。
setRightToLeft(rightToLeft)Sheet將工作表版面配置設為由右至左或取消設定。
setRowGroupControlPosition(position)Sheet設定工作表上列群組控制切換鈕的位置。
setRowHeight(rowPosition, height)Sheet以像素為單位,設定指定資料列的行高。
setRowHeights(startRow, numRows, height)Sheet以像素為單位,設定指定列的高度。
setRowHeightsForced(startRow, numRows, height)Sheet以像素為單位,設定指定列的高度。
setTabColor(color)Sheet設定工作表分頁的顏色。
setTabColorObject(color)Sheet設定工作表分頁的顏色。
showColumns(columnIndex)void取消隱藏指定索引的資料欄。
showColumns(columnIndex, numColumns)void從指定索引開始,取消隱藏一或多個連續資料欄。
showRows(rowIndex)void取消隱藏指定索引的資料列。
showRows(rowIndex, numRows)void從指定索引開始,取消隱藏一或多個連續資料列。
showSheet()Sheet讓工作表顯示。
sort(columnPosition)Sheet依欄遞增排序工作表。
sort(columnPosition, ascending)Sheet依欄排序工作表。
unhideColumn(column)void取消隱藏指定範圍內的資料欄。
unhideRow(row)void取消隱藏指定範圍中的資料列。
updateChart(chart)void更新這個工作表上的圖表。

SheetType

屬性

屬性類型說明
GRIDEnum包含格線的工作表。
OBJECTEnum包含單一嵌入物件 (例如 EmbeddedChart) 的工作表。
DATASOURCEEnum包含 DataSource 的工作表。

Slicer

方法

方法傳回類型簡短說明
getBackgroundColorObject()Color傳回切割器的背景 Color
getColumnPosition()Integer傳回在切片器中套用篩選器的資料欄位置 (相對於切片器的資料範圍),如果未設定資料欄位置,則傳回 null
getContainerInfo()ContainerInfo取得切片器在工作表中的位置資訊。
getFilterCriteria()FilterCriteria傳回切片器的篩選條件,如果未設定篩選條件,則傳回 null
getRange()Range取得切片器套用的資料範圍。
getTitle()String傳回切割器的標題。
getTitleHorizontalAlignment()String取得標題的水平對齊方式。
getTitleTextStyle()TextStyle傳回切片器標題的文字樣式。
isAppliedToPivotTables()Boolean傳回指定切片器是否套用至資料透視表。
remove()void刪除篩選器。
setApplyToPivotTables(applyToPivotTables)Slicer設定是否要將指定的篩選器套用至工作表中的資料透視表。
setBackgroundColor(color)Slicer設定切片器的背景顏色。
setBackgroundColorObject(color)Slicer設定切割器的背景 Color
setColumnFilterCriteria(columnPosition, filterCriteria)Slicer設定切片器的資料欄索引和篩選條件。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)Slicer設定切片器在工作表上顯示的位置。
setRange(rangeApi)Slicer設定要套用切片器的資料範圍。
setTitle(title)Slicer設定切片器的標題。
setTitleHorizontalAlignment(horizontalAlignment)Slicer設定切片器中標題的水平對齊方式。
setTitleTextStyle(textStyle)Slicer設定切片器的文字樣式。

SortOrder

屬性

屬性類型說明
ASCENDINGEnum遞增排序。
DESCENDINGEnum遞減排序順序。

SortSpec

方法

方法傳回類型簡短說明
getBackgroundColor()Color會傳回用於排序的背景顏色,如果沒有則會傳回 null
getDataSourceColumn()DataSourceColumn取得排序規格作用的資料來源欄。
getDimensionIndex()Integer傳回維度索引,如果未連結至本機篩選器,則會傳回 null
getForegroundColor()Color傳回用於排序的前景色,如果沒有,則傳回 null
getSortOrder()SortOrder傳回排序順序。
isAscending()Boolean傳回排序順序是否為遞增。

Spreadsheet

方法

方法傳回類型簡短說明
addDeveloperMetadata(key)Spreadsheet將含有指定鍵的開發人員中繼資料新增至頂層試算表。
addDeveloperMetadata(key, visibility)Spreadsheet將開發人員中繼資料加入試算表,並指定鍵和瀏覽權限。
addDeveloperMetadata(key, value)Spreadsheet將開發人員中繼資料 (含指定鍵和值) 新增至試算表。
addDeveloperMetadata(key, value, visibility)Spreadsheet在試算表中新增開發人員中繼資料,並指定鍵、值和瀏覽權限。
addEditor(emailAddress)Spreadsheet將指定使用者新增至 Spreadsheet 的編輯者清單。
addEditor(user)Spreadsheet將指定使用者新增至 Spreadsheet 的編輯者清單。
addEditors(emailAddresses)Spreadsheet將指定的使用者陣列新增至 Spreadsheet 的編輯者清單。
addMenu(name, subMenus)void在試算表 UI 中建立新選單。
addViewer(emailAddress)Spreadsheet將指定使用者新增至 Spreadsheet 的觀眾名單。
addViewer(user)Spreadsheet將指定使用者新增至 Spreadsheet 的觀眾名單。
addViewers(emailAddresses)Spreadsheet將指定的使用者陣列新增至 Spreadsheet 的觀眾清單。
appendRow(rowContents)Sheet將資料列附加至工作表中目前資料區域的底部。
autoResizeColumn(columnPosition)Sheet將指定欄的寬度設為適合其內容的寬度。
copy(name)Spreadsheet複製試算表並傳回新試算表。
createDeveloperMetadataFinder()DeveloperMetadataFinder傳回 DeveloperMetadataFinder,用於在這個試算表的範圍內尋找開發人員中繼資料。
createTextFinder(findText)TextFinder為試算表建立文字尋找器,可用於尋找並取代試算表中的文字。
deleteActiveSheet()Sheet刪除目前的活頁。
deleteColumn(columnPosition)Sheet刪除指定欄位置的資料欄。
deleteColumns(columnPosition, howMany)void從指定的欄位開始,刪除多個欄。
deleteRow(rowPosition)Sheet刪除指定資料列位置的資料列。
deleteRows(rowPosition, howMany)void從指定的資料列位置開始,刪除多個資料列。
deleteSheet(sheet)void刪除指定的工作表。
duplicateActiveSheet()Sheet複製使用中的試算表,並將其設為使用中的試算表。
getActiveCell()Range傳回這個工作表中目前的儲存格。
getActiveRange()Range傳回有效工作表中的選取範圍,如果沒有有效範圍,則傳回 null
getActiveRangeList()RangeList傳回有效工作表中有效範圍的清單,如果沒有有效範圍,則傳回 null
getActiveSheet()Sheet取得試算表中的活動工作表。
getAs(contentType)Blob將此物件內的資料傳回為轉換為指定內容類型的 Blob。
getBandings()Banding[]傳回此試算表中的所有頻帶。
getBlob()Blob將此物件內的資料以 blob 格式傳回。
getColumnWidth(columnPosition)Integer取得指定欄的寬度 (以像素為單位)。
getCurrentCell()Range傳回目前工作表中的目前儲存格,如果沒有目前儲存格,則傳回 null
getDataRange()Range傳回與資料所在維度相對應的 Range
getDataSourceFormulas()DataSourceFormula[]取得所有資料來源公式。
getDataSourcePivotTables()DataSourcePivotTable[]取得所有資料來源資料透視表。
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]取得此試算表的重新整理時間表。
getDataSourceSheets()DataSourceSheet[]傳回試算表中的所有資料來源工作表。
getDataSourceTables()DataSourceTable[]取得所有資料來源資料表。
getDataSources()DataSource[]傳回試算表中的所有資料來源。
getDeveloperMetadata()DeveloperMetadata[]取得與頂層試算表相關聯的開發人員中繼資料。
getEditors()User[]取得這個 Spreadsheet 的編輯者清單。
getFormUrl()String傳回表單的網址,該表單會將回覆傳送至此試算表;如果此試算表沒有關聯表單,則傳回 null
getFrozenColumns()Integer傳回已凍結欄的數量。
getFrozenRows()Integer傳回已凍結的資料列數。
getId()String取得這個試算表的專屬 ID。
getImages()OverGridImage[]傳回工作表上所有格線外的圖片。
getIterativeCalculationConvergenceThreshold()Number傳回迭代計算期間使用的閾值。
getLastColumn()Integer傳回最後一列的內容位置。
getLastRow()Integer傳回含有內容的最後一列位置。
getMaxIterativeCalculationCycles()Integer傳回在疊代計算期間要使用的疊代次數上限。
getName()String取得文件名稱。
getNamedRanges()NamedRange[]取得這份試算表中的所有已命名範圍。
getNumSheets()Integer傳回這個試算表中的工作表數量。
getOwner()User傳回文件的擁有者,或共用雲端硬碟中文件的 null
getPredefinedSpreadsheetThemes()SpreadsheetTheme[]傳回預先定義主題的清單。
getProtections(type)Protection[]取得代表試算表中所有受保護範圍或工作表的物件陣列。
getRange(a1Notation)Range傳回 A1 或 R1C1 符號指定的範圍。
getRangeByName(name)Range傳回命名範圍,如果找不到具有指定名稱的範圍,則傳回 null
getRangeList(a1Notations)RangeList傳回 RangeList 集合,代表由非空白的 A1 符號或 R1C1 符號指定的同一工作表中的範圍。
getRecalculationInterval()RecalculationInterval傳回此試算表的計算間隔。
getRowHeight(rowPosition)Integer取得指定資料列的高度 (以像素為單位)。
getSelection()Selection傳回試算表中目前的 Selection
getSheetById(id)Sheet取得 ID 為指定值的工作表。
getSheetByName(name)Sheet傳回具有指定名稱的工作表。
getSheetId()Integer傳回此物件所代表的工作表 ID。
getSheetName()String傳回工作表名稱。
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]傳回這個範圍的矩形格狀值,從指定座標開始。
getSheets()Sheet[]取得此試算表中的所有工作表。
getSpreadsheetLocale()String取得試算表語言代碼。
getSpreadsheetTheme()SpreadsheetTheme傳回試算表目前的主題,如果未套用主題,則傳回 null
getSpreadsheetTimeZone()String取得試算表的時區。
getUrl()String傳回指定試算表的網址。
getViewers()User[]取得這個 Spreadsheet 的檢視者和加註者清單。
hideColumn(column)void隱藏指定範圍內的資料欄。
hideRow(row)void隱藏指定範圍內的資料列。
insertColumnAfter(afterPosition)Sheet在指定的資料欄位置後插入資料欄。
insertColumnBefore(beforePosition)Sheet在指定的資料欄位置前插入資料欄。
insertColumnsAfter(afterPosition, howMany)Sheet在指定的資料欄位置後方插入指定數量的資料欄。
insertColumnsBefore(beforePosition, howMany)Sheet在指定的資料欄位置前插入多個資料欄。
insertDataSourceSheet(spec)DataSourceSheet在試算表中插入新的 DataSourceSheet,並開始執行資料。
insertImage(blobSource, column, row)OverGridImage在指定的資料列和欄中,將 Spreadsheet 插入文件中做為圖片。
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImage在指定的資料列和資料欄中,以圖片形式插入 Spreadsheet,並加上像素偏移。
insertImage(url, column, row)OverGridImage在文件中插入圖片,位置為指定的列和欄。
insertImage(url, column, row, offsetX, offsetY)OverGridImage在文件中插入圖片,並指定圖片的列和欄以及像素偏移量。
insertRowAfter(afterPosition)Sheet在指定的資料列位置後插入資料列。
insertRowBefore(beforePosition)Sheet在指定的資料列位置前插入資料列。
insertRowsAfter(afterPosition, howMany)Sheet在指定的資料列位置後插入多個資料列。
insertRowsBefore(beforePosition, howMany)Sheet在指定的資料列位置前插入多個資料列。
insertSheet()Sheet使用預設工作表名稱,在試算表中插入新的工作表。
insertSheet(sheetIndex)Sheet在指定索引處,將新工作表插入試算表中。
insertSheet(sheetIndex, options)Sheet在指定索引處,將新工作表插入試算表中,並使用選用的進階引數。
insertSheet(options)Sheet使用預設工作表名稱和選用的進階引數,在試算表中插入新的工作表。
insertSheet(sheetName)Sheet在試算表中插入指定名稱的新工作表。
insertSheet(sheetName, sheetIndex)Sheet在指定索引中,將新工作表插入試算表中,並指定名稱。
insertSheet(sheetName, sheetIndex, options)Sheet在指定索引處,將新工作表插入試算表中,並使用選用的進階引數。
insertSheet(sheetName, options)Sheet在試算表中插入新工作表,並使用指定名稱和選用的進階引數。
insertSheetWithDataSourceTable(spec)Sheet在試算表中插入新工作表,使用指定的資料來源規格建立跨越整個試算表的 DataSourceTable,並開始執行資料。
isColumnHiddenByUser(columnPosition)Boolean傳回使用者是否隱藏指定資料欄。
isIterativeCalculationEnabled()Boolean傳回這個試算表中是否啟用反覆運算功能。
isRowHiddenByFilter(rowPosition)Boolean傳回指定資料列是否遭到篩選器 (而非篩選器檢視畫面) 隱藏。
isRowHiddenByUser(rowPosition)Boolean傳回使用者是否隱藏指定資料列。
moveActiveSheet(pos)void將目前的活頁移至工作表清單中的指定位置。
moveChartToObjectSheet(chart)Sheet建立新的 SheetType.OBJECT 工作表,並將提供的圖表移至該工作表。
refreshAllDataSources()void重新整理所有支援的資料來源及其連結的資料來源物件,並略過無效的資料來源物件。
removeEditor(emailAddress)Spreadsheet將指定使用者從 Spreadsheet 的編輯者清單中移除。
removeEditor(user)Spreadsheet將指定使用者從 Spreadsheet 的編輯者清單中移除。
removeMenu(name)void移除 addMenu(name, subMenus) 新增的選單。
removeNamedRange(name)void刪除具有指定名稱的已命名範圍。
removeViewer(emailAddress)Spreadsheet將指定使用者從 Spreadsheet 的觀眾和留言者名單中移除。
removeViewer(user)Spreadsheet將指定使用者從 Spreadsheet 的觀眾和留言者名單中移除。
rename(newName)void重新命名文件。
renameActiveSheet(newName)void將目前的活動工作表重新命名為指定的新名稱。
resetSpreadsheetTheme()SpreadsheetTheme移除已套用的主題,並在試算表中設定預設主題。
setActiveRange(range)Range將指定的範圍設為有效工作表中的 active range,範圍內左上角的儲存格為 current cell
setActiveRangeList(rangeList)RangeList將指定的範圍清單設為作用中工作表中的 active ranges
setActiveSelection(range)Range設定此工作表的有效選取區域。
setActiveSelection(a1Notation)Range根據 A1 或 R1C1 符號指定,設定有效的選取範圍。
setActiveSheet(sheet)Sheet將指定的工作表設為試算表中的有效工作表。
setActiveSheet(sheet, restoreSelection)Sheet將指定的工作表設為試算表中的有效工作表,並提供選項,可還原該工作表中最近的選取項目。
setColumnWidth(columnPosition, width)Sheet以像素為單位,設定指定欄的寬度。
setCurrentCell(cell)Range將指定的儲存格設為 current cell
setFrozenColumns(columns)void凍結指定數量的資料欄。
setFrozenRows(rows)void凍結指定的資料列數。
setIterativeCalculationConvergenceThreshold(minThreshold)Spreadsheet設定迭代計算的最低門檻值。
setIterativeCalculationEnabled(isEnabled)Spreadsheet設定是否在試算表中啟用反覆運算。
setMaxIterativeCalculationCycles(maxIterations)Spreadsheet設定在疊代計算期間應執行的計算疊代次數上限。
setNamedRange(name, range)void為範圍命名。
setRecalculationInterval(recalculationInterval)Spreadsheet設定這個試算表的重新計算頻率。
setRowHeight(rowPosition, height)Sheet以像素為單位,設定指定資料列的行高。
setSpreadsheetLocale(locale)void設定試算表語言代碼。
setSpreadsheetTheme(theme)SpreadsheetTheme設定試算表的主題。
setSpreadsheetTimeZone(timezone)void設定試算表的時區。
show(userInterface)void在使用者瀏覽器的檢視區中,以對稱方式在對話方塊中顯示自訂使用者介面元件。
sort(columnPosition)Sheet依欄遞增排序工作表。
sort(columnPosition, ascending)Sheet依欄排序工作表。
toast(msg)void在試算表的右下角顯示彈出式視窗,並顯示指定的訊息。
toast(msg, title)void在試算表的右下角顯示彈出式視窗,內含指定的訊息和標題。
toast(msg, title, timeoutSeconds)void在試算表的右下角顯示彈出式視窗,其中顯示指定的標題和訊息,並維持顯示一段時間。
unhideColumn(column)void取消隱藏指定範圍內的資料欄。
unhideRow(row)void取消隱藏指定範圍中的資料列。
updateMenu(name, subMenus)void更新由 addMenu(name, subMenus) 新增的選單。
waitForAllDataExecutionsCompletion(timeoutInSeconds)void等待試算表中所有目前執行作業完成,並在指定秒數後逾時。

SpreadsheetApp

屬性

屬性類型說明
AutoFillSeriesAutoFillSeries用於計算自動填入值的序列類型列舉。
BandingThemeBandingTheme列舉可能的頻帶主題。
BooleanCriteriaBooleanCriteria條件式格式設定布林值條件的列舉。
BorderStyleBorderStyle列舉 Range 上設定邊框的有效樣式。
ColorTypeColorType列舉可能的顏色類型。
CopyPasteTypeCopyPasteType列舉可能的貼上類型。
DataExecutionErrorCodeDataExecutionErrorCode列舉可能的資料執行錯誤代碼。
DataExecutionStateDataExecutionState列舉可能的資料執行狀態。
DataSourceParameterTypeDataSourceParameterType列舉可能的資料來源參數類型。
DataSourceRefreshScopeDataSourceRefreshScope列舉可能的資料來源重新整理範圍。
DataSourceTypeDataSourceType列舉可能的資料來源類型。
DataValidationCriteriaDataValidationCriteria此列舉代表可在範圍中設定的資料驗證條件。
DateTimeGroupingRuleTypeDateTimeGroupingRuleType日期時間分組規則的列舉。
DeveloperMetadataLocationTypeDeveloperMetadataLocationType列舉可能的開發人員中繼資料位置類型。
DeveloperMetadataVisibilityDeveloperMetadataVisibility列舉可能的開發人員中繼資料瀏覽權限。
DimensionDimension列舉試算表的可能維度。
DirectionDirection列出使用箭頭鍵在試算表中移動的可能方向。
FrequencyTypeFrequencyType列舉可能的頻率類型。
GroupControlTogglePositionGroupControlTogglePosition列舉群組控制切換鈕可出現的位置。
InterpolationTypeInterpolationType列舉條件格式漸層插補類型。
PivotTableSummarizeFunctionPivotTableSummarizeFunction列舉可用於匯總資料透視表中值的函式。
PivotValueDisplayTypePivotValueDisplayType列舉樞紐值的顯示方式。
ProtectionTypeProtectionType此列舉代表可防止編輯的試算表部分。
RecalculationIntervalRecalculationInterval列舉可用於試算表重新計算的可能間隔。
RelativeDateRelativeDate列舉相對日期選項,用於計算要在以日期為基礎的 BooleanCriteria 中使用的值。
SheetTypeSheetType列出試算表中可存在的不同工作表類型。
SortOrderSortOrder排序順序的列舉。
TextDirectionTextDirection有效文字方向的列舉。
TextToColumnsDelimiterTextToColumnsDelimiter將文字分隔成不同欄的預設分隔符號列舉。
ThemeColorTypeThemeColorType列舉可能的主題顏色類型。
ValueTypeValueTypeRange.getValue()Range.getValues() 從試算表服務的 Range 類別傳回的值類型列舉。
WrapStrategyWrapStrategy列舉用於將儲存格包裝的策略。

方法

方法傳回類型簡短說明
create(name)Spreadsheet建立新試算表並使用指定名稱。
create(name, rows, columns)Spreadsheet建立新試算表,並指定名稱、資料列和資料欄數量。
enableAllDataSourcesExecution()void為所有類型的資料來源啟用資料執行功能。
enableBigQueryExecution()void為 BigQuery 資料來源啟用資料執行功能。
enableLookerExecution()void為 Looker 資料來源啟用資料執行作業。
flush()void套用所有待處理的試算表變更。
getActive()Spreadsheet傳回目前有效的試算表,如果沒有則傳回 null
getActiveRange()Range傳回有效工作表中的選取範圍,如果沒有有效範圍,則傳回 null
getActiveRangeList()RangeList傳回有效工作表中有效範圍的清單,如果沒有選取範圍,則傳回 null
getActiveSheet()Sheet取得試算表中的活動工作表。
getActiveSpreadsheet()Spreadsheet傳回目前有效的試算表,如果沒有則傳回 null
getCurrentCell()Range傳回在有效工作表的其中一個有效範圍中選取的目前 (醒目顯示) 儲存格,如果沒有目前儲存格,則傳回 null
getSelection()Selection傳回試算表中目前的 Selection
getUi()Ui會傳回試算表使用者介面環境的例項,讓指令碼可新增選單、對話方塊和側欄等功能。
newCellImage()CellImageBuilder建立 CellImage 的建構工具。
newColor()ColorBuilder建立 Color 的建構工具。
newConditionalFormatRule()ConditionalFormatRuleBuilder建立條件式格式設定規則的建構工具。
newDataSourceSpec()DataSourceSpecBuilder建立 DataSourceSpec 的建構工具。
newDataValidation()DataValidationBuilder建立資料驗證規則的建構工具。
newFilterCriteria()FilterCriteriaBuilder建立 FilterCriteria 的建構工具。
newRichTextValue()RichTextValueBuilder建立富文字值的建構工具。
newTextStyle()TextStyleBuilder建立文字樣式的建構工具。
open(file)Spreadsheet開啟與指定 File 物件相對應的試算表。
openById(id)Spreadsheet開啟含有指定 ID 的試算表。
openByUrl(url)Spreadsheet開啟指定網址的試算表。
setActiveRange(range)Range將指定的範圍設為 active range,範圍內的左上方儲存格為 current cell
setActiveRangeList(rangeList)RangeList將指定的範圍清單設為 active ranges
setActiveSheet(sheet)Sheet設定試算表中的活動工作表。
setActiveSheet(sheet, restoreSelection)Sheet設定試算表中的活動工作表,並提供選項,可還原該工作表中最近的選取項目。
setActiveSpreadsheet(newActiveSpreadsheet)void設定有效試算表。
setCurrentCell(cell)Range將指定的儲存格設為 current cell

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_RIGHTEnum從左到右的文字方向。
RIGHT_TO_LEFTEnum從右到左的文字方向。

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設定文字字型系列,例如「Arial」。
setFontSize(fontSize)TextStyleBuilder以點為單位設定文字字型大小。
setForegroundColor(cssString)TextStyleBuilder設定文字字型顏色。
setForegroundColorObject(color)TextStyleBuilder設定文字字型顏色。
setItalic(italic)TextStyleBuilder設定文字是否為斜體。
setStrikethrough(strikethrough)TextStyleBuilder設定文字是否已刪除線。
setUnderline(underline)TextStyleBuilder設定文字是否加上底線。

TextToColumnsDelimiter

屬性

屬性類型說明
COMMAEnum"," 分隔符號。
SEMICOLONEnum";" 分隔符號。
PERIODEnum"." 分隔符號。
SPACEEnum" " 分隔符號。

ThemeColor

方法

方法傳回類型簡短說明
getColorType()ColorType取得此顏色的類型。
getThemeColorType()ThemeColorType取得此顏色的主題顏色類型。

ThemeColorType

屬性

屬性類型說明
UNSUPPORTEDEnum代表系統不支援的主題顏色。
TEXTEnum代表文字顏色。
BACKGROUNDEnum代表要用於圖表背景的顏色。
ACCENT1Enum代表第一個強調色。
ACCENT2Enum代表第二個強調色。
ACCENT3Enum代表第三個強調色。
ACCENT4Enum代表第四個強調色。
ACCENT5Enum代表第五個強調色。
ACCENT6Enum代表第六個強調色。
HYPERLINKEnum代表超連結使用的顏色。

ValueType

屬性

屬性類型說明
IMAGEEnum儲存格含有圖片時的值類型。

WrapStrategy

屬性

屬性類型說明
WRAPEnum將超過儲存格寬度的行換到新行。
OVERFLOWEnum溢出文字至下一個儲存格 (只要該儲存格為空白即可)。
CLIPEnum截斷超過單元格寬度的行。