本 API 建立一個新的電子表格匯出物件。使用此物件從表格資料構建和下載 Office Open XML 電子表格格式的電子表格檔案。此功能通常與 UI5 表一起使用。

該類使用來自指定資料來源的表格資料構建 Office Open XML 電子表格格式的電子表格。檢索資料並在瀏覽器的工作執行緒中非同步構建文件。 程式的狀態在可以被設定為隱藏的進度對話方塊中直觀地呈現給使用者。 使用者可以使用對話方塊的取消按鈕取消該過程。

此類提供用於電子表格匯出的低階 API。 sap.ui.comp.smarttable.SmartTable 控制元件在內部實現它並提供開箱即用的匯出功能。

除了上述預設功能外，該 API 還支援下列可選功能：

- 隱藏進度對話方塊。
- 棄用 worker 並在主執行緒中執行文件生成過程。
- 配置匯出的檔名。

要開始匯出，請建立一個新的 sap.ui.export.Spreadsheet 物件並呼叫構建方法。 必須在建構函式中提供列配置、資料來源和匯出設定。 build 方法開啟一個進度對話方塊並啟動一個非同步匯出過程。 匯出過程從資料來源獲取資料行，在工作執行緒中在瀏覽器中構建電子表格，最後將文件下載到客戶端。

示例程式碼：

```javascript
var oSpreadsheet = new sap.ui.export.Spreadsheet(mSettings);
  oSpreadsheet.build();
```

此外，還可以附加 onprogress 事件偵聽器以接收有關匯出進度的通知，並跟蹤返回的 Promise 的完成狀態。

例子程式碼：

```javascript
var oSpreadsheet = new sap.ui.export.Spreadsheet(mSettings);
  oSpreadsheet.onprogress = function(iValue) {
  	{@link sap.base.Log#debug Log.debug}("Export: %" + iValue + " completed");
  };
  oSpreadsheet.build()
    .then( function() { {@link sap.base.Log#debug Log.debug}("Export is finished"); })
    .catch( function(sMessage) { {@link sap.base.Log#error Log.error}("Export error: " + sMessage); });
```

column configuration 的例子：

```javascript
 var aColumns = [];
  aColumns.push({
  	label: "Name",
  	property: "name"
  });
  aColumns.push({
    label: "Salary",
    property: "salary",
    type: "number",
    scale: 2
  });

SAP UI5 sap.ui.export.Spreadsheet API 介紹

相關文章