本頁面由 Cloud Translation API 翻譯而成。

Class EmbeddedTableChartBuilder

表格圖表的建構工具。詳情請參閱 Gviz 說明文件。

方法

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

內容詳盡的說明文件

`addRange(range)`

將範圍新增至這個建構工具修改的圖表。如果範圍已新增至圖表，則不會再新增。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  const chart = sheet.newChart()                   .setChartType(Charts.ChartType.BAR)                   .addRange(sheet.getRange('A1:B8'))                   .setPosition(5, 5, 0, 0)                   .build();  sheet.insertChart(chart);

參數

名稱	類型	說明
`range`	`Range`	要新增的範圍。

回攻員

EmbeddedChartBuilder：這個建構工具用於鏈結。

`asAreaChart()`

將圖表類型設為 AreaChart，並傳回 EmbeddedAreaChartBuilder。

回攻員

EmbeddedAreaChartBuilder：面積圖的建構工具。

`asBarChart()`

將圖表類型設為 BarChart，並傳回 EmbeddedBarChartBuilder。

回攻員

EmbeddedBarChartBuilder：長條圖的建構工具。

`asColumnChart()`

將圖表類型設為 ColumnChart，並傳回 EmbeddedColumnChartBuilder。

回攻員

EmbeddedColumnChartBuilder：柱狀圖的建構工具。

`asComboChart()`

將圖表類型設為 ComboChart，並傳回 EmbeddedComboChartBuilder。

回攻員

EmbeddedComboChartBuilder：組合圖的建構工具。

`asHistogramChart()`

將圖表類型設為 HistogramChart，並傳回 EmbeddedHistogramChartBuilder。

回攻員

EmbeddedHistogramChartBuilder：直方圖的建構工具。

`asLineChart()`

將圖表類型設為 LineChart，並傳回 EmbeddedLineChartBuilder。

回攻員

EmbeddedLineChartBuilder：折線圖的建構工具。

`asPieChart()`

將圖表類型設為 PieChart，並傳回 EmbeddedPieChartBuilder。

回攻員

EmbeddedPieChartBuilder：圓餅圖的建構工具。

`asScatterChart()`

將圖表類型設為 ScatterChart，並傳回 EmbeddedScatterChartBuilder。

回攻員

EmbeddedScatterChartBuilder：散布圖的建構工具。

`asTableChart()`

將圖表類型設為 TableChart，並傳回 EmbeddedTableChartBuilder。

回攻員

EmbeddedTableChartBuilder：表格圖表的建構工具。

`build()`

建構圖表，反映所有變更。

這個方法不會自動在試算表上繪製圖表。必須透過 sheet.insertChart(chart) 插入新圖表，並透過 sheet.updateChart(chart) 更新現有圖表。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  const range = sheet.getRange('A1:B5'); const chart = sheet.newChart()                   .setChartType(Charts.ChartType.BAR)                   .addRange(range)                   .setPosition(5, 5, 0, 0)                   .build();  sheet.insertChart(chart);

回攻員

EmbeddedChart：建立的圖表，必須新增至試算表。

`clearRanges()`

從這個建構工具修改的圖表中移除所有範圍。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  // This code updates the chart to use only the new ranges while preserving the // existing formatting of the chart. const chart = sheet.getCharts()[0]; const newChart = chart.modify()                      .clearRanges()                      .addRange(sheet.getRange('A1:A5'))                      .addRange(sheet.getRange('B1:B5'))                      .build(); sheet.updateChart(newChart);

回攻員

EmbeddedChartBuilder：這個建構工具用於鏈結。

`enablePaging(enablePaging)`

設定是否要啟用資料分頁。

預設行為是停用分頁功能。如果啟用分頁功能，預設頁面大小為 10。

參數

名稱	類型	說明
`enablePaging`	`Boolean`	如要啟用分頁功能，請使用 `true`；否則請使用 `false`。

回攻員

EmbeddedTableChartBuilder：這個建構工具可用於串連。

`enablePaging(pageSize)`

啟用分頁功能，並設定每個頁面中的資料列數。

預設頁面大小為 10。

// Creates a table chart builder and enables paging with page size of 5. const builder = Charts.newTableChart(); builder.enablePaging(5);

參數

名稱	類型	說明
`pageSize`	`Integer`	資料表每頁的資料列數。

回攻員

EmbeddedTableChartBuilder：這個建構工具可用於串連。

`enablePaging(pageSize, startPage)`

啟用分頁功能，設定每頁的列數和要顯示的第一個表格頁面 (頁碼以零為基準)。

預設頁面大小為 10，預設起始頁面為 0。

// Creates a table chart builder and enables paging with page size of 5 and // displays page 2 first. const builder = Charts.newTableChart(); builder.enablePaging(5, 2);

參數

名稱	類型	說明
`pageSize`	`Integer`	資料表每頁的資料列數。
`startPage`	`Integer`	要顯示的第一個表格頁面 (頁碼以零為基準)。

回攻員

EmbeddedTableChartBuilder：這個建構工具可用於串連。

`enableRtlTable(rtlEnabled)`

新增對由右至左語言 (例如阿拉伯文或希伯來文) 的基本支援，方法是反轉表格的欄順序，讓第零欄成為最右側的欄，最後一欄則成為最左側的欄。

這不會影響基礎資料中的欄索引，只會影響顯示順序。即使使用這個選項，表格視覺化功能也不支援完整的雙向 (BiDi) 語言顯示。如果您啟用分頁 (使用 page 選項)，或因指定的高度和寬度選項小於必要表格大小，導致表格有捲軸，系統會忽略這個選項。預設行為為停用 RTL 支援。

參數

名稱	類型	說明
`rtlEnabled`	`Boolean`	如果應啟用由右至左的支援功能，則為 `true`，否則為 `false`。

回攻員

EmbeddedTableChartBuilder：這個建構工具可用於串連。

`enableSorting(enableSorting)`

設定使用者點選欄標題時是否要排序欄。

如果啟用排序功能，使用者點選欄標題時，系統會自動排序資料列。預設行為為啟用排序功能。

參數

名稱	類型	說明
`enableSorting`	`Boolean`	`true` 啟用排序功能 (按一下欄標題即可排序)，`false` 否則請停用。

回攻員

EmbeddedTableChartBuilder：這個建構工具可用於串連。

`getChartType()`

傳回目前的圖表類型。

回攻員

ChartType - 圖表類型。

`getContainer()`

傳回圖表 ContainerInfo，其中封裝了圖表在工作表上的顯示位置。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  const chartBuilder = sheet.newChart()                          .setChartType(Charts.ChartType.BAR)                          .addRange(sheet.getRange('A1:B8'))                          .setPosition(5, 5, 0, 0);  // This method returns the exact same data as Chart#getContainerInfo() const containerInfo = chartBuilder.getContainer();  // Logs the values used in setPosition() Logger.log(     'Anchor Column: %s\r\nAnchor Row %s\r\nOffset X %s\r\nOffset Y %s',     containerInfo.getAnchorColumn(),     containerInfo.getAnchorRow(),     containerInfo.getOffsetX(),     containerInfo.getOffsetY(), );

回攻員

ContainerInfo：包含圖表容器位置的物件。

`getRanges()`

傳回目前為這個圖表提供資料的範圍清單副本。使用 addRange(range) 和 removeRange(range) 修改這份清單。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  const chartBuilder = sheet.newChart()                          .setChartType(Charts.ChartType.BAR)                          .addRange(sheet.getRange('A1:B8'))                          .setPosition(5, 5, 0, 0);  const ranges = chartBuilder.getRanges();  // There's only one range as a data source for this chart, // so this logs "A1:B8" for (const i in ranges) {   const range = ranges[i];   Logger.log(range.getA1Notation()); }

回攻員

Range[]：做為要建構圖表資料來源的範圍陣列。

`removeRange(range)`

從這個建構工具修改的圖表中移除指定範圍。如果範圍不在這個圖表中，不會擲回錯誤。

移除的範圍必須與透過 addRange(range) 新增的範圍相符，否則圖表不會有任何變更。這個方法無法用來從範圍中部分移除值。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  const firstRange = sheet.getRange('A1:B5'); const secondRange = sheet.getRange('A6:B8');  const chartBuilder = sheet.newChart()                          .setChartType(Charts.ChartType.BAR)                          .addRange(firstRange)                          // This range renders in a different color                          .addRange(secondRange)                          .setPosition(5, 5, 0, 0);  // Note that you can use either of these two formats, but the range // MUST match up with a range that was added via addRange(), or it // is not removed, and does not throw an exception chartBuilder.removeRange(firstRange); chartBuilder.removeRange(sheet.getRange('A6:B8'));  const chart = chartBuilder.build();  sheet.insertChart(chart);

參數

名稱	類型	說明
`range`	`Range`	要移除的範圍。

回攻員

EmbeddedChartBuilder：這個建構工具用於鏈結。

`setChartType(type)`

變更圖表類型。目前僅支援部分嵌入式圖表類型。詳情請參閱 ChartType。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  const range = sheet.getRange('A1:B5'); const chart = sheet.newChart()                   .setChartType(Charts.ChartType.BAR)                   .addRange(range)                   .setPosition(5, 5, 0, 0)                   .build();  sheet.insertChart(chart);

參數

名稱	類型	說明
`type`	`ChartType`	要將這個圖表變更為的類型。

回攻員

EmbeddedChartBuilder：這個建構工具用於鏈結。

`setFirstRowNumber(number)`

設定資料表第一列的列號。

第一個資料列的預設列號為 1。

// Creates a table chart builder and sets the first row to be 2. const builder = Charts.newTableChart(); builder.setFirstRowNumber(2);

參數

名稱	類型	說明
`number`	`Integer`	資料表第一列的列號。

回攻員

EmbeddedTableChartBuilder：這個建構工具可用於串連。

`setHiddenDimensionStrategy(strategy)`

設定隱藏資料列和資料欄的策略。預設值為 IGNORE_ROWS。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  const range = sheet.getRange('A1:B5'); const chart = sheet.newChart()                   .setChartType(Charts.ChartType.BAR)                   .addRange(range)                   .setHiddenDimensionStrategy(                       Charts.ChartHiddenDimensionStrategy.IGNORE_COLUMNS,                       )                   .setPosition(5, 5, 0, 0)                   .build();  sheet.insertChart(chart);

參數

名稱	類型	說明
`strategy`	`ChartHiddenDimensionStrategy`	隱藏資料列和資料欄的策略。

回攻員

EmbeddedChartBuilder：這個建構工具用於鏈結。

`setInitialSortingAscending(column)`

設定表格應根據哪個欄的索引進行初始排序 (遞增)。

系統會以遞增順序排序資料欄，並以小箭頭標示。

// Creates a table chart builder and sorts it by the second column (ascending). const builder = Charts.newTableChart(); builder.setInitialSortingAscending(2);

參數

名稱	類型	說明
`column`	`Integer`	表格應根據哪個資料欄進行初始排序。

回攻員

EmbeddedTableChartBuilder：這個建構工具可用於串連。

`setInitialSortingDescending(column)`

設定表格的初始排序依據欄索引 (遞減)。

該欄會以遞減順序排序，並標示一個小箭頭。

// Creates a table chart builder and sorts it by the second column (descending). const builder = Charts.newTableChart(); builder.setInitialSortingDescending(2);

參數

名稱	類型	說明
`column`	`Integer`	表格應根據哪個資料欄進行初始排序。

回攻員

EmbeddedTableChartBuilder：這個建構工具可用於串連。

`setMergeStrategy(mergeStrategy)`

設定存在多個範圍時要使用的合併策略。如果是 MERGE_ROWS，系統會合併列；如果是 MERGE_COLUMNS，系統會合併欄。預設值為 MERGE_COLUMNS。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  const range = sheet.getRange('A1:B10'); const range2 = sheet.getRange('C:C10'); const chart = sheet.newChart()                   .setChartType(Charts.ChartType.BAR)                   .addRange(range)                   .addRange(range2)                   .setMergeStrategy(Charts.ChartMergeStrategy.MERGE_ROWS)                   .setPosition(5, 5, 0, 0)                   .build();  sheet.insertChart(chart);

參數

名稱	類型	說明
`mergeStrategy`	`ChartMergeStrategy`	要使用的合併策略。

回攻員

EmbeddedChartBuilder：這個建構工具用於鏈結。

`setNumHeaders(headers)`

設定範圍中應視為標題的列數或欄數。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  const range = sheet.getRange('A1:B5'); const chart = sheet.newChart()                   .setChartType(Charts.ChartType.BAR)                   .addRange(range)                   .setNumHeaders(1)                   .setPosition(5, 5, 0, 0)                   .build();  sheet.insertChart(chart);

參數

名稱	類型	說明
`headers`	`Integer`	要視為標題的列數或欄數。負值會導致系統自動偵測標題。

回攻員

EmbeddedChartBuilder：這個建構工具用於鏈結。

`setOption(option, value)`

設定這張圖表的進階選項。如要查看可用選項清單，請參閱圖表設定選項。

這個方法不會驗證您指定的選項是否適用於這個圖表類型，也不會驗證值是否為正確的格式/結構。

這個範例說明如何變更標題及設定圖例。

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); const sheet = spreadsheet.getSheets()[0]; const chart = sheet.newChart()  .setOption('title', 'Earnings projections')  .setOption('legend', {    position: 'top',    textStyle: { color: 'blue', fontSize: 16 },  }).build();

參數

名稱	類型	說明
`option`	`String`	選項名稱。
`value`	`Object`	選項的值。

回攻員

EmbeddedChartBuilder：這個建構工具用於鏈結。

`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`

設定圖表在工作表中的位置。anchorRowPos 和 anchorColPos 是以 1 為索引。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  const range = sheet.getRange('A1:B5'); const chart = sheet.newChart()                   .setChartType(Charts.ChartType.BAR)                   .addRange(range)                   .setPosition(5, 5, 0, 0)                   .build();  sheet.insertChart(chart);

參數

名稱	類型	說明
`anchorRowPos`	`Integer`	圖表的頂端會固定在這個資料列中。
`anchorColPos`	`Integer`	圖表的左側會錨定在這個資料欄中。
`offsetX`	`Integer`	圖表右上角會偏移這麼多像素。
`offsetY`	`Integer`	圖表左下角會偏移這麼多像素。

回攻員

EmbeddedChartBuilder：這個建構工具用於鏈結。

`setTransposeRowsAndColumns(transpose)`

設定是否要轉置圖表的列和欄。如果設為 true，系統會切換資料列和資料欄。預設值為 false。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  const range = sheet.getRange('A1:B5'); const chart = sheet.newChart()                   .setChartType(Charts.ChartType.BAR)                   .addRange(range)                   .setTransposeRowsAndColumns(true)                   .setPosition(5, 5, 0, 0)                   .build();  sheet.insertChart(chart);

參數

名稱	類型	說明
`transpose`	`Boolean`	如果使用 `true`，則用於建構圖表的列和欄會轉置。

回攻員

EmbeddedChartBuilder：這個建構工具用於鏈結。

`showRowNumberColumn(showRowNumber)`

設定是否要在表格的第一欄顯示列號。

系統預設不會顯示列號。

參數

名稱	類型	說明
`showRowNumber`	`Boolean`	`true`：如果表格的第一欄應顯示列號，請使用這個值； `false`：否則請使用這個值。

回攻員

EmbeddedTableChartBuilder：這個建構工具可用於串連。

`useAlternatingRowStyle(alternate)`

設定是否要為表格圖表的奇數和偶數列指派交替顏色樣式。

預設行為是讓資料列採用交替顏色樣式。

參數

名稱	類型	說明
`alternate`	`Boolean`	如果顏色樣式應交替，則為 `true`，否則為 `false`。

回攻員

EmbeddedTableChartBuilder：這個建構工具可用於串連。

Class EmbeddedTableChartBuilder 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

方法

內容詳盡的說明文件

addRange(range)

參數

回攻員

asAreaChart()

回攻員

asBarChart()

回攻員

asColumnChart()

回攻員

asComboChart()

回攻員

asHistogramChart()

回攻員

asLineChart()

回攻員

asPieChart()

回攻員

asScatterChart()

回攻員

asTableChart()

回攻員

build()

回攻員

clearRanges()

回攻員

enablePaging(enablePaging)

參數

回攻員

enablePaging(pageSize)

參數

回攻員

enablePaging(pageSize, startPage)

參數

回攻員

enableRtlTable(rtlEnabled)

參數

回攻員

enableSorting(enableSorting)

參數

回攻員

getChartType()

回攻員

getContainer()

回攻員

getRanges()

回攻員

removeRange(range)

參數

回攻員

setChartType(type)

參數

回攻員

setFirstRowNumber(number)

參數

回攻員

setHiddenDimensionStrategy(strategy)

參數

回攻員

setInitialSortingAscending(column)

參數

回攻員

setInitialSortingDescending(column)

參數

回攻員

setMergeStrategy(mergeStrategy)

參數

回攻員

setNumHeaders(headers)

參數

回攻員

setOption(option, value)

參數

回攻員

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

參數

回攻員

setTransposeRowsAndColumns(transpose)

Class EmbeddedTableChartBuilder

`addRange(range)`

`asAreaChart()`

`asBarChart()`

`asColumnChart()`

`asComboChart()`

`asHistogramChart()`

`asLineChart()`

`asPieChart()`

`asScatterChart()`

`asTableChart()`

`build()`

`clearRanges()`

`enablePaging(enablePaging)`

`enablePaging(pageSize)`

`enablePaging(pageSize, startPage)`

`enableRtlTable(rtlEnabled)`

`enableSorting(enableSorting)`

`getChartType()`

`getContainer()`

`getRanges()`

`removeRange(range)`

`setChartType(type)`

`setFirstRowNumber(number)`

`setHiddenDimensionStrategy(strategy)`

`setInitialSortingAscending(column)`

`setInitialSortingDescending(column)`

`setMergeStrategy(mergeStrategy)`

`setNumHeaders(headers)`

`setOption(option, value)`

`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`

`setTransposeRowsAndColumns(transpose)`

`showRowNumberColumn(showRowNumber)`

`useAlternatingRowStyle(alternate)`