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 的內插選項。
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新增參數,或者如果有名稱的參數已存在,則會更新來源儲存格。
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清除條件式格式規則的漸層最大值值,改為使用規則範圍內的最大值。
setGradientMaxpointObject(color)ConditionalFormatRuleBuilder清除條件式格式規則的漸層最大值值,改為使用規則範圍內的最大值。
setGradientMaxpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層 maxpoint 欄位。
setGradientMaxpointWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層 maxpoint 欄位。
setGradientMidpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層中點欄位。
setGradientMidpointWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層中點欄位。
setGradientMinpoint(color)ConditionalFormatRuleBuilder清除條件式格式規則的梯度最小值,並改用規則範圍內的最小值。
setGradientMinpointObject(color)ConditionalFormatRuleBuilder清除條件式格式規則的梯度最小值,並改用規則範圍內的最小值。
setGradientMinpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層最小點欄位。
setGradientMinpointWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層最小點欄位。
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

方法

方法傳回類型簡短說明
createCalculatedColumn(name, formula)DataSourceColumn建立計算結果欄。
createDataSourcePivotTableOnNewSheet()DataSourcePivotTable在新工作表的第一個儲存格中,根據這個資料來源建立資料來源資料透視表。
createDataSourceTableOnNewSheet()DataSourceTable在新工作表的第一個儲存格中,根據這個資料來源建立資料來源資料表。
getCalculatedColumnByName(columnName)DataSourceColumn傳回資料來源中與資料欄名稱相符的計算結果欄。
getCalculatedColumns()DataSourceColumn[]傳回資料來源中的所有計算結果欄。
getColumns()DataSourceColumn[]傳回資料來源中的所有欄。
getDataSourceSheets()DataSourceSheet[]傳回與這個資料來源相關聯的資料來源工作表。
getSpec()DataSourceSpec取得資料來源規格。
refreshAllLinkedDataSourceObjects()void重新整理已連結至資料來源的所有資料來源物件。
updateSpec(spec)DataSource更新資料來源規格,並使用新規格重新整理與這個資料來源連結的資料來源物件。
updateSpec(spec, refreshAllLinkedObjects)DataSource更新資料來源規格,並根據新規格重新整理已連結的 data source sheets
waitForAllDataExecutionsCompletion(timeoutInSeconds)void會等到已連結資料來源物件目前的所有執行作業完成,並在提供的秒數過後逾時。

DataSourceChart

方法

方法傳回類型簡短說明
forceRefreshData()DataSourceChart重新整理這個物件的資料,無論目前狀態為何。
getDataSource()DataSource取得物件連結的資料來源。
getStatus()DataExecutionStatus取得物件的資料執行狀態。
refreshData()DataSourceChart重新整理物件資料。
waitForCompletion(timeoutInSeconds)DataExecutionStatus等到目前的執行作業完成,在提供的秒數後逾時。

DataSourceColumn

方法

方法傳回類型簡短說明
getDataSource()DataSource取得與資料來源資料欄相關聯的資料來源。
getFormula()String取得資料來源欄的公式。
getName()String取得資料來源資料欄的名稱。
hasArrayDependency()Boolean傳回資料欄是否具有陣列依附元件。
isCalculatedColumn()Boolean傳回資料欄是否為計算結果欄。
remove()void移除資料來源欄。
setFormula(formula)DataSourceColumn設定資料來源欄的公式。
setName(name)DataSourceColumn設定資料來源資料欄的名稱。

DataSourceFormula

方法

方法傳回類型簡短說明
forceRefreshData()DataSourceFormula重新整理這個物件的資料,無論目前狀態為何。
getAnchorCell()Range傳回 Range,代表此資料來源公式固定的儲存格。
getDataSource()DataSource取得物件連結的資料來源。
getDisplayValue()String傳回資料來源公式的顯示值。
getFormula()String傳回這個資料來源公式的公式。
getStatus()DataExecutionStatus取得物件的資料執行狀態。
refreshData()DataSourceFormula重新整理物件資料。
setFormula(formula)DataSourceFormula更新公式。
waitForCompletion(timeoutInSeconds)DataExecutionStatus等到目前的執行作業完成,在提供的秒數後逾時。

DataSourceParameter

方法

方法傳回類型簡短說明
getName()String取得參數名稱。
getSourceCell()String取得參數值依據的來源儲存格;如果參數類型不是 DataSourceParameterType.CELL,則取得 null
getType()DataSourceParameterType取得參數類型。

DataSourceParameterType

屬性

屬性類型說明
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTEDEnumApps Script 不支援的資料來源參數類型。
CELLEnum資料來源參數會根據儲存格值。

DataSourcePivotTable

方法

方法傳回類型簡短說明
addColumnGroup(columnName)PivotGroup根據指定的資料來源資料欄,新增資料透視表欄群組。
addFilter(columnName, filterCriteria)PivotFilter根據指定的資料來源資料欄,新增具有指定篩選條件的篩選器。
addPivotValue(columnName, summarizeFunction)PivotValue以指定的匯總函式為基礎,新增資料透視表值。
addRowGroup(columnName)PivotGroup根據指定的資料來源資料欄新增資料透視列群組。
asPivotTable()PivotTable將資料來源資料透視表傳回為一般的資料透視表物件。
forceRefreshData()DataSourcePivotTable重新整理這個物件的資料,無論目前狀態為何。
getDataSource()DataSource取得物件連結的資料來源。
getStatus()DataExecutionStatus取得物件的資料執行狀態。
refreshData()DataSourcePivotTable重新整理物件資料。
waitForCompletion(timeoutInSeconds)DataExecutionStatus等到目前的執行作業完成,在提供的秒數後逾時。

DataSourceRefreshSchedule

方法

方法傳回類型簡短說明
getFrequency()DataSourceRefreshScheduleFrequency取得重新整理排程頻率,指定重新整理的頻率和時間。
getScope()DataSourceRefreshScope取得這項重新整理排程的範圍。
getTimeIntervalOfNextRun()TimeInterval取得此重新整理排程的下次執行時間範圍。
isEnabled()Boolean決定是否要啟用這項重新整理排程。

DataSourceRefreshScheduleFrequency

方法

方法傳回類型簡短說明
getDaysOfTheMonth()Integer[]取得當月天數 (1-28),以重新整理資料來源。
getDaysOfTheWeek()Weekday[]取得一週中要重新整理資料來源的日子。
getFrequencyType()FrequencyType取得頻率類型。
getStartHour()Integer取得執行重新整理排程期間的開始小時 (以 0 到 23 表示)。

DataSourceRefreshScope

屬性

屬性類型說明
DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTEDEnum不支援這個資料來源重新整理範圍。
ALL_DATA_SOURCESEnum重新整理將套用至試算表中的所有資料來源。

DataSourceSheet

方法

方法傳回類型簡短說明
addFilter(columnName, filterCriteria)DataSourceSheet新增已套用至資料來源工作表的篩選器。
asSheet()Sheet傳回資料來源工作表,做為一般工作表物件。
autoResizeColumn(columnName)DataSourceSheet自動調整指定資料欄的寬度。
autoResizeColumns(columnNames)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 資料來源的規格。
copy()DataSourceSpecBuilder根據這個資料來源的設定建立 DataSourceSpecBuilder
getParameters()DataSourceParameter[]取得資料來源的參數。
getType()DataSourceType取得資料來源的類型。

DataSourceSpecBuilder

方法

方法傳回類型簡短說明
asBigQuery()BigQueryDataSourceSpecBuilder取得 BigQuery 資料來源的建構工具。
build()DataSourceSpec根據這個建構工具中的設定建立資料來源規格。
copy()DataSourceSpecBuilder根據這個資料來源的設定建立 DataSourceSpecBuilder
getParameters()DataSourceParameter[]取得資料來源的參數。
getType()DataSourceType取得資料來源的類型。
removeAllParameters()DataSourceSpecBuilder用於移除所有參數。
removeParameter(parameterName)DataSourceSpecBuilder移除指定的參數。
setParameterFromCell(parameterName, sourceCell)DataSourceSpecBuilder新增參數,或者如果有名稱的參數已存在,則會更新來源儲存格。

DataSourceTable

方法

方法傳回類型簡短說明
addColumns(columnNames)DataSourceTable在資料來源資料表中加入資料欄。
addFilter(columnName, filterCriteria)DataSourceTable加入已套用至資料來源資料表的篩選器。
addSortSpec(columnName, ascending)DataSourceTable對資料來源資料表中的資料欄新增排序規格。
addSortSpec(columnName, sortOrder)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 資料來源。

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將圖表類型設為直方圖,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為折線圖,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為「散佈圖」,並傳回 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將圖表類型設為直方圖,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為折線圖,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為「散佈圖」,並傳回 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;如果圖表不在試算表內,則傳回 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將圖表類型設為直方圖,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為折線圖,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為「散佈圖」,並傳回 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將圖表類型設為直方圖,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為折線圖,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為「散佈圖」,並傳回 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將圖表類型設為直方圖,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為折線圖,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為「散佈圖」,並傳回 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將圖表類型設為直方圖,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為折線圖,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為「散佈圖」,並傳回 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將圖表類型設為直方圖,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為折線圖,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為「散佈圖」,並傳回 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將圖表類型設為直方圖,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為折線圖,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為「散佈圖」,並傳回 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將圖表類型設為直方圖,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為折線圖,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為「散佈圖」,並傳回 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將圖表類型設為直方圖,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為折線圖,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為「散佈圖」,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建立圖表以反映所有變更。
clearRanges()EmbeddedChartBuilder從這個建構工具修改的圖表中移除所有範圍。
enablePaging(enablePaging)EmbeddedTableChartBuilder設定是否要啟用資料分頁功能。
enablePaging(pageSize)EmbeddedTableChartBuilder啟用分頁功能,並設定每個頁面中的列數。
enablePaging(pageSize, startPage)EmbeddedTableChartBuilder啟用分頁功能,設定每個網頁以及第一個表格頁面要顯示的列數 (頁數為零)。
enableRtlTable(rtlEnabled)EmbeddedTableChartBuilder透過反向排序資料表的資料欄順序,新增由右至左語言 (例如阿拉伯文或希伯來文) 的基本支援,讓零欄位於最右欄,而最後一欄就是最左邊的資料欄。
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 指定數字。
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將最大數字推測為漸層條件的特定內插點。

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使用指定的 name,在資料透視表中建立新的資料透視表值 (以指定 formula 計算)。
addColumnGroup(sourceDataColumn)PivotGroup定義資料透視表中新的資料透視欄分組。
addFilter(sourceDataColumn, filterCriteria)PivotFilter為資料透視表建立新的資料透視篩選器。
addPivotValue(sourceDataColumn, summarizeFunction)PivotValue使用指定的 summarizeFunction 定義資料透視表中的新資料透視值。
addRowGroup(sourceDataColumn)PivotGroup定義資料透視表中新的資料透視列分組。
asDataSourcePivotTable()DataSourcePivotTable如果資料透視表已連結至 DataSource,請將資料透視表傳回為資料來源資料透視表;如果不是,則傳回 null
getAnchorCell()Range傳回 Range,代表錨定這個資料透視表的儲存格。
getColumnGroups()PivotGroup[]傳回這個資料透視表中欄群組的順序清單。
getFilters()PivotFilter[]傳回這個資料透視表中篩選器的排序清單。
getPivotValues()PivotValue[]傳回這個資料透視表中的資料透視表值已排序清單。
getRowGroups()PivotGroup[]傳回這個資料透視表中資料列群組的順序清單。
getSourceDataRange()Range傳回建立資料透視表的來源資料範圍。
getValuesDisplayOrientation()Dimension傳回值是以列或欄的形式顯示。
remove()void刪除這份資料透視表。
setValuesDisplayOrientation(dimension)PivotTable設定這個資料透視表的版面配置,以欄或列的形式顯示值。

PivotTableSummarizeFunction

屬性

屬性類型說明
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 建立空白資料透視表。
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傳回範圍左上方儲存格的 RTF 值;如果儲存格值不是文字,則傳回 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設定字型系列,例如「 相簿」或「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刪除這個範圍中所有儲存格中的空白字元 (例如空格、定位點或換行符號)。
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在這個範圍清單的所有儲存格中,修剪空白字元 (例如空格、定位點或換行符號)。
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[]傳回分割為執行結果的 RTF 字串,其中每次的執行作業都是可能擁有一致的文字樣式最長的可能子字串。
getStartIndex()Integer取得儲存格中這個值的起始索引。
getText()String傳回這個值的文字。
getTextStyle()TextStyle傳回這個值的文字樣式。
getTextStyle(startOffset, endOffset)TextStyle傳回 startOffsetendOffset 的文字樣式。

RichTextValueBuilder

方法

方法傳回類型簡短說明
build()RichTextValue使用此建構工具建立 RTF 格式的值。
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)OverGridImageBlobSource 做為圖片,在指定的列和欄的文件中插入 (像素偏移)。
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
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)OverGridImageSpreadsheet 做為圖片,在指定的列和欄的文件中插入 (像素偏移)。
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條件式格式設定布林條件列舉。
BorderStyleBorderStyleRange 上設定邊框的有效樣式列舉。
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 資料來源的資料執行功能。
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建立 RTF 格式值的建構工具。
newTextStyle()TextStyleBuilder建立文字樣式的建構工具。
open(file)Spreadsheet開啟與指定檔案物件對應的試算表。
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設定文字字型系列,例如「 相簿」。
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裁剪長度超過儲存格寬度的線。