適用場景:安裝了「FineVis資料視覺化」插件的使用者,可參考本文了解 FineVis 範本的相關API。
版本
報表伺服器版本 | 插件版本 | 功能變動 |
---|---|---|
11.0.16 | V1.15.1 | FVS圖表組件適配 API API |
注:本文API不支援 FineVis 中 擴展圖表 類型的圖表組件。
duchamp.getWidgetByName
方法 | duchamp.getWidgetByName("widgetName") | 獲取圖表組件物件,獲取後可以使用組件的方法和屬性 注:暫不支援獲取表格中的圖表 |
---|---|---|
參數 | widgetName | FVS 圖表組件名稱 |
回傳值 | object | 當前圖表組件物件 |
範例 | 範例:獲取「柱形圖組件」物件 duchamp.getWidgetByName("柱形圖組件") | |
應用範例 | - | |
行動端 | 支援行動端 |
getSeries
方法 | getSeries() | 獲取系列物件陣列 |
---|---|---|
參數 | - | - |
回傳值 | series[] | 當前圖表組件系列陣列 |
範例 | 範例:獲取「柱形圖組件」物件的系列陣列
| |
應用範例 | - | |
行動端 | 支援行動端 |
series
方法 | series[seriesIndex] | 獲取系列物件 |
---|---|---|
參數 | seriesIndex | 預設圖表物件有一個 series 屬性,該物件儲存的是圖表內系列相關的資料資訊,是一個物件陣列。如果想要獲得圖表中某一個具體的系列物件,則需要指定對應的索引 seriesIndex,seriesIndex 從 0 開始計數 |
範例 | 範例:獲取「柱形圖組件」物件的第一個系列物件
注:寫在一起時正確寫法為 getSeries()[0] ,不支援 getSeries().series[0] | |
應用範例 | - | |
行動端 | 支援行動端 |
series 屬性
屬性 | 類型 | 說明 |
---|---|---|
points | Array | 當前系列的所有資料點 |
name | String | 當前系列的名稱,跟圖例顯示的系列名一致 |
type | String | 當前系列的圖表類型,目前包括的類型如下圖所示: |
series.points
方法 | series.points[pointIndex] | 獲取資料點物件 需在獲取圖表系列物件之後使用 |
---|---|---|
參數 | pointIndex | 每個 series 物件裏面又有一個 points 的屬性,也是一個物件陣列,這個 points 陣列裏面存放的就是我們想要的 point 資料點物件。 如果需要獲取某個具體的資料點物件,則需要指明該資料點的索引 pointIndex,pointIndex 從 0 開始計數 |
範例 | 範例:獲取「柱形圖組件」物件的第一個系列物件的第一個資料點
| |
行動端 | 支援行動端 |
points 屬性
屬性 | 類型 | 說明 |
---|---|---|
name | String | 對於區域地圖來說,name 表示當前資料點的區域名,比如江蘇省,南通市等等 |
seriesName | String | 當前資料點所在的系列名 |
category | String | 對於坐標軸圖,表示資料點所在分類的名稱 |
categroyArray | Array | 對於 多分類坐標軸圖,表示資料點所在分類陣列的名稱 |
value | Number | 對於坐標軸圖,表示資料點在值軸對應的數值 注:散點圖的 value 對應「值」欄位的數值 |
series | Object | 當前資料點所在的系列 |
setSeriesVisible
方法 | setSeriesVisible() | 圖表顯示部分系列 |
---|---|---|
參數 | seriesIndex[] | seriesIndex:number 表示一個圖表中不同的系列,從 0 開始計數 |
回傳值 | - | - |
範例 | 範例:顯示柱形圖組件的系列1和系列2
| |
應用範例 | - | |
行動端 | 支援行動端 |
sortChart
方法 | sortChart(sortType) | 圖表排序API |
---|---|---|
參數 | sortType | sortType 參數表示排序規則,1 表示升冪,-1 表示降冪,不寫參數則升冪降冪互相切換 |
回傳值 | - | - |
範例 | 範例:
| |
應用範例 | - | |
行動端 | 支援行動端 |
openAutoTooltip
注:擴展圖表類型僅支援特殊形狀柱形圖。
方法 | openAutoTooltip([delay, initPoints]) | 資料點提示輪播API |
---|---|---|
參數 | delay, initPoints | delay 資料點提示的切換時間間隔,預設為 3s initPoints 輪播資料點提示對應的資料點集合,預設為圖表內所有資料 注:V2.4.0 及之後版本才支援使用 initPoints |
回傳值 | - | - |
範例 | 範例1:
注:3000代表輪播時間間隔3秒,可自行調整
| |
應用範例 | ||
行動端 | 支援行動端 |
setMapZoom
方法 | setMapZoom(mapZoom) | 設定地圖縮放等級和中心點 |
---|---|---|
參數 | MapZoomProps = { zoomLevel: number | string; viewCenter: [number, number]; }; | zoomLevel:縮放等級,值區間一般在0-18。數值越大,層級越高,地圖顯示越細緻,顯示的經緯度範圍越小 viewCenter:中心點,[經度,緯度] |
回傳值 | - | - |
範例 | 範例:
| |
應用範例 | - | |
行動端 | 支援行動端 |
getZoom
方法 | getZoom() | 獲取地圖縮放層級 |
---|---|---|
參數 | - | - |
回傳值 | number | 縮放等級,值區間一般在0-18。數值越大,層級越高,地圖顯示越細緻,顯示的經緯度範圍越小 |
範例 | 範例: duchamp.getWidgetByName("地圖1").getZoom(); | |
應用範例 | - | |
行動端 | 支援行動端 |
getCenter
方法 | getCenter() | 獲取地圖中心點 |
---|---|---|
參數 | - | - |
回傳值 | [number, number] | 中心點,[經度,緯度] |
範例 | 範例: duchamp.getWidgetByName("地圖1").getCenter(); | |
應用範例 | - | |
行動端 | 支援行動端 |
panTo
方法 | panTo(center) | 地圖轉移中心點 |
---|---|---|
參數 | center | center 中心點,[緯度,經度] 注:panTo API中「緯度」在前,「經度」在後 |
回傳值 | - | - |
範例 | 範例: duchamp.getWidgetByName("地圖1").panTo([40,118]); //根據經緯度行動中心點 | |
應用範例 | - | |
行動端 | 支援行動端 |
drillDown
方法 | drillDown(area) | 鑽取地圖向下鑽取 |
---|---|---|
參數 | area | area 不是單純的區域名,而是區域名下對應的一系列資訊,可根據區域名獲取到 area |
回傳值 | - | - |
範例 | 範例:
| |
應用範例 | - | |
行動端 | 支援行動端 |
drillUp
方法 | drillUp(index) | 鑽取地圖向上鑽取 |
---|---|---|
參數 | index | index:自然數,表示鑽取層級,從0開始:0、1、2…… |
回傳值 | - | - |
範例 | 範例:
| |
應用範例 | - | |
行動端 | 支援行動端 |
getLayerIndex
方法 | getLayerIndex() | 獲取鑽取地圖當前鑽取層級,獲取的層級從0開始:0、1、2…… |
---|---|---|
參數 | - | - |
回傳值 | number | 鑽取地圖當前鑽取層級 |
範例 | 範例:
| |
應用範例 | - | |
行動端 | 支援行動端 |
getLayerNames
方法 | getLayerNames() | 獲取鑽取目錄名稱,結果為陣列,例如:["中國", "湖南省", "長沙市"] |
---|---|---|
參數 | - | - |
回傳值 | string[] | 陣列,例如:["中國", "湖南省", "長沙市"] |
範例 | 範例:
| |
應用範例 | - | |
行動端 | 支援行動端 |