JS API相容說明

本文將介紹 Finereport 10.0 升級至 11.0 時官方 JavaScript API的變化，使用者範本中如果使用了 javaScript 程式碼，版本升級時，需要仔細閱讀本篇文檔。

注：11.0 所有新增API 10.0 下不支援，詳情可查看 API匯總 中API支援的範圍。

2.1 11.0 和 10.0 API使用說明

API匯總中列出來的API即為 11.0 所有官方支援的API，10.0 範本不一定能使用，建議 10.0 使用者直接查看 10.0 相關文檔，謹慎使用 11.0 的API。

1）10.0 中有但 11.0 API 中未列出的API，建議使用者謹慎使用，可能會存在相容性問題。

2）有部分API，雖然在 10.0 和 11.0 下名稱一致，但可能呼叫方法、繼承來源的物件不一樣，建議參考 11.0 的API介紹文檔，不要盲目使用。

2.2 contentPane 物件廢棄

11.0 廢棄了 contentPane 物件，contentPane 物件上的大部分方法轉移到 _g() 獲取的報表物件上。廢棄的 contentPane 物件及其上的方法在 11.0 中可以使用，但後續不會隨版本迭代更新，即在 11.0 上使用會存在相容風險，建議使用者謹慎使用。

1）contentPane 物件上廢棄的API在 11.0 API 中幾乎都有替代API，少量無替代的持續更新中，使用者參考 11.0 API 使用即可。

2）使用者升級後，若範本中使用了 contentPane 物件此類舊API，需要特別注意，建議參考 11.0 API 修改為新API。

2.3 非官方API程式碼方案

透過 jQuery、CSS 獲取 HTML DOM 元素修改前端樣式的程式碼方案，和報表前端架構息息相關，版本升級時，相容性非常不好，建議使用者謹慎使用。

1）10.0 升級後若此類方案不生效，根據當前前端重新修改程式碼即可。

2）11.0 開發範本時，建議使用者使用官方API，避免使用非官方API，若使用者使用非官方API出現問題，官方將不協助排查問題。

2.4 新舊決策報表下的使用問題

使用者從 10.0 升級到 11.0 時，決策報表預設為舊版決策報表，舊版決策報表不能使用 10.0 新版決策報表以及 11.0 新增的API，可以切換至新版決策報表下使用 11.0 新增的API，如何切換可查看：切換新舊決策報表

1）如果使用者要使用 11.0 的API，要切換成新版決策報表。

2）舊版本對應的是 10.0 決策報表前端，10.0 API的範本可以在舊決策報表下使用，但為了避免後續可能會發生的相容風險，建議使用者轉換成新版本，使用 11.0 的API。

2.5 新計算引擎下的使用問題

11.0 將新計算引擎內建，使用者升級後，如果 10.0 範本中使用了 JS 程式碼，且範本開啟了新計算引擎，會存在相容風險，建議使用者直接將程式碼修改為 11.0 API 中支援的API。

問題描述

在範本中加入 JavaScript 後，預覽範本時，報錯 CustomJSError : _XXXXXXXX.submit is not a function

原因分析

程式碼中寫的API或者方法不存在。

解決方法

檢查程式碼中使用的API有沒有拼寫錯誤；檢查程式碼中使用的API在當前環境下是否支援，如：

• 10.0 的範本用了只 11.0 支援的API

• 舊版決策報表用了只 11.0 支援的API

檢查後對應修改正確即可。