Spreadsheet Service

試算表

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

有時候,試算表作業會組合在一起以提升效能,例如對某個方法執行多次呼叫時。如果您想確保所有待處理的變更都能立即執行,例如在指令碼執行時顯示使用者資訊,請呼叫 SpreadsheetApp.flush()

類別

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

AutoFillSeries

屬性

屬性類型說明
DEFAULT_SERIESEnum預設值。
ALTERNATE_SERIESEnum使用這項設定的自動填入功能會導致展開範圍內的空白儲存格填入現有值的副本。

Banding

方法

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

BandingTheme

屬性

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

BigQueryDataSourceSpec

方法

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

BigQueryDataSourceSpecBuilder

方法

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

BooleanCondition

方法

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

BooleanCriteria

屬性

屬性類型說明
CELL_EMPTYEnum如果儲存格空白,就符合條件。
CELL_NOT_EMPTYEnum儲存格不是空白時就符合條件。
DATE_AFTEREnum只有在日期晚於指定值時才會滿足條件。
DATE_BEFOREEnum符合條件的日期早於指定值。
DATE_EQUAL_TOEnum日期等於指定值時就會符合條件。
DATE_NOT_EQUAL_TOEnum如果日期不等於指定值,就會符合條件。
DATE_AFTER_RELATIVEEnum只有在日期晚於相對日期值時才會符合條件。
DATE_BEFORE_RELATIVEEnum日期早於相對日期值就會符合條件。
DATE_EQUAL_TO_RELATIVEEnum日期等於相對日期值時,即符合條件。
NUMBER_BETWEENEnum只要指定的值介於指定值之間,就算符合條件。
NUMBER_EQUAL_TOEnum數字等於指定值時,即符合條件。
NUMBER_GREATER_THANEnum數字大於指定值就會符合條件。
NUMBER_GREATER_THAN_OR_EQUAL_TOEnum數字大於或等於指定值時,即符合條件。
NUMBER_LESS_THANEnum符合條件的數字小於指定值。
NUMBER_LESS_THAN_OR_EQUAL_TOEnum假如數字小於或等於指定值,就算符合條件。
NUMBER_NOT_BETWEENEnum如果指定的值並非介於指定值之間,則符合條件。
NUMBER_NOT_EQUAL_TOEnum輸入的數字不等於指定值時,即符合條件。
TEXT_CONTAINSEnum如果輸入的值含有指定值,就符合條件。
TEXT_DOES_NOT_CONTAINEnum如果輸入的值不包含指定值,就符合條件。
TEXT_EQUAL_TOEnum如果輸入內容等於指定值,就會符合條件。
TEXT_NOT_EQUAL_TOEnum如果輸入的值不等於指定值,就會符合條件。
TEXT_STARTS_WITHEnum只要輸入的值開頭為指定的值,就會符合條件。
TEXT_ENDS_WITHEnum只要輸入的內容結束時符合指定值,就會符合條件。
CUSTOM_FORMULAEnum如果輸入內容產生了特定公式為 true 的結果,即符合條件。

BorderStyle

屬性

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

CellImage

屬性

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

方法

方法傳回類型簡短說明
getAltTextDescription()String傳回這張圖片的替代文字說明。
getAltTextTitle()String傳回這張圖片的替代文字標題。
getContentUrl()String傳回 Google 代管的圖片網址。
getUrl()String取得圖片的來源網址;如果沒有網址,則傳回 null
toBuilder()CellImageBuilder建立建構工具,將圖片轉換為映像檔值類型,以將圖片放入儲存格。

CellImageBuilder

屬性

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

方法

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

Color

方法

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

ColorBuilder

方法

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

ConditionalFormatRule

方法

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

ConditionalFormatRuleBuilder

方法

方法傳回類型簡短說明
build()ConditionalFormatRule從套用至建構工具的設定來建立條件式格式規則。
copy()ConditionalFormatRuleBuilder傳回採用此規則設定的規則建立工具預設。
getBooleanCondition()BooleanCondition如果這項規則使用布林條件條件,擷取規則的 BooleanCondition 資訊。
getGradientCondition()GradientCondition如果這項規則使用漸層條件,則擷取規則的 GradientCondition 資訊。
getRanges()Range[]擷取要套用這項條件式格式規則的範圍。
setBackground(color)ConditionalFormatRuleBuilder設定條件式格式規則格式的背景顏色。
setBackgroundObject(color)ConditionalFormatRuleBuilder設定條件式格式規則格式的背景顏色。
setBold(bold)ConditionalFormatRuleBuilder設定條件式格式規則格式的文字粗體。
setFontColor(color)ConditionalFormatRuleBuilder設定條件式格式規則格式的字型顏色。
setFontColorObject(color)ConditionalFormatRuleBuilder設定條件式格式規則格式的字型顏色。
setGradientMaxpoint(color)ConditionalFormatRuleBuilder清除條件式格式規則的漸層最大值,改用規則範圍內的最大值。
setGradientMaxpointObject(color)ConditionalFormatRuleBuilder清除條件式格式規則的漸層最大值,改用規則範圍內的最大值。
setGradientMaxpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilder設定條件式格式規則的漸層最大值欄位。
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, 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 資料來源的規格。
copy()DataSourceSpecBuilder根據這個資料來源的設定建立DataSourceSpecBuilder
getParameters()DataSourceParameter[]取得資料來源的參數。
getType()DataSourceType取得資料來源的類型。

DataSourceSpecBuilder

方法

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

DataSourceTable

方法

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

DataValidation

方法

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

DataValidationBuilder

方法

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

DataValidationCriteria

屬性

屬性類型說明
DATE_AFTEREnum必須提供晚於指定值的日期。
DATE_BEFOREEnum必須提供早於指定值的日期。
DATE_BETWEENEnum必須提供介於指定值之間的日期。
DATE_EQUAL_TOEnum必須提供與指定值相等的日期。
DATE_IS_VALID_DATEEnum必須提供日期。
DATE_NOT_BETWEENEnum必須提供非指定值之間的日期。
DATE_ON_OR_AFTEREnum必須提供等於或晚於指定值的日期。
DATE_ON_OR_BEFOREEnum必須提供等於或早於指定值的日期。
NUMBER_BETWEENEnum必須提供介於指定值之間的數字。
NUMBER_EQUAL_TOEnum要求的數字必須等於指定值。
NUMBER_GREATER_THANEnum數值必須大於指定值。
NUMBER_GREATER_THAN_OR_EQUAL_TOEnum要求的數字必須大於或等於指定值。
NUMBER_LESS_THANEnum必須提供小於指定值的數字。
NUMBER_LESS_THAN_OR_EQUAL_TOEnum必須提供小於或等於指定值的數字。
NUMBER_NOT_BETWEENEnum必須提供非指定值之間的數字。
NUMBER_NOT_EQUAL_TOEnum必須提供不等於指定值的數字。
TEXT_CONTAINSEnum輸入內容必須包含指定值。
TEXT_DOES_NOT_CONTAINEnum輸入內容中不含指定值。
TEXT_EQUAL_TOEnum輸入內容必須等於指定值。
TEXT_IS_VALID_EMAILEnum必須輸入電子郵件地址形式。
TEXT_IS_VALID_URLEnum必須輸入網址格式。
VALUE_IN_LISTEnum輸入內容必須與其中一個指定值相等。
VALUE_IN_RANGEEnum要求輸入內容等於指定範圍內的值。
CUSTOM_FORMULAEnum要求輸入內容會將指定的公式計算為 true
CHECKBOXEnum必須輸入自訂值或布林值;顯示為核取方塊。

DateTimeGroupingRule

方法

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

DateTimeGroupingRuleType

屬性

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

DeveloperMetadata

方法

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

DeveloperMetadataFinder

方法

方法傳回類型簡短說明
find()DeveloperMetadata[]執行這項搜尋,並傳回相符的中繼資料。
onIntersectingLocations()DeveloperMetadataFinder將搜尋設為考慮與中繼資料相交的位置。
withId(id)DeveloperMetadataFinder將這項搜尋限制在僅考量符合指定 ID 的中繼資料。
withKey(key)DeveloperMetadataFinder將搜尋範圍限制在僅考慮符合指定鍵的中繼資料。
withLocationType(locationType)DeveloperMetadataFinder將搜尋範圍限制在符合指定位置類型的中繼資料。
withValue(value)DeveloperMetadataFinder將搜尋範圍限制在僅考量符合指定值的中繼資料。
withVisibility(visibility)DeveloperMetadataFinder將搜尋範圍限制在僅考量符合指定瀏覽權限的中繼資料。

DeveloperMetadataLocation

方法

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

DeveloperMetadataLocationType

屬性

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

DeveloperMetadataVisibility

屬性

屬性類型說明
DOCUMENTEnum凡是具備文件存取權的開發人員專案,都能存取文件瀏覽權限中繼資料。
PROJECTEnum只有建立中繼資料的開發人員專案才能查看及存取專案可見的中繼資料。

Dimension

屬性

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

Direction

屬性

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

Drawing

方法

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

EmbeddedAreaChartBuilder

方法

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

EmbeddedBarChartBuilder

方法

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

EmbeddedChart

方法

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

EmbeddedChartBuilder

方法

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

EmbeddedColumnChartBuilder

方法

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

EmbeddedComboChartBuilder

方法

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

EmbeddedHistogramChartBuilder

方法

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

EmbeddedLineChartBuilder

方法

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

EmbeddedPieChartBuilder

方法

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

EmbeddedScatterChartBuilder

方法

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

EmbeddedTableChartBuilder

方法

方法傳回類型簡短說明
addRange(range)EmbeddedChartBuilder將範圍新增至這個建構工具修改的圖表。
asAreaChart()EmbeddedAreaChartBuilder將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder
asBarChart()EmbeddedBarChartBuilder將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder將圖表類型設為「ColumnChart」,並傳回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder將圖表類型設為直方圖,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為折線圖,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為「PieChart」並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為散佈圖,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建立圖表以反映對圖表的所有變更。
clearRanges()EmbeddedChartBuilder從這個建構工具修改的圖表中移除所有範圍。
enablePaging(enablePaging)EmbeddedTableChartBuilder設定是否要啟用資料分頁功能。
enablePaging(pageSize)EmbeddedTableChartBuilder啟用分頁功能,並設定每個頁面上的列數。
enablePaging(pageSize, startPage)EmbeddedTableChartBuilder啟用分頁功能,設定各頁面的列數,以及第一個表格頁面要顯示的資料列 (頁碼以零為基準)。
enableRtlTable(rtlEnabled)EmbeddedTableChartBuilder透過反轉資料表的資料欄順序,新增由右至左語言 (例如阿拉伯文或希伯來文) 的基本支援,讓第 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 個指定數字或屬於 2 個指定數字的儲存格。
whenNumberEqualTo(number)FilterCriteriaBuilder設定篩選器條件,顯示內含數字等於指定數字的儲存格。
whenNumberEqualToAny(numbers)FilterCriteriaBuilder設定篩選條件以顯示數字等於任何指定數字的儲存格。
whenNumberGreaterThan(number)FilterCriteriaBuilder設定篩選條件,顯示數值大於指定數字的儲存格
whenNumberGreaterThanOrEqualTo(number)FilterCriteriaBuilder設定篩選條件,顯示數字大於或等於指定數字的儲存格。
whenNumberLessThan(number)FilterCriteriaBuilder設定篩選條件,顯示內含小於指定數字的儲存格。
whenNumberLessThanOrEqualTo(number)FilterCriteriaBuilder設定篩選條件,顯示數字小於或等於指定數字的儲存格。
whenNumberNotBetween(start, end)FilterCriteriaBuilder設定篩選條件,顯示含有數字的儲存格,且非介於 2 個指定數字之間。
whenNumberNotEqualTo(number)FilterCriteriaBuilder設定篩選條件,顯示含有你不等於指定數字的儲存格。
whenNumberNotEqualToAny(numbers)FilterCriteriaBuilder設定篩選條件以顯示含有不等於任何指定數字的儲存格。
whenTextContains(text)FilterCriteriaBuilder設定篩選器條件,顯示內含指定文字的儲存格。
whenTextDoesNotContain(text)FilterCriteriaBuilder設定篩選器條件,顯示不含指定文字的儲存格。
whenTextEndsWith(text)FilterCriteriaBuilder設定篩選器條件,顯示內含特定文字結尾的儲存格。
whenTextEqualTo(text)FilterCriteriaBuilder設定篩選器條件,篩選出文字等於指定文字的儲存格。
whenTextEqualToAny(texts)FilterCriteriaBuilder設定篩選條件以顯示含有文字與任何指定文字值相等的儲存格。
whenTextNotEqualTo(text)FilterCriteriaBuilder設定篩選器條件,篩選出文字不等於指定文字的儲存格。
whenTextNotEqualToAny(texts)FilterCriteriaBuilder設定篩選條件以顯示含有文字不等於任何指定值的儲存格。
whenTextStartsWith(text)FilterCriteriaBuilder設定篩選器條件,顯示開頭為指定文字的儲存格。
withCriteria(criteria, args)FilterCriteriaBuilder將篩選條件設為由 BooleanCriteria 值定義的布林條件,例如 CELL_EMPTYNUMBER_GREATER_THAN

FrequencyType

屬性

屬性類型說明
FREQUENCY_TYPE_UNSUPPORTEDEnum不支援此頻率類型。
DAILYEnum每日重新整理。
WEEKLYEnum每週更新一次。
MONTHLYEnum每月的指定日期更新。

GradientCondition

方法

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

Group

方法

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

GroupControlTogglePosition

屬性

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

InterpolationType

屬性

屬性類型說明
NUMBEREnum使用數字做為漸層條件的特定內插點。
PERCENTEnum請使用數字做為漸層條件的內插點百分比內插點。
PERCENTILEEnum請使用數字做為漸層條件的百分位數內插點。
MINEnum將最小數值推斷為漸層條件的具體內插點。
MAXEnum將最大數字推斷為漸層條件的特定內插點。

NamedRange

方法

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

OverGridImage

方法

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

PageProtection

PivotFilter

方法

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

PivotGroup

方法

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

PivotGroupLimit

方法

方法傳回類型簡短說明
getCountLimit()Integer取得資料透視表中資料列或資料欄的數量上限。
getPivotGroup()PivotGroup傳回限制所屬的資料透視群組。
remove()void移除資料透視表元素分組限制。
setCountLimit(countLimit)PivotGroupLimit設定資料透視表中資料列或資料欄的計數限制。

PivotTable

方法

方法傳回類型簡短說明
addCalculatedPivotValue(name, formula)PivotValue以指定的 name 計算指定 formula 的資料透視表中建立新的資料透視表。
addColumnGroup(sourceDataColumn)PivotGroup定義資料透視表中新的資料透視欄分組。
addFilter(sourceDataColumn, filterCriteria)PivotFilter為資料透視表建立新的資料透視篩選器。
addPivotValue(sourceDataColumn, summarizeFunction)PivotValue使用指定的 summarizeFunction 定義資料透視表中的新資料透視值。
addRowGroup(sourceDataColumn)PivotGroup定義資料透視表中新的資料透視列分組。
asDataSourcePivotTable()DataSourcePivotTable如果資料透視表已連結至 DataSource,則傳回資料透視表做為資料來源資料透視表;否則會傳回 null
getAnchorCell()Range傳回 Range,代表這個資料透視表錨定位置的儲存格。
getColumnGroups()PivotGroup[]傳回這個資料透視表中資料欄群組已排序的清單。
getFilters()PivotFilter[]傳回這個資料透視表中經過排序的篩選器清單。
getPivotValues()PivotValue[]傳回這個資料透視表中資料透視表值的排序清單。
getRowGroups()PivotGroup[]傳回這個資料透視表中列群組已排序的清單。
getSourceDataRange()Range傳回建立資料透視表的來源資料範圍。
getValuesDisplayOrientation()Dimension傳回值要以列或欄的形式顯示。
remove()void刪除這個資料透視表。
setValuesDisplayOrientation(dimension)PivotTable設定這個資料透視表的版面配置,以欄或列的形式顯示值。

PivotTableSummarizeFunction

屬性

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

PivotValue

方法

方法傳回類型簡短說明
getDisplayType()PivotValueDisplayType會傳回顯示類型,說明這個資料透視值目前在表格中的顯示方式。
getFormula()String傳回計算這個值的公式。
getPivotTable()PivotTable傳回這個值所屬的 PivotTable
getSourceDataColumn()Integer傳回資料透視值匯總的來源資料欄數量。
getSourceDataSourceColumn()DataSourceColumn