Spreadsheet Service

試算表

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

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

類別

名稱簡短說明
AutoFillSeries用於計算自動填入值的數列類型列舉。
Banding存取及修改帶狀間隔,也就是套用至範圍內資料列或資料欄的色彩模式。
BandingTheme列舉樂團主題。
BigQueryDataSourceSpec存取現有的 BigQuery 資料來源規格。
BigQueryDataSourceSpecBuilderBigQueryDataSourceSpecBuilder 的建構工具。
BooleanConditionConditionalFormatRules 中存取布林條件。
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篩選條件的建構工具。
FrequencyType列舉頻率類型。
GradientConditionConditionalFormatRuleApis 中存取漸層 (顏色) 條件。
Group存取及修改試算表群組。
GroupControlTogglePosition列舉,代表群組控制項切換鈕可擁有的可能位置。
InterpolationType列舉,代表用於計算 ConditionalFormatRuleGradientCondition 值的插補選項。
LookerDataSourceSpecDataSourceSpec,用於存取現有 Looker 資料來源規格。
LookerDataSourceSpecBuilderLookerDataSourceSpecBuilder 的建構工具。
NamedRange在試算表中建立、存取及修改已命名範圍。
OverGridImage代表試算表格線上的圖片。
PageProtection在舊版 Google 試算表中存取及修改受保護的工作表。
PivotFilter存取及修改資料透視表篩選條件。
PivotGroup存取及修改資料透視表細分群組。
PivotGroupLimit存取及修改資料透視表群組限制。
PivotTable存取及修改資料透視表。
PivotTableSummarizeFunction列舉彙整資料透視表資料的函式。
PivotValue存取及修改資料透視表中的值群組。
PivotValueDisplayType列舉將樞紐值顯示為另一個值函式的方式。
Protection存取及修改受保護的範圍和工作表。
ProtectionType列舉,代表可防止編輯的試算表部分。
Range存取及修改試算表範圍。
RangeList同一工作表中的一或多個 Range 執行個體集合。
RecalculationInterval列舉,代表試算表重新計算時可能使用的間隔。
RelativeDate列舉,代表用於計算日期型 BooleanCriteria 中值的相對日期選項。
RichTextValue用來表示儲存格文字的樣式化文字字串。
RichTextValueBuilderRTF 格式值的建構工具。
Selection存取目前使用中工作表中的有效選取範圍。
Sheet存取及修改試算表工作表。
SheetType試算表可包含的不同類型工作表。
Slicer代表篩選器控制項,用於以非協作方式篩選範圍、圖表和資料透視表。
SortOrder代表排序順序的列舉。
SortSpec排序規格。
Spreadsheet存取及修改 Google 試算表檔案。
SpreadsheetApp存取及建立 Google 試算表檔案。
SpreadsheetTheme存取及修改現有主題。
TextDirection文字路線指示的列舉。
TextFinder在範圍、工作表或試算表中尋找或取代文字。
TextRotation存取儲存格的文字旋轉設定。
TextStyle儲存格中文字的算繪樣式。
TextStyleBuilder文字樣式建構工具。
TextToColumnsDelimiter列舉預設分隔符號的類型,這些分隔符號可將文字欄分割為多個欄。
ThemeColor主題顏色的表示法。
ThemeColorType這個列舉會說明主題支援的各種顏色項目。
ValueType列舉 Range.getValue()Range.getValues() 從 Spreadsheet 服務的 Range 類別傳回的值類型。
WrapStrategy用於處理儲存格文字換行的策略列舉。

AutoFillSeries

屬性

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

Banding

方法

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

BandingTheme

屬性

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

BigQueryDataSourceSpec

方法

方法傳回類型簡短說明
copy()DataSourceSpecBuilder根據這個資料來源的設定建立 DataSourceSpecBuilder
getDatasetId()String取得 BigQuery 資料集 ID。
getParameters()DataSourceParameter[]取得資料來源的參數。
getProjectId()String取得帳單專案 ID。
getRawQuery()String取得原始查詢字串。
getTableId()String取得 BigQuery 資料表 ID。
getTableProjectId()String取得資料表的 BigQuery 專案 ID。
getType()DataSourceType取得資料來源的類型。

BigQueryDataSourceSpecBuilder

方法

方法傳回類型簡短說明
build()DataSourceSpec根據這個產生器中的設定,建構資料來源規格。
copy()DataSourceSpecBuilder根據這個資料來源的設定建立 DataSourceSpecBuilder
getDatasetId()String取得 BigQuery 資料集 ID。
getParameters()DataSourceParameter[]取得資料來源的參數。
getProjectId()String取得帳單專案 ID。
getRawQuery()String取得原始查詢字串。
getTableId()String取得 BigQuery 資料表 ID。
getTableProjectId()String取得資料表的 BigQuery 專案 ID。
getType()DataSourceType取得資料來源的類型。
removeAllParameters()BigQueryDataSourceSpecBuilder移除所有參數。
removeParameter(parameterName)BigQueryDataSourceSpecBuilder移除指定參數。
setDatasetId(datasetId)BigQueryDataSourceSpecBuilder設定 BigQuery 資料集 ID。
setParameterFromCell(parameterName, sourceCell)BigQueryDataSourceSpecBuilder新增參數,或更新類型為 DataSourceType.BIGQUERY 的資料來源規格建構工具的來源儲存格 (如果參數名稱已存在)。
setProjectId(projectId)BigQueryDataSourceSpecBuilder設定帳單 BigQuery 專案 ID。
setRawQuery(rawQuery)BigQueryDataSourceSpecBuilder設定原始查詢字串。
setTableId(tableId)BigQueryDataSourceSpecBuilder設定 BigQuery 資料表 ID。
setTableProjectId(projectId)BigQueryDataSourceSpecBuilder設定資料表的 BigQuery 專案 ID。

BooleanCondition

方法

方法傳回類型簡短說明
getBackgroundObject()Color取得這個布林條件的背景顏色。
getBold()Boolean如果這個布林條件會將文字設為粗體,則傳回 true;如果這個布林條件會移除文字的粗體格式,則傳回 false
getCriteriaType()BooleanCriteria取得 BooleanCriteria 列舉中定義的規則條件類型。
getCriteriaValues()Object[]取得規則條件的引數陣列。
getFontColorObject()Color取得這個布林條件的字型顏色。
getItalic()Boolean如果這個布林條件會將文字設為斜體,則傳回 true;如果這個布林條件會移除文字的斜體格式,則傳回 false
getStrikethrough()Boolean如果這個布林值條件會為文字加上刪除線,則傳回 true;如果這個布林值條件會移除文字的刪除線,則傳回 false
getUnderline()Boolean如果這個布林條件會為文字加上底線,則傳回 true;如果這個布林條件會移除文字底線,則傳回 false

BooleanCriteria

屬性

屬性類型說明
CELL_EMPTYEnum當儲存格為空白時,即符合條件。
CELL_NOT_EMPTYEnum只要儲存格不為空白,即符合條件。
DATE_AFTEREnum只要日期晚於指定值,即符合條件。
DATE_BEFOREEnum當日期早於指定值時,即符合條件。
DATE_EQUAL_TOEnum當日期等於指定值時,即符合條件。
DATE_NOT_EQUAL_TOEnum當日期不等於指定值時,即符合條件。
DATE_AFTER_RELATIVEEnum當日期晚於相對日期值時,即符合條件。
DATE_BEFORE_RELATIVEEnum如果日期早於相對日期值,即符合條件。
DATE_EQUAL_TO_RELATIVEEnum當日期等於相對日期值時,即符合條件。
NUMBER_BETWEENEnum當數字介於指定值之間時,即符合條件。
NUMBER_EQUAL_TOEnum當數字等於指定值時,即符合條件。
NUMBER_GREATER_THANEnum當數字大於指定值時,即符合條件。
NUMBER_GREATER_THAN_OR_EQUAL_TOEnum當數字大於或等於指定值時,即符合條件。
NUMBER_LESS_THANEnum當數字小於指定值時,即符合條件。
NUMBER_LESS_THAN_OR_EQUAL_TOEnum當數字小於或等於指定值時,即符合條件。
NUMBER_NOT_BETWEENEnum當數字不在指定值之間時,即符合條件。
NUMBER_NOT_EQUAL_TOEnum當數字不等於指定值時,即符合條件。
TEXT_CONTAINSEnum當輸入內容包含指定值時,即符合條件。
TEXT_DOES_NOT_CONTAINEnum如果輸入內容不包含指定值,即符合條件。
TEXT_EQUAL_TOEnum當輸入內容等於指定值時,即符合條件。
TEXT_NOT_EQUAL_TOEnum當輸入值不等於指定值時,即符合條件。
TEXT_STARTS_WITHEnum當輸入內容開頭為指定值時,即符合條件。
TEXT_ENDS_WITHEnum當輸入內容結尾為指定值時,即符合條件。
CUSTOM_FORMULAEnum當輸入內容使指定公式評估為 true 時,即符合條件。

BorderStyle

屬性

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

CellImage

屬性

屬性類型說明
valueTypeValueType儲存格圖片的值類型,也就是 ValueType.IMAGE

方法

方法傳回類型簡短說明
getAltTextDescription()String傳回這張圖片的替代文字說明。
getAltTextTitle()String傳回這張圖片的替代文字標題。
getContentUrl()String傳回 Google 代管的圖片網址。
toBuilder()CellImageBuilder根據目前的圖片屬性建立儲存格圖片建構工具。

CellImageBuilder

屬性

屬性類型說明
valueTypeValueType儲存格圖片的值類型,也就是 ValueType.IMAGE

方法

方法傳回類型簡短說明
build()CellImage建立將圖片新增至儲存格所需的圖片值型別。
getAltTextDescription()String傳回這張圖片的替代文字說明。
getAltTextTitle()String傳回這張圖片的替代文字標題。
getContentUrl()String傳回 Google 代管的圖片網址。
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設定條件式格式規則的漸層最大點欄位。
setGradientMaxpointWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層最大點欄位。
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

方法

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

DataSourceChart

方法

方法傳回類型簡短說明
cancelDataRefresh()DataSourceChart如果與這個物件相關的資料重新整理作業正在執行,系統會取消作業。
forceRefreshData()DataSourceChart無論目前狀態為何,都會重新整理這個物件的資料。
getDataSource()DataSource取得物件連結的資料來源。
getStatus()DataExecutionStatus取得物件的資料執行狀態。
refreshData()DataSourceChart重新整理物件的資料。
waitForCompletion(timeoutInSeconds)DataExecutionStatus等待目前執行作業完成,並在指定秒數後逾時。

DataSourceColumn

方法

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

DataSourceFormula

方法

方法傳回類型簡短說明
cancelDataRefresh()DataSourceFormula如果與這個物件相關的資料重新整理作業正在執行,系統會取消作業。
forceRefreshData()DataSourceFormula無論目前狀態為何,都會重新整理這個物件的資料。
getAnchorCell()Range傳回代表這個資料來源公式錨定儲存格的 Range
getDataSource()DataSource取得物件連結的資料來源。
getDisplayValue()String傳回資料來源公式的顯示值。
getFormula()String傳回這個資料來源公式的公式。
getStatus()DataExecutionStatus取得物件的資料執行狀態。
refreshData()DataSourceFormula重新整理物件的資料。
setFormula(formula)DataSourceFormula更新公式。
waitForCompletion(timeoutInSeconds)DataExecutionStatus等待目前執行作業完成,並在指定秒數後逾時。

DataSourceParameter

方法

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

DataSourceParameterType

屬性

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

DataSourcePivotTable

方法

方法傳回類型簡短說明
addColumnGroup(columnName)PivotGroup根據指定的資料來源資料欄,新增資料透視表資料欄群組。
addFilter(columnName, filterCriteria)PivotFilter根據指定資料來源資料欄和篩選條件新增篩選器。
addPivotValue(columnName)PivotValue根據指定的資料來源資料欄新增透視值,不使用任何摘要函式。
addPivotValue(columnName, summarizeFunction)PivotValue根據指定資料來源資料欄,使用指定摘要函式新增透視值。
addRowGroup(columnName)PivotGroup根據指定的資料來源資料欄,新增資料透視表資料列群組。
asPivotTable()PivotTable以一般資料透視表物件的形式傳回資料來源資料透視表。
cancelDataRefresh()DataSourcePivotTable如果與這個物件相關的資料重新整理作業正在執行,系統會取消作業。
forceRefreshData()DataSourcePivotTable無論目前狀態為何,都會重新整理這個物件的資料。
getDataSource()DataSource取得物件連結的資料來源。
getStatus()DataExecutionStatus取得物件的資料執行狀態。
refreshData()DataSourcePivotTable重新整理物件的資料。
waitForCompletion(timeoutInSeconds)DataExecutionStatus等待目前執行作業完成,並在指定秒數後逾時。

DataSourceRefreshSchedule

方法

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

DataSourceRefreshScheduleFrequency

方法

方法傳回類型簡短說明
getDaysOfTheMonth()Integer[]以數字 (1-28) 取得要重新整理資料來源的每月日期。
getDaysOfTheWeek()Weekday[]取得要重新整理資料來源的星期幾。
getFrequencyType()FrequencyType取得頻率類型。
getStartHour()Integer取得時間間隔的開始時間 (以 0 到 23 的數字表示),這個時間間隔是執行重新整理時間表的時段。

DataSourceRefreshScope

屬性

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

DataSourceSheet

方法

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

DataSourceSheetFilter

方法

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

DataSourceSpec

方法

方法傳回類型簡短說明
asBigQuery()BigQueryDataSourceSpec取得 BigQuery 資料來源的規格。
asLooker()LookerDataSourceSpec取得 Looker 資料來源的規格。
copy()DataSourceSpecBuilder根據這個資料來源的設定建立 DataSourceSpecBuilder
getParameters()DataSourceParameter[]取得資料來源的參數。
getType()DataSourceType取得資料來源的類型。

DataSourceSpecBuilder

方法

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

DataSourceTable

方法

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

DataSourceTableColumn

方法

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

DataSourceTableFilter

方法

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

DataSourceType

屬性

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

DataValidation

方法

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

DataValidationBuilder

方法

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

DataValidationCriteria

屬性

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

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依季度分組日期時間,例如第 1 季 (代表 1 月到 3 月)。
YEAREnum依年份分組日期時間,例如 2008 年。
YEAR_MONTHEnum依年和月分組日期時間,例如 2008-Nov
YEAR_QUARTEREnum依年和季分組日期時間,例如 2008 Q4
YEAR_MONTH_DAYEnum依年、月、日將日期時間分組,例如 2008-11-22

DeveloperMetadata

方法

方法傳回類型簡短說明
getId()Integer傳回與這個開發人員中繼資料相關聯的專屬 ID。
getKey()String傳回與這個開發人員中繼資料相關聯的鍵。
getLocation()DeveloperMetadataLocation傳回這項開發人員中繼資料的位置。
getValue()String傳回與這個開發人員中繼資料相關聯的值,如果這個中繼資料沒有值,則傳回 null
getVisibility()DeveloperMetadataVisibility傳回這項開發人員中繼資料的顯示設定。
moveToColumn(column)DeveloperMetadata將這項開發人員中繼資料移至指定資料欄。
moveToRow(row)DeveloperMetadata將這項開發人員中繼資料移至指定資料列。
moveToSheet(sheet)DeveloperMetadata將這項開發人員中繼資料移至指定工作表。
moveToSpreadsheet()DeveloperMetadata將這項開發人員中繼資料移至頂層試算表。
remove()void刪除這項中繼資料。
setKey(key)DeveloperMetadata將這個開發人員中繼資料的鍵設為指定值。
setValue(value)DeveloperMetadata將與這個開發人員中繼資料相關聯的值設為指定值。
setVisibility(visibility)DeveloperMetadata將這項開發人員中繼資料的瀏覽權限設為指定瀏覽權限。

DeveloperMetadataFinder

方法

方法傳回類型簡短說明
find()DeveloperMetadata[]執行這項搜尋作業,並傳回相符的中繼資料。
onIntersectingLocations()DeveloperMetadataFinder設定搜尋作業,將含有中繼資料的交集位置納入考量。
withId(id)DeveloperMetadataFinder限制這項搜尋,只考量符合指定 ID 的中繼資料。
withKey(key)DeveloperMetadataFinder限制這項搜尋,只考量符合指定鍵的中繼資料。
withLocationType(locationType)DeveloperMetadataFinder將這項搜尋作業限制為只考慮符合指定位置類型的中繼資料。
withValue(value)DeveloperMetadataFinder限制這項搜尋,只考量符合指定值的元資料。
withVisibility(visibility)DeveloperMetadataFinder將搜尋範圍限制為只考量符合指定顯示狀態的中繼資料。

DeveloperMetadataLocation

方法

方法傳回類型簡短說明
getColumn()Range傳回此中繼資料資料欄位置的 Range,如果位置類型不是 DeveloperMetadataLocationType.COLUMN,則傳回 null
getLocationType()DeveloperMetadataLocationType取得位置類型。
getRow()Range傳回這個中繼資料列位置的 Range,如果位置類型不是 DeveloperMetadataLocationType.ROW,則傳回 null
getSheet()Sheet傳回此中繼資料的 Sheet 位置,如果位置類型不是 DeveloperMetadataLocationType.SHEET,則傳回 null
getSpreadsheet()Spreadsheet傳回這項中繼資料的 Spreadsheet 位置,如果位置類型不是 DeveloperMetadataLocationType.SPREADSHEET,則傳回 null

DeveloperMetadataLocationType

屬性

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

DeveloperMetadataVisibility

屬性

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

Dimension

屬性

屬性類型說明
COLUMNSEnum直向維度。
ROWSEnum列 (水平) 維度。

Direction

屬性

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

Drawing

方法

方法傳回類型簡短說明
getContainerInfo()ContainerInfo取得繪圖在工作表中的位置資訊。
getHeight()Integer傳回這個繪圖的實際高度 (以像素為單位)。
getOnAction()String傳回附加至此繪圖的巨集名稱。
getSheet()Sheet傳回這個繪圖所在的試算表。
getWidth()Integer傳回這個繪圖的實際寬度 (以像素為單位)。
getZIndex()Number傳回這個繪圖的 z-index。
remove()void從試算表中刪除這張繪圖。
setHeight(height)Drawing以像素為單位設定此繪圖的實際高度。
setOnAction(macroName)Drawing將巨集函式指派給這個繪圖。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)Drawing設定繪圖在工作表中的顯示位置。
setWidth(width)Drawing以像素為單位設定繪圖的實際寬度。
setZIndex(zIndex)Drawing設定這個繪圖的 z-index。

EmbeddedAreaChartBuilder

方法

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

EmbeddedBarChartBuilder

方法

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

EmbeddedChart

方法

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

EmbeddedChartBuilder

方法

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

EmbeddedColumnChartBuilder

方法

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

EmbeddedComboChartBuilder

方法

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

EmbeddedHistogramChartBuilder

方法

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

EmbeddedLineChartBuilder

方法

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

EmbeddedPieChartBuilder

方法

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

EmbeddedScatterChartBuilder

方法

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

EmbeddedTableChartBuilder

方法

方法傳回類型簡短說明
addRange(range)EmbeddedChartBuilder將範圍新增至這個建構工具修改的圖表。
asAreaChart()EmbeddedAreaChartBuilder將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder
asBarChart()EmbeddedBarChartBuilder將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder將圖表類型設為 ColumnChart,並傳回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder將圖表類型設為 HistogramChart,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為 LineChart,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為 ScatterChart,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建構圖表,反映所有變更。
clearRanges()EmbeddedChartBuilder從這個建構工具修改的圖表中移除所有範圍。
enablePaging(enablePaging)EmbeddedTableChartBuilder設定是否要啟用資料分頁功能。
enablePaging(pageSize)EmbeddedTableChartBuilder啟用分頁功能,並設定每個頁面的資料列數。
enablePaging(pageSize, startPage)EmbeddedTableChartBuilder啟用分頁功能,設定每頁的列數和要顯示的第一個表格頁面 (頁碼以零為基準)。
enableRtlTable(rtlEnabled)EmbeddedTableChartBuilder新增對由右至左語言 (例如阿拉伯文或希伯來文) 的基本支援,方法是反轉表格的欄順序,讓第零欄成為最右側的欄,最後一欄則成為最左側的欄。
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設定篩選條件,顯示介於兩個指定數字之間或等於其中一個數字的儲存格。
whenNumberEqualTo(number)FilterCriteriaBuilder設定篩選條件,顯示含有指定數字的儲存格。
whenNumberEqualToAny(numbers)FilterCriteriaBuilder設定篩選條件,顯示含有指定數字的儲存格。
whenNumberGreaterThan(number)FilterCriteriaBuilder設定篩選條件,顯示大於指定數字的儲存格
whenNumberGreaterThanOrEqualTo(number)FilterCriteriaBuilder設定篩選條件,顯示大於或等於指定數字的儲存格。
whenNumberLessThan(number)FilterCriteriaBuilder設定篩選條件,顯示數字小於指定數字的儲存格。
whenNumberLessThanOrEqualTo(number)FilterCriteriaBuilder設定篩選條件,顯示數字小於或等於指定數字的儲存格。
whenNumberNotBetween(start, end)FilterCriteriaBuilder設定篩選條件,顯示數字不介於兩個指定數字之間,也不等於這兩個數字的儲存格。
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 的群組深度減少 1。

GroupControlTogglePosition

屬性

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

InterpolationType

屬性

屬性類型說明
NUMBEREnum將數字做為漸層條件的特定插補點。
PERCENTEnum將該數字做為漸層條件的百分比插補點。
PERCENTILEEnum將這個數字做為漸層條件的百分位數插補點。
MINEnum將最小值推斷為漸層條件的特定插補點。
MAXEnum將最大值推斷為漸層條件的特定插補點。

LookerDataSourceSpec

方法

方法傳回類型簡短說明
copy()DataSourceSpecBuilder根據這個資料來源的設定建立 DataSourceSpecBuilder
getExploreName()String取得模型中 Looker 探索的名稱。
getInstanceUrl()String取得 Looker 執行個體的網址。
getModelName()String取得執行個體中的 Looker 模型名稱。
getParameters()DataSourceParameter[]取得資料來源的參數。
getType()DataSourceType取得資料來源的類型。

LookerDataSourceSpecBuilder

方法

方法傳回類型簡短說明
build()DataSourceSpec根據這個產生器中的設定,建構資料來源規格。
copy()DataSourceSpecBuilder根據這個資料來源的設定建立 DataSourceSpecBuilder
getExploreName()String取得模型中 Looker 探索的名稱。
getInstanceUrl()String取得 Looker 執行個體的網址。
getModelName()String取得執行個體中的 Looker 模型名稱。
getParameters()DataSourceParameter[]取得資料來源的參數。
getType()DataSourceType取得資料來源的類型。
removeAllParameters()LookerDataSourceSpecBuilder移除所有參數。
removeParameter(parameterName)LookerDataSourceSpecBuilder移除指定參數。
setExploreName(exploreName)LookerDataSourceSpecBuilder在 Looker 模型中設定探索名稱。
setInstanceUrl(instanceUrl)LookerDataSourceSpecBuilder設定 Looker 的執行個體網址。
setModelName(modelName)LookerDataSourceSpecBuilder在 Looker 執行個體中設定 Looker 模型名稱。
setParameterFromCell(parameterName, sourceCell)LookerDataSourceSpecBuilder新增參數,或更新類型為 DataSourceType.BIGQUERY 的資料來源規格建構工具的來源儲存格 (如果參數名稱已存在)。

NamedRange

方法

方法傳回類型簡短說明
getName()String取得這個已命名範圍的名稱。
getRange()Range取得這個已命名範圍參照的範圍。
remove()void刪除這個已命名範圍。
setName(name)NamedRange設定/更新已命名範圍的名稱。
setRange(range)NamedRange設定/更新這個已命名範圍的範圍。

OverGridImage

方法

方法傳回類型簡短說明
assignScript(functionName)OverGridImage將具有指定函式名稱的函式指派給這個圖片。
getAltTextDescription()String傳回這張圖片的替代文字說明。
getAltTextTitle()String傳回這張圖片的替代文字標題。
getAnchorCell()Range傳回圖片錨定的儲存格。
getAnchorCellXOffset()Integer傳回與錨定儲存格的水平像素偏移量。
getAnchorCellYOffset()Integer傳回錨定儲存格的垂直像素偏移量。
getHeight()Integer以像素為單位傳回這張圖片的實際高度。
getInherentHeight()Integer以像素為單位傳回這張圖片的固有高度。
getInherentWidth()Integer以像素為單位傳回這張圖片的固有高度。
getScript()String傳回指派給這張圖片的函式名稱。
getSheet()Sheet傳回顯示這張圖片的工作表。
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在資料透視表中建立新的透視值,該值是根據指定 formulaname 計算而得。
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在範圍內的每個儲存格中插入核取方塊,並將已勾選和未勾選的核取方塊分別設定為 truefalse
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 之間的整數,含 0 和 255) 將背景設為指定顏色。
setBackgrounds(color)Range設定背景顏色矩形格線 (必須與這個範圍的維度相符)。
setBorder(top, left, bottom, right, vertical, horizontal)Range設定邊框屬性。
setBorder(top, left, bottom, right, vertical, horizontal, color, style)Range設定邊框屬性,包括顏色和/或樣式。
setDataValidation(rule)Range為範圍內的所有儲存格設定一項資料驗證規則。
setDataValidations(rules)Range為範圍內的所有儲存格設定資料驗證規則。
setFontColor(color)Range以 CSS 標記 (例如 '#ffffff''white') 設定字型顏色。
setFontColorObject(color)Range設定指定範圍的字型顏色。
setFontColorObjects(colors)Range設定字型顏色矩形格線 (必須符合這個範圍的維度)。
setFontColors(colors)Range設定字型顏色矩形格線 (必須符合這個範圍的維度)。
setFontFamilies(fontFamilies)Range設定字型系列的矩形格線 (必須符合這個範圍的尺寸)。
setFontFamily(fontFamily)Range設定字型系列,例如「Arial」或「Helvetica」。
setFontLine(fontLine)Range為指定範圍設定字型線條樣式 ('underline''line-through''none')。
setFontLines(fontLines)Range設定線條樣式的矩形格線 (必須符合這個範圍的維度)。
setFontSize(size)Range設定字型大小,大小為要使用的點大小。
setFontSizes(sizes)Range設定字型大小的矩形格線 (必須符合這個範圍的尺寸)。
setFontStyle(fontStyle)Range為指定範圍設定字型樣式 ('italic''normal')。
setFontStyles(fontStyles)Range設定字型樣式的矩形格線 (必須符合這個範圍的維度)。
setFontWeight(fontWeight)Range為指定範圍設定字型粗細 (一般/粗體)。
setFontWeights(fontWeights)Range設定字體粗細的矩形格線 (必須符合這個範圍的維度)。
setFormula(formula)Range更新這個範圍的公式。
setFormulaR1C1(formula)Range更新這個範圍的公式。
setFormulas(formulas)Range設定公式的矩形格線 (必須符合這個範圍的維度)。
setFormulasR1C1(formulas)Range設定公式的矩形格線 (必須符合這個範圍的維度)。
setHorizontalAlignment(alignment)Range為指定範圍設定水平 (從左到右) 對齊方式 (靠左/置中/靠右)。
setHorizontalAlignments(alignments)Range設定水平對齊方式的矩形格線。
setNote(note)Range將附註設為指定值。
setNotes(notes)Range設定音符的矩形格線 (必須符合這個範圍的尺寸)。
setNumberFormat(numberFormat)Range將數字或日期格式設為指定的格式字串。
setNumberFormats(numberFormats)Range設定數字或日期格式的矩形格線 (必須與這個範圍的維度相符)。
setRichTextValue(value)Range為範圍內的儲存格設定 RTF 格式值。
setRichTextValues(values)Range設定 RTF 格式值的矩形格線。
setShowHyperlink(showHyperlink)Range設定範圍是否應顯示超連結。
setTextDirection(direction)Range設定範圍內儲存格的文字方向。
setTextDirections(directions)Range設定文字方向的矩形格線。
setTextRotation(degrees)Range設定範圍內儲存格的文字旋轉設定。
setTextRotation(rotation)Range設定範圍內儲存格的文字旋轉設定。
setTextRotations(rotations)Range設定文字旋轉的矩形格線。
setTextStyle(style)Range設定範圍內儲存格的文字樣式。
setTextStyles(styles)Range設定文字樣式的矩形格線。
setValue(value)Range設定範圍的值。
setValues(values)Range設定值的矩形格線 (必須符合這個範圍的維度)。
setVerticalAlignment(alignment)Range為指定範圍設定垂直 (由上到下) 對齊方式 (頂端/中間/底部)。
setVerticalAlignments(alignments)Range設定垂直對齊的矩形格線 (必須符合這個範圍的維度)。
setVerticalText(isVertical)Range設定是否要堆疊範圍內儲存格的文字。
setWrap(isWrapEnabled)Range設定指定範圍的儲存格換行。
setWrapStrategies(strategies)Range設定換行策略的矩形格線。
setWrapStrategy(strategy)Range設定範圍內儲存格的文字換行策略。
setWraps(isWrapEnabled)Range設定文字換行政策的矩形格線 (必須符合這個範圍的尺寸)。
shiftColumnGroupDepth(delta)Range依指定幅度變更範圍的欄群組深度。
shiftRowGroupDepth(delta)Range依指定幅度變更範圍的資料列分組深度。
sort(sortSpecObj)Range依據指定的資料欄和順序,排序指定範圍內的儲存格。
splitTextToColumns()void根據系統自動偵測到的分隔符號,將文字資料欄分割為多個資料欄。
splitTextToColumns(delimiter)void使用指定字串做為自訂分隔符號,將文字資料欄分割為多個資料欄。
splitTextToColumns(delimiter)void根據指定的分隔符號,將文字欄分割為多個欄。
trimWhitespace()Range修剪這個範圍內每個儲存格中的空白字元 (例如空格、Tab 或換行符號)。
uncheck()Range將範圍內核取方塊的狀態變更為「未勾選」。

RangeList

方法

方法傳回類型簡短說明
activate()RangeList選取Range執行個體清單。
breakApart()RangeList將範圍清單中所有水平或垂直合併的儲存格再次分割為個別儲存格。
check()RangeList將範圍內的核取方塊狀態變更為「已勾選」。
clear()RangeList清除範圍清單中每個 Range 的內容、格式和資料驗證規則。
clear(options)RangeList清除指定範圍的內容、格式、資料驗證規則和註解。
clearContent()RangeList清除範圍清單中每個 Range 的內容,但格式會保持不變。
clearDataValidations()RangeList清除範圍清單中每個 Range 的資料驗證規則。
clearFormat()RangeList清除範圍清單中每個 Range 的文字格式。
clearNote()RangeList清除範圍清單中每個 Range 的附註。
getRanges()Range[]傳回同一工作表中的一或多個 Range 執行個體清單。
insertCheckboxes()RangeList在範圍內的每個儲存格中插入核取方塊,並將已勾選和未勾選的核取方塊分別設定為 truefalse
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傳回 Rich Text 值的建構工具,並以這個 Rich Text 值的值初始化。
getEndIndex()Integer取得儲存格中這個值的結尾索引。
getLinkUrl()String傳回這個值的連結網址。
getLinkUrl(startOffset, endOffset)String傳回 startOffsetendOffset 的文字連結網址。
getRuns()RichTextValue[]傳回分割成一連串執行作業的 Rich Text 字串陣列,其中每個執行作業都是具有一致文字樣式的最長可能子字串。
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,同時仍涵蓋目前的儲存格。current cellactive range

Sheet

方法

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

SheetType

屬性

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

Slicer

方法

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

SortOrder

屬性

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

SortSpec

方法

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

Spreadsheet

方法

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

SpreadsheetApp

屬性

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

方法

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

SpreadsheetTheme

方法

方法傳回類型簡短說明
getConcreteColor(themeColorType)Color針對有效的主題顏色類型,傳回具體的 Color
getFontFamily()String傳回主題的字型系列,如果是 null 主題,則傳回 null
getThemeColors()ThemeColorType[]傳回目前主題的所有可能主題顏色類型清單。
setConcreteColor(themeColorType, color)SpreadsheetTheme將與這個色彩配置中的 ThemeColorType 相關聯的具體顏色,設為指定顏色。
setConcreteColor(themeColorType, red, green, blue)SpreadsheetTheme將這個色彩配置中與 ThemeColorType 相關聯的具體顏色,設為 RGB 格式的指定顏色。
setFontFamily(fontFamily)SpreadsheetTheme設定主題的字型系列。

TextDirection

屬性

屬性類型說明
LEFT_TO_RIGHTEnum文字方向為從左到右。
RIGHT_TO_LEFTEnum文字方向為從右到左。

TextFinder

方法

方法傳回類型簡短說明
findAll()Range[]傳回符合搜尋條件的所有儲存格。
findNext()Range傳回符合搜尋條件的下一個儲存格。
findPrevious()Range傳回符合搜尋條件的前一個儲存格。
getCurrentMatch()Range傳回符合搜尋條件的目前儲存格。
ignoreDiacritics(ignoreDiacritics)TextFinder如果為 true,則設定搜尋時忽略變音符號;否則搜尋時會比對變音符號。
matchCase(matchCase)TextFinder如果 true,則設定搜尋功能,完全比對搜尋文字的大小寫;否則搜尋功能預設為不區分大小寫。
matchEntireCell(matchEntireCell)TextFinder如果 true 為 true,則設定搜尋條件為符合整個儲存格內容;否則搜尋條件預設為部分相符。
matchFormulaText(matchFormulaText)TextFinder如果 true,則設定搜尋功能,傳回公式文字中出現的相符項目; 否則,系統會根據含有公式的儲存格顯示值進行比對。
replaceAllWith(replaceText)Integer以指定文字取代所有相符項目。
replaceWith(replaceText)Integer以指定文字取代目前相符儲存格中的搜尋文字,並傳回取代次數。
startFrom(startRange)TextFinder設定搜尋作業,在指定儲存格範圍後立即開始搜尋。
useRegularExpression(useRegEx)TextFinder如果 true,則設定搜尋功能將搜尋字串解讀為規則運算式;否則搜尋功能會將搜尋字串解讀為一般文字。

TextRotation

方法

方法傳回類型簡短說明
getDegrees()Integer取得標準文字方向與目前文字方向之間的角度。
isVertical()Boolean如果文字是垂直堆疊,則傳回 true;否則傳回 false

TextStyle

方法

方法傳回類型簡短說明
copy()TextStyleBuilder建立以這個文字樣式值初始化的文字樣式建構工具。
getFontFamily()String取得文字的字型系列。
getFontSize()Integer以點為單位取得文字的字型大小。
getForegroundColorObject()Color取得文字的字型顏色。
isBold()Boolean取得文字是否為粗體。
isItalic()Boolean取得儲存格是否為斜體。
isStrikethrough()Boolean取得儲存格是否已加上刪除線。
isUnderline()Boolean取得儲存格是否加上底線。

TextStyleBuilder

方法

方法傳回類型簡短說明
build()TextStyle從這個建構工具建立文字樣式。
setBold(bold)TextStyleBuilder設定文字是否為粗體。
setFontFamily(fontFamily)TextStyleBuilder設定文字字型系列,例如「Arial」。
setFontSize(fontSize)TextStyleBuilder以點為單位設定文字字型大小。
setForegroundColor(cssString)TextStyleBuilder設定文字字型顏色。
setForegroundColorObject(color)TextStyleBuilder設定文字字型顏色。
setItalic(italic)TextStyleBuilder設定文字是否為斜體。
setStrikethrough(strikethrough)TextStyleBuilder設定文字是否要加上刪除線。
setUnderline(underline)TextStyleBuilder設定文字是否加上底線。

TextToColumnsDelimiter

屬性

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

ThemeColor

方法

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

ThemeColorType

屬性

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

ValueType

屬性

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

WrapStrategy

屬性

屬性類型說明
WRAPEnum將長度超過儲存格寬度的文字換行。
OVERFLOWEnum溢位到下一個儲存格,只要該儲存格為空白即可。
CLIPEnum剪輯長度超過儲存格寬度的行。