Spreadsheet Service

試算表

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

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

類別

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

AutoFillSeries

屬性

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

Banding

方法

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

BandingTheme

屬性

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

BigQueryDataSourceSpec

方法

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

BigQueryDataSourceSpecBuilder

方法

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

BooleanCondition

方法

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

BooleanCriteria

屬性

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

BorderStyle

屬性

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

CellImage

屬性

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

方法

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

CellImageBuilder

屬性

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

方法

方法傳回類型簡短說明
build()CellImage建立將圖片新增至儲存格所需的圖片值類型。
getAltTextDescription()String傳回此圖片的替代文字說明。
getAltTextTitle()String傳回此圖片的替代文字標題。
getContentUrl()String傳回 Google 代管的圖片網址。
getUrl()String取得圖片的來源網址;如果網址無法使用,則會傳回 null
setAltTextDescription(description)CellImage設定圖片的替代文字說明。
setAltTextTitle(title)CellImage設定圖片的替代文字標題。
setSourceUrl(url)CellImageBuilder設定圖片來源網址。
toBuilder()CellImageBuilder建立建構工具,將圖片轉換為圖片值類型,以便將圖片放入單元格。

Color

方法

方法傳回類型簡短說明
asRgbColor()RgbColor將此顏色轉換為 RgbColor
asThemeColor()ThemeColor將此顏色轉換為 ThemeColor
getColorType()ColorType取得此顏色的類型。

ColorBuilder

方法

方法傳回類型簡短說明
asRgbColor()RgbColor將此顏色轉換為 RgbColor
asThemeColor()ThemeColor將此顏色轉換為 ThemeColor
build()Color根據建構工具提供的設定,建立色彩物件。
getColorType()ColorType取得此顏色的類型。
setRgbColor(cssString)ColorBuilder設為 RGB 顏色。
setThemeColor(themeColorType)ColorBuilder設為主題顏色。

ConditionalFormatRule

方法

方法傳回類型簡短說明
copy()ConditionalFormatRuleBuilder傳回含有此規則設定的規則建構工具預設值。
getBooleanCondition()BooleanCondition如果這項規則使用布林值條件條件,則會擷取規則的 BooleanCondition 資訊。
getGradientCondition()GradientCondition如果此規則使用漸層條件條件,則會擷取規則的 GradientCondition 資訊。
getRanges()Range[]擷取要套用此條件式格式規則的範圍。

ConditionalFormatRuleBuilder

方法

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

ContainerInfo

方法

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

CopyPasteType

屬性

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

DataExecutionErrorCode

屬性

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

DataExecutionState

屬性

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

DataExecutionStatus

方法

方法傳回類型簡短說明
getErrorCode()DataExecutionErrorCode取得資料執行作業的錯誤代碼。
getErrorMessage()String取得資料執行作業的錯誤訊息。
getExecutionState()DataExecutionState取得資料執行作業的狀態。
getLastExecutionTime()Date無論執行狀態為何,都能取得上次資料執行作業完成的時間。
getLastRefreshedTime()Date取得資料上次成功重新整理的時間。
isTruncated()Boolean如果上次成功執行的資料遭到截斷,則會傳回 true;否則會傳回 false

DataSource

方法

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

DataSourceChart

方法

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

DataSourceColumn

方法

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

DataSourceFormula

方法

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

DataSourceParameter

方法

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

DataSourceParameterType

屬性

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

DataSourcePivotTable

方法

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

DataSourceRefreshSchedule

方法

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

DataSourceRefreshScheduleFrequency

方法

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

DataSourceRefreshScope

屬性

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

DataSourceSheet

方法

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

DataSourceSheetFilter

方法

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

DataSourceSpec

方法

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

DataSourceSpecBuilder

方法

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

DataSourceTable

方法

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

DataSourceTableColumn

方法

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

DataSourceTableFilter

方法

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

DataSourceType

屬性

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

DataValidation

方法

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

DataValidationBuilder

方法

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

DataValidationCriteria

屬性

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

DateTimeGroupingRule

方法

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

DateTimeGroupingRuleType

屬性

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

DeveloperMetadata

方法

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

DeveloperMetadataFinder

方法

方法傳回類型簡短說明
find()DeveloperMetadata[]執行這項搜尋,並傳回符合條件的中繼資料。
onIntersectingLocations()DeveloperMetadataFinder設定搜尋作業,以便考量交集位置是否含有中繼資料。
withId(id)DeveloperMetadataFinder限制此搜尋作業只考量符合指定 ID 的中繼資料。
withKey(key)DeveloperMetadataFinder限制此搜尋作業只考量符合指定鍵的中繼資料。
withLocationType(locationType)DeveloperMetadataFinder將此搜尋限制為只考量符合指定位置類型的中繼資料。
withValue(value)DeveloperMetadataFinder限制此搜尋作業只考量符合指定值的中繼資料。
withVisibility(visibility)DeveloperMetadataFinder限制此搜尋作業只考量符合指定可見度的中繼資料。

DeveloperMetadataLocation

方法

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

DeveloperMetadataLocationType

屬性

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

DeveloperMetadataVisibility

屬性

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

Dimension

屬性

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

Direction

屬性

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

Drawing

方法

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

EmbeddedAreaChartBuilder

方法

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

EmbeddedBarChartBuilder

方法

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

EmbeddedChart

方法

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

EmbeddedChartBuilder

方法

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

EmbeddedColumnChartBuilder

方法

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

EmbeddedComboChartBuilder

方法

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

EmbeddedHistogramChartBuilder

方法

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

EmbeddedLineChartBuilder

方法

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

EmbeddedPieChartBuilder

方法

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

EmbeddedScatterChartBuilder

方法

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

EmbeddedTableChartBuilder

方法

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

Filter

方法

方法傳回類型簡短說明
getColumnFilterCriteria(columnPosition)FilterCriteria取得指定欄的篩選條件,如果該欄未套用篩選條件,則會傳回 null
getRange()Range取得這個篩選器適用的範圍。
remove()void移除這個篩選器。
removeColumnFilterCriteria(columnPosition)Filter從指定欄移除篩選條件。
setColumnFilterCriteria(columnPosition, filterCriteria)Filter設定指定資料欄的篩選條件。
sort(columnPosition, ascending)Filter依指定欄排序篩選的範圍,不包含此篩選器套用範圍的第一列 (標題列)。

FilterCriteria

方法

方法傳回類型簡短說明
copy()FilterCriteriaBuilder複製這個篩選器條件,並建立可套用至其他篩選器的條件建構工具。
getCriteriaType()BooleanCriteria傳回條件的布林值型別,例如 CELL_EMPTY
getCriteriaValues()Object[]傳回布林條件的引數陣列。
getHiddenValues()String[]傳回篩除器隱藏的值。
getVisibleBackgroundColor()Color傳回用於篩選條件的背景顏色。
getVisibleForegroundColor()Color傳回做為篩選條件使用的前景顏色。
getVisibleValues()String[]傳回資料透視表篩選器顯示的值。

FilterCriteriaBuilder

方法

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

FrequencyType

屬性

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

GradientCondition

方法

方法傳回類型簡短說明
getMaxColorObject()Color取得此漸層條件的最大值所對應的顏色集。
getMaxType()InterpolationType取得此漸層條件最大值的插補類型。
getMaxValue()String取得此漸層條件中的最大值。
getMidColorObject()Color取得此漸層條件中點值的顏色集合。
getMidType()InterpolationType取得此漸層條件的中點值插補類型。
getMidValue()String取得此漸層條件的中間點值。
getMinColorObject()Color取得此漸層條件最小值的顏色集。
getMinType()InterpolationType取得此漸層條件最小值的插補類型。
getMinValue()String取得此漸層條件的最小值。

Group

方法

方法傳回類型簡短說明
collapse()Group收合這個群組。
expand()Group展開這個群組。
getControlIndex()Integer傳回這個群組的控制切換索引。
getDepth()Integer傳回這個群組的深度。
getRange()Range傳回這個群組的範圍。
isCollapsed()Boolean如果這個群組已收合,則會傳回 true
remove()void從工作表中移除這個群組,將 range 的群組深度減少一個。

GroupControlTogglePosition

屬性

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

InterpolationType

屬性

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

LookerDataSourceSpec

方法

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

LookerDataSourceSpecBuilder

方法

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

NamedRange

方法

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

OverGridImage

方法

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

PageProtection

PivotFilter

方法

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

PivotGroup

方法

方法傳回類型簡短說明
addManualGroupingRule(groupName, groupMembers)PivotGroup為這個資料透視表群組新增手動分組規則。
areLabelsRepeated()Boolean傳回標籤是否以重複方式顯示。
clearGroupingRule()PivotGroup從這個資料透視表元素群組中移除任何分組規則。
clearSort()PivotGroup移除套用至這個群組的任何排序。
getDateTimeGroupingRule()DateTimeGroupingRule傳回資料透視表群組的日期時間分組規則,如果未設定日期時間分組規則,則傳回 null
getDimension()Dimension傳回這是否為列或欄組。
getGroupLimit()PivotGroupLimit傳回資料透視表元素群組的資料透視表元素群組限制。
getIndex()Integer傳回這個資料透視表元素群組在目前群組順序中的索引。
getPivotTable()PivotTable傳回這個分組所屬的 Piv