統計地圖API參考手冊
統計地圖API參考手冊
請點擊上方下載說明文件按鈕，下載完整統計地圖API參考手冊。
DataDB Class
| Constructor |
|---|
| DataDB(Array<DBDataSet/MultiDataSet> dataSet, DataOption option, CoordSystem coordinate, AreaSelect select) | 統計地圖API應用資料庫資料集物件 參數說明： dataSet: 以陣列方式設定來源統計資料，若欲繪製之統計地圖/圖表為單變數類型如面量圖、分級符號圖，則僅須填入單一統計資料 options: 來源統計資料設定 coordinate: 坐標系統設定 select: 資料篩選設定 |
| Methods |
|---|
| setDataset(Array<DBdataset dataset>) | 設定來源統計資料 |
| getDataset( ) | 取得來源統計資料（回傳值：Array<Dbdataset dataset>） |
| setCoordSystem(CoordSystem coordinate) | 設定坐標系統 |
| getCoordSystem( ) | 取得坐標系統設定值（回傳值：CoordSystem coordinate） |
| setAreaSelect(AreaSelect select) | 設定資料篩選條件 |
| getAreaSelect( ) | 取得資料篩選條件（回傳值：AreaSelect select） |
| setDataOption(DataOption option) | 設定來源統計資料設定 |
| getDataOption( ) | 取得來源統計資料設定（回傳值：DataOption option） |
DBDataSet
| Properties |
|---|
| string tableName | 統計表名稱（必填） |
| Array<string> fieldsID | 欄位名稱（必填） |
MultiDataSet
| Properties |
|---|
| string tableName | 統計表名稱（必填） |
| Array<string> fieldsID | 欄位名稱（必填） |
| string to | 設定統計資料代碼名稱（必填） |
| string time | 統計資料時間代碼（必填） |
DataOwn Class
| Constructor |
|---|
| DataOwn(Array<DBDataSet> dataSet ,DataOption option, CoordSystem coordinate, AreaSelect select) | 自有統計資料集物件 參數說明： dataSet: 以陣列方式設定來源統計資料，若欲繪製之統計地圖/圖表為單變數類型如面量圖、分級符號圖，則僅須填入單一統計資料 options: 來源統計資料設定 coordinate: 坐標系統設定 select: 資料篩選設定 |
| Methods |
|---|
| setDataset(Array<DBdataset dataset>) | 設定來源統計資料 |
| getDataset( ) | 取得來源統計資料（回傳值：Array<Dbdataset dataset>） |
| setCoordSystem(CoordSystem coordinate) | 設定坐標系統 |
| getCoordSystem( ) | 取得坐標系統設定值（回傳值：CoordSystem coordinate） |
| setAreaSelect(AreaSelect select) | 設定資料篩選條件 |
| getAreaSelect( ) | 取得資料篩選條件（回傳值：AreaSelect select） |
| setDataOption(DataOption option) | 設定來源統計資料設定 |
| getDataOption( ) | 取得來源統計資料設定（回傳值：DataOption option） |
OwnDataSet
| Properties |
|---|
| string tableSrc |
統計表來源，填入自備統計資料之URL（必填） 支援資料類型：符合格式之XML與GeoJSON GeoJSON僅支援點(point)與多邊形(polygon、multipolygon)幾何資料 |
| Array<string> fieldsID | 填入使用欄位ID（必填） |
StatMap Class
| Constructor |
|---|
| StatMap(object containerObj, [DataDB/DataOwn] dataobj, string mapKind, MapOptions mapOpts) | 繪製統計地圖物件 參數說明： containerObj: 若須輸出互動式地圖介面，則填入該網頁物件容器之DIV ID，不須輸出則填入'null' dataObj: 統計資料來源設定，可使用「統計地圖API應用資料庫資料集物件（DataDB）」或「自有統計資料集物件（DataOwn）」 MapKind: 統計地圖類型設定，以字串方式填入指定類型 面量圖：CHOROPLETH 柱狀圖：BAR 圓餅圖：PIE 分級符號圖：SYMBOL mapOpts: 統計地圖參數設定 |
| Methods |
|---|
| drawMap(Function callback(StatMapResult result)) | 繪製統計地圖。Function callback內包含統計地圖繪製結果(StatMapResult result) |
| appendLayer(StatLayer statLayer , Function callback(StatMapResult result)) | 繪製疊加統計地圖圖層。指定疊加圖層物件StatLayer後，由Function callback中取出統計地圖繪製結果(StatMapResult result) |
| removeLayer(StatLayer statLayer) | 指定疊加圖層物件StatLayer後由互動式介面中移除疊加統計地圖圖層。 |
| freezeMap() | 凍結互動式地圖圖台視窗 |
| unfreezeMap() | 解凍互動式地圖圖台視窗 |
| calcClassify(choroplethSets pChoropleth, Function callback(CalcResult result)) | 計算面量圖分級 |
| setContainer(object containerObj) | 設定互動式地圖介面之網頁物件容器DIV ID |
| getContainer( ) | 取得互動式地圖介面之網頁物件容器DIV ID |
| setContainerLegend(object containerLegend) | 設定互動式圖例之網頁物件容器DIV ID |
| getContainerLegend( ) | 取得互動式圖例之網頁物件容器DIV ID |
| setContainerData(object containerData) | 設定互動式資料清單之網頁物件容器DIV ID |
| getContainerData( ) | 取得互動式資料清單之網頁物件容器DIV ID |
| setContainerMix(object containerMix) | 設定混合型資料(機構別)圖形之網頁物件容器DIV ID |
| getContainerMix() | 取得混合型資料(機構別)圖形之網頁物件容器DIV ID |
| setColor(string/array ) | 設定向量式圖磚動態配色資訊，輸入dynamicColor物件中設定之色系名稱或是顏色陣列(需配合匯出向量試圖磚設定使用) |
| setStatData([DataDB/DataOwn] dataobj) | 設定統計資料來源 |
| getStatData( ) | 取得統計資料來源（回傳值：[DataDB/DataOwn] dataobj） |
| setMapKind(string mapKind) | 設定統計地圖類型 |
| getMapKind( ) | 取得統計地圖類型（回傳值：string mapKind） |
| setMapOptions(MapOptions mapOpts) | 設定統計地圖參數 |
| getMapOptions( ) | 取得統計地圖參數（回傳值：MapOptions mapOpts） |
StatLayer
| Constructor |
|---|
| StatLayer([DataDB/DataOwn] dataobj, string mapKind, MapOptions mapOpts) | 統計地圖疊加圖層物件 參數說明： dataObj: 統計資料來源設定，可使用「統計地圖API應用資料庫資料集物件（（DataDB）」或「自有統計資料集物件（DataOwn）」 MapKind: 統計地圖類型設定，以字串方式填入指定類型 面量圖：CHOROPLETH 柱狀圖：BAR 圓餅圖：PIE 分級符號圖：SYMBOL mapOpts: 統計地圖參數設定 |
| Methods |
|---|
| setStatData([DataDB/DataOwn] dataobj) | 設定統計資料來源 |
| getStatData( ) | 取得統計資料來源（回傳值：[DataDB/DataOwn] dataobj） |
| setMapKind(string mapKind) | 設定統計地圖類型 |
| getMapKind( ) | 取得統計地圖類型（回傳值：string mapKind） |
| setMapOptions(MapOptions mapOpts) | 設定統計地圖參數 |
| getMapOptions( ) | 取得統計地圖參數（回傳值：MapOptions mapOpts） |
MapOptions
| Properties |
|---|
| boolean drillDown | 是否開啟資料下探功能，預設為false。 開啟此參數後，DataLevel表初始呈現資料層級。 |
| boolean quickDraw | 是否使用暫存資料集繪製地圖，預設為false |
| boolean exportImage | 是否輸出純影像統計地圖，預設為false |
| BaseLevel baseLevel | 互動式統計地圖預設底圖層級，預設為縣市層級 縣市: COUNTY 鄉鎮市區: TOWN 村里: VILLAGE |
| Envelope envelope | 以地理坐標限制 |
| boolean useBasemap | 輸出之統計地圖影像是否包含 |
| string baseType | 設定純影像輸出底圖類型，預設為基本行政區界底圖 統計區地圖：STATMAP 基本行政區界底圖：BASIC |
| boolean exportStatData | 是否輸出statData，預設為true |
| boolean exportStatInfo | 是否輸出statInfo，預設為true |
| boolean exportLegend | 是否輸出各式legend，預設為true |
| InfoOptions infoOpts | 互動式訊息視窗客製化參數集合 |
| ImageSize size | 統計地圖影像尺寸設定 |
| number opacity | 統計地圖透明度設定，可填入0~1之間的小數，預設為不透明(1) |
| boolean exportKML | 統計地圖是否輸出KML格式檔案，預設為false |
| boolean exportVectorTile | 匯出向量式圖磚結果，預設為false |
| boolean closeMapObj | 隱藏所有互動式圖台元件，預設為false |
| boolean autoZoom | 互動式介面關閉自動縮放效果，預設為false。 |
| choroplethSets pChoropleth | 面量圖參數設定集合 |
| barSets pBar | 柱狀圖參數設定集合 |
| pieSets pPie | 圓餅圖參數設定集合 |
| symbolSets pSymbol | 分級符號圖參數設定集合 |
InfoOptions
| Properties |
|---|
| string activateMode | 互動式效果觸發模式，預設為滑鼠移動即觸發(MOUSEMOVE) 滑鼠移動：MOUSEMOVE 滑鼠經過：MOUSEOVER 滑鼠點擊：CLICK 滑鼠雙擊：DBLCLICK |
| string infoColor | 互動訊息視窗背景色，，格式為16進位RGB(#RRGGBB)，預設為白色(#FFFFFF) |
| number opacity | 透明度設定，可填入0~1之間的小數，預設為不透明(1) |
ChoroplethSets
| Properties |
|---|
| string classifyMethod | 分級方法，預設為等距法： 等距法: EQUALINTERVAL 去除前後5％資料等距法:EQUALINTERVA5 等量法: QUANTILE 自訂間距: USER_DEFINED (自訂間距值設定請參照userLevels) |
| int classes | 使用系統提供分級法之分級數設定。可填入整數2~10，未填入之預設值為5。 |
| array userLevels | 自訂統計分級區間設定，由小至大依序於陣列內輸入分級區間值(包括最小及最大值) 例：輸入[100, 300, 700, 900]表示分為三級，第一級為100~300；第二級為300~700；第三級為700~900 |
| ValueSelect valueSelect | 統計值篩選設定，非必填，預設為不篩選 不篩選: DEFAULT 所有統計值由大至小排序後取前十筆統計資料: TOP_TEN 所有統計值由大至小排序後取最後十筆統計資料: LAST_TEN |
| string statTime | 繪製時序性面量圖時使用，填入欲作為分級標準之統計時間點，若未填則以資料集中最後一個時間點作為分級標準(可判別的時間格式) |
| boolean KMLwithZ | 輸出之KML檔案是否附帶Z值，以在三維圖台呈現立體效果，預設為false |
| [ColorSettings/Array<string [#RRGGBB]> color | 統計圖配色設定，可由物件ColorSettings取得或是自訂區間配色，若兩者皆未設定則以紅色漸層進行配色。 若使用自訂配色設定，以陣列方式輸入16進位RGB (#RRGGBB)格式之配色集合，輸出之面量圖將依照配色集依序填入各個分級區間。未設定之分級項則由系統自動進行配色。 |
| object dynamicColor | 動態調整面量圖向量磚配色設定 |
| LabelSettings label | 文字標記設定，由物件LabelSettings取得，若未設定則不進行文字標記 |
| boolean useInt | 是否使用整數進行統計計算及展示（非必填，預設使用資料庫對統計欄位是否為整數的定義進行設定，也可自行定義本屬性） |
ColorSettings
| Properties |
|---|
| string maxColor | 統計最大值色彩，格式為16進位RGB(#RRGGBB)，預設為深紅色(#4A1010) |
| string minColor | 統計最小值色彩，格式為16進位RGB(#RRGGBB)，預設為淺灰色(#D4D4D4) |
| string defaultColor | 預設色彩，於統計值為NULL時顯示，格式為16進位RGB(#RRGGBB)，預設為白色(#FFFFFF) |
LabelSettings
| Properties |
|---|
| string contentType | 文字標記內容，預設為ALL 行政區/統計區名稱：NAME 行政區/統計區全名：FULLNAME 統計值：VALUE 名稱 + 統計值：ALL |
| string LocateType | 文字標記定位方式，預設為GRAVITY 特定位置(與分級符號位置相同)：SPECIFY 行政區重心位置：GRAVITY 當使用SPECIFY設定後，將無法控制文字是否重疊。 |
| string weight | 文字字體設定，預設為NORMAL 正常：NORMAL 粗體：BOLD |
| number labelSize | 文字大小，單位為pt，預設值為14 |
| string color | 標記文字配色，格式為16進位RGB(#RRGGBB)，預設為深灰色(#333333) |
| boolean outline | 是否加上文字暈圈，預設為不使用(false) |
| string outlineColor | 文字暈圈配色，格式為16進位RGB(#RRGGBB)，預設為白色(#FFFFFF) |
| boolean overlay | 是否允許文字標記互相重疊，若設為false則程式將自動計算文字標記位置並且隱藏部份標記文字，預設值為true |
BarSets
| Properties |
|---|
| number maxHeight | 最大柱高設定，單位為pixel，若未設定則系統將自動計算適合大小後套用 |
| number barWidth | 柱寬設定，單位為pixel，若未設定則系統將自動計算適合大小後套用 |
| boolean chartView | 是否在互動式訊息視窗中顯示詳細圖表，預設為false |
| Array<string [#RRGGBB]> color | 配色設定，以陣列方式輸入16進位RGB(#RRGGBB)格式之配色集合，輸出之柱狀圖將依照配色集依序填入各個資料柱。若未設定則系統將自動進行配色 |
PieSets
| Properties |
|---|
| number size | 圓餅大小設定，單位為pixel，若未設定則系統將自動計算適合大小後套用 |
| boolean chartView | 是否在互動式訊息視窗中顯示詳細圖表，預設為false |
| Array<string [#RRGGBB]> color | 配色設定，以陣列方式輸入16進位RGB(#RRGGBB)格式之配色集合，輸出之圓餅圖將依照配色集依序填入各個資料分塊。若未設定則系統將自動進行配色 |
SymbolSets
| Properties |
|---|
| string ClassifyMethod |
分級方法，預設為等距法： (自訂間距值設定請參照userLevels) |
| int classes | 使用系統提供分級法之分級數設定。可填入整數2~10，未填入之預設值為5 |
| array userLevels | 自訂統計分級區間設定，由小至大依序於陣列內輸入分級區間值(包括最小及最大值) 例：輸入[100, 300, 700, 900]表示分為三級，第一級為100~300；第二級為300~700；第三級為700~900 |
| string SymbolStyle | 分級符號樣式設定，預設為圓形，也可選擇下列系統內建的符號樣式 圓形: CIRCLE 星形: STAR 方形: SQUARE 三角形: TRIANGLE |
| string fillColor | 符號填色色彩，格式為16進位RGB（#RRGGBB），預設為深紅色（#4A1010） |
| string outlineColor | 符號框線色彩，格式為16進位RGB（#RRGGBB），預設為黑色（#000000） |
| number outlineWidth | 符號框線線寬，單位為pixel，預設值為1 |
| string styleUrl | 自定義符號，以URL連結方式填入，支援格式為PNG |
| number maxSize | 分級符號最大尺寸，單位為pixel，若未設定則系統將自動進行尺寸設定 |
| number minSize | 分級符號最小尺寸，單位為pixel，若未設定則系統將自動進行尺寸設定 |
| boolean useInt | 是否使用整數進行統計計算及展示（非必填，預設使用資料庫對統計欄位是否為整數的定義進行設定，也可自行定義本屬性） |
MapKind
| Properties |
|---|
| string CHOROPLETH | 面量圖 |
| string BAR | 柱狀圖 |
| string PIE | 圓餅圖 |
| string SYMBOL | 分級符號圖 |
SymbolStyle
| Properties |
|---|
| string CIRCLE | 圓形 |
| string STAR | 星形 |
| string SQUARE | 方形 |
| string TRIANGLE | 三角形 |
StatChart Class
| Constructor |
|---|
| StatChart(object containerObj, [DataDB/DataOwn] dataobj, string chartKind, ChartOptions chartOpts) | 繪製統計圖表物件 參數說明： containerObj: 若須輸出互動式圖表介面，則填入該網頁物件容器之DIV ID，不須輸出則填入'null' dataObj: 統計資料來源設定，可使用「統計地圖API應用資料庫資料集物件（（DataDB）」或「自有統計資料集物件（DataOwn）」 ChartKind: 統計地圖類型設定，以字串方式填入指定類型 折線圖：LINE 柱狀圖：BAR 圓餅圖：PIE chartOpts: 統計地圖參數設定 |
| Methods |
|---|
| drawChart(Function callback(StatChartResult result)) | 繪製統計圖表。Function callback內包含統計圖表繪製結果(StatMapResult result) |
| setContainer(object containerObj) | 設定互動式圖表介面之網頁物件容器DIV ID |
| getContainer() | 取得互動式圖表介面之網頁物件容器DIV ID |
| setStatData([DataDB/DataOwn] dataobj) | 設定統計資料來源 |
| getStatData( ) | 取得統計資料來源（回傳值：[DataDB/DataOwn] dataobj） |
| setChartKind(string chartKind) | 設定統計圖表類型 |
| getChartKind( ) | 取得統計圖表類型（回傳值：string chartKind） |
| setChartOptions(MapOptions chartOpts) | 設定統計圖表參數 |
| getChartOptions( ) | 取得統計圖表參數（回傳值：MapOptions chartOpts） |
ChartOptions
| Properties |
|---|
| boolean quickDraw | 是否使用暫存資料集繪製圖表，預設為false |
| boolean exportImage | 是否輸出純影像統計圖表，預設為false |
| ImageSize size | 統計圖表影像尺寸設定 |
| InfoOptions infoOpts | 互動式訊息視窗客製化參數集合 |
| string chartTitle | 自訂圖表標題 |
| LineChartSets pLine | 折線圖參數設定集合 |
| BarChartSets pBar | 柱狀圖參數設定集合 |
| PieChartSets pPie | 圓餅圖參數設定集合 |
| boolean showAllLabel | 是否強制顯示所有互動標記，預設為false |
InfoOptions
| Properties |
|---|
| string activateMode | 互動式效果觸發模式，預設為滑鼠移動即觸發(MOUSEMOVE) 滑鼠移動：MOUSEMOVE 滑鼠經過：MOUSEOVER 滑鼠點擊：CLICK 滑鼠雙擊：DBLCLICK |
| string infoColor | 互動訊息視窗背景色，，格式為16進位RGB(#RRGGBB)，預設為白色(#FFFFFF) |
| number opacity | 透明度設定，可填入0~1之間的小數，預設為不透明(1) |
LineChartSets
| Properties |
|---|
| string xAxis | 設定X軸資料類型（必填，不可與data值相同）： 行政區/統計區/機構別: SPATIAL 統計欄位: FIELD 時序: TIME |
| string data | 設定繪製資料類型（必填，不可與xAxis值相同）： 行政區/統計區/機構別: SPATIAL 統計欄位: FIELD 時序: TIME |
| number yMin | 自行設定Y軸最小值，非必填 |
| number yMax | 自行設定Y軸最大值，非必填 |
| number yInterval | 自行設定Y軸間距值，非必填 |
| number width | 折線線寬，單位為pixel，預設值為5 |
| Array<string LineStyle> lineStyles | 折線樣式，以陣列方式輸入折線的樣式，預設皆為實線(SOLID) 實線：SOLID 虛線：DASH 點：DOT |
| Array<string #RRGGBB> color | 折線圖配色，以陣列方式輸入16進位RGB(#RRGGBB)格式之配色集合，輸出之折線圖將依照配色集依序填入各個折線。若未設定則系統將自動進行配色 |
BarChartSets
| Properties |
|---|
| string xAxis | 設定X軸資料類型（必填，不可與data值相同）： 行政區/統計區/機構別: SPATIAL 統計欄位: FIELD 時序: TIME |
| string data | 設定繪製資料類型（必填，不可與(xAxis值相同）： 行政區/統計區/機構別: SPATIAL 統計欄位: FIELD 時序: TIME |
| number yMin | 自行設定Y軸最小值，非必填 |
| number yMax | 自行設定Y軸最大值，非必填 |
| number yInterval | 自行設定Y軸間距值，非必填 |
| number barWidth | 柱寬設定，單位為pixel，若未設定則系統將自動計算適合大小後套用 |
| Array<string [#RRGGBB]> color | 配色設定，以陣列方式輸入16進位RGB(#RRGGBB)格式之配色集合，輸出之柱狀圖將依照配色集依序填入各個資料柱。若未設定則系統將自動進行配色 |
PieChartSets
| Properties |
|---|
| string pies | 設定比例資料類型（必填，不可與data值相同）： 行政區/統計區/機構別: SPATIAL 統計欄位: FIELD 時序: TIME |
| string data | 設定繪製資料類型（必填，不可與pies值相同）： 行政區/統計區/機構別: SPATIAL 統計欄位: FIELD 時序: TIME |
| number size | 圓餅大小設定，單位為pixel，若未設定則系統將自動計算適合大小後套用 |
| Array<string [#RRGGBB]> color | 配色設定，以陣列方式輸入16進位RGB(#RRGGBB)格式之配色集合，輸出之圓餅圖將依照配色集依序填入各個資料分塊。若未設定則系統將自動進行配色 |
ChartKind
| Properties |
|---|
| string LINE | 折線圖 |
| string BAR | 柱狀圖 |
| string PIE | 圓餅圖 |
Output Class
StatMapResult
| Properties |
|---|
| string dataID | 匯出暫存之統計資料集token ID |
| Array<string> imageUrl | 輸出統計地圖影像位址（PNG格式），若繪製統計地圖類型為時序性之面量圖或柱狀圖時，則依序將各時間點之統計地圖位址置於陣列中 |
| Envelope envelope | 統計地圖地理邊界 |
| string kmlUrl | 輸出統計地圖KML檔 |
| Array<[string time, string wkt<[string table, <[string code, string name, <[string field, number value, string unit]>, int classes]>]>]> statData | 以陣列方式輸出所有地圖統計資料： time: 統計時間 wkt: 行政區/統計區/機構別空間定義（統計地圖限定） table: 統計表格名稱（統計地圖API應用資料庫）或統計表檔名（自有統計資料） code: 行政區/統計區代碼或機構別ID name: 行政區/統計區/機構別名稱 field: 統計欄位名稱 value: 統計值 unit: 統計單位 classes: 分級區間（面量圖、分級符號圖限定） |
| Array<string time, [string filed, number max, number min, number avg, int count, number sDev, number variance]> statInfo | 輸出統計資訊 time:統計時間 field: 統計欄位名稱 max: 最大值 min: 最小值 avg: 平均值 count: 資料總數 sDev: 標準差 variance: 變異數 |
| Array<[int classes, string color, number minValue, number maxValue, int count]> choroLegend | 以陣列方式輸出面量圖圖例配色資訊： classes: 分級區間 color: 配色（#RRGGBB） minValue: 分級區間最小值 maxValue: 分級區間最大值 count: 分級區間內資料數 |
| Array<[string barName, string color]> barLegend | 以陣列方式輸出柱狀圖圖例配色資訊： barName: 柱狀圖名稱 color: 配色（#RRGGBB） |
| Array<[string pieName, string color]> pieLegend | 以陣列方式輸出圓餅圖圖例配色資訊： pieName: 圓餅圖名稱 color: 配色（#RRGGBB） |
| Array<[int classes, string symbolUrl, number minValue, number maxValue, int count]> symbolLegend | 以陣列方式輸出分級符號圖圖例配色資訊： classes: 分級區間 symbolUrl: 分級符號URL（PNG格式） minValue: 分級區間最小值 maxValue: 分級區間最大值 count: 分級區間內資料數 |
| ServiceStatus status | 回傳繪製狀況 |
StatChartResult
| Properties |
|---|
| string dataID | 匯出暫存之統計資料集token ID |
| Array<string> imageUrl | 輸出統計圖表影像位址（PNG格式），若繪製統計地圖類型為時序性之統計圖表且以時間點同時繪製多張圖表時，則依序將各時間點之統計圖表位址置於陣列中 |
| Array<[string code, string name, number value, int classes]>statData | 以陣列方式輸出所有地圖統計資料： code: 行政區/統計區代碼或機構別ID name: 行政區/統計區/機構別名稱 value: 統計值 classes: 分級區間（面量圖、分級符號圖限定） |
| Array<[number max, number min, number avg, int count, number sDev, number variance]> statInfo | 輸出統計資訊 max: 最大值 min: 最小值 avg: 平均值 count: 資料總數 sDev: 標準差 variance: 變異數 |
| Array<[string lineName, string color, number width]> lineLegend | 以陣列方式輸出折線圖圖例配色資訊： lineName: 柱狀圖名稱 color: 配色（#RRGGBB） width: 線寬 |
| Array<[string barName, string color]> barLegend | 以陣列方式輸出柱狀圖圖例配色資訊： barName: 柱狀圖名稱 color: 配色（#RRGGBB） |
| Array<[string pieName, string color]> pieLegend | 以陣列方式輸出圓餅圖圖例配色資訊： pieName: 圓餅圖名稱 color: 配色（#RRGGBB） |
| ServiceStatus status | 回傳繪製狀況 |
AdminQuery Class
| Methods |
|---|
| pointQuery(Point point, CoordSystem coordinate, string adminType, Function callback(AdminQueryResult result)) | 輸入點坐標取得行政區資訊 |
AdminQueryResult
| Properties |
|---|
| object adminName | 行政區名稱，包含縣市（county）、鄉鎮市區（town）、村里（village）三個層級之行政區名稱，若查詢之行政區層級為縣市，則town與village之輸出為null；若查詢之行政區層級為鄉鎮市區，則village之輸出為null |
| object adminCode | 行政區代碼，包含縣市（county）、鄉鎮市區（town）、村里（village）三個層級之行政區代碼，若查詢之行政區層級為縣市，則town與village之輸出為null；若查詢之行政區層級為鄉鎮市區，則village之輸出為null |
| Point central | 行政區中心點坐標，回傳結果為public類別之Point物件 |
| Envelope envelope | 行政區地理邊界，回傳結果為public類別之Envelope物件 |
| ServiceStatus status | 回傳查詢狀況 |
Public Class
TimeOptions
| Properties |
|---|
| boolean timeSeries | 是否使用時序性設定（非必填，預設為false） |
| Array<string > time | 以陣列方式依序填入所需時間區段，若TimeSeries值為false，僅須填入單一時間區段（必填） |
AreaSelect
| Properties |
|---|
| string areaSelectType | 空間篩選設定方式（必填，可使用「指定行政區/統計區選取」、「空間篩選」、「環域篩選」三種篩選方式） 指定行政區/統計區選取：district 空間篩選：spatial 環域篩選：buffer |
| string districtType | 配合「指定行政區/統計區篩選」類型使用。 設定指定行政區的類型，可直接指定選取資料的空間單元層級，或向上指定更高層級以高層級的行政區進行空間篩選。不輸入此參數則以該資料空間單元層級作為預設值。 縣市：COUNTY 鄉鎮市區：TOWN 村里：VILLAGE 二級發布區：CODE2 一級發布區：CODE1 最小統計區：CODEBASE 例：統計資料本身為鄉鎮層級，可於此參數設定 DistrictType.TOWN，再於「districtCode」參數直接輸入指定的鄉鎮代碼。或是在此參數設定為 DistrictType.COUNTY，再於「districtCode」參數輸入縣市代碼後，直接選取指定縣市內的所有鄉鎮市區統計資料。 |
| Array<string > districtCode | 配合「指定行政區/統計區篩選」類型使用。 以陣列方式填入指定之行政區/統計區代碼，所有代碼須位於同一行政區或統計區層級，並且填入之行政區/統計區代碼其層級必須大於或等於DBdataset中的DataLevel設定 |
| SpatialOptions spatialOpts | 配合「空間篩選」類型使用。設定篩選參數 |
| BufferOptions bufferOpts | 配合「環域篩選」類型使用。設定篩選參數 |
SpatialOptions
| Properties |
|---|
| Array(Point) points | 點坐標篩選，可於陣列中填入多點，坐標須符合 CoordSystem所設定之坐標格式 |
| Envelope(number left, number top, number right, number bottom) envelope | 矩形篩選，填入矩形之四邊坐標值，坐標須符合 CoordSystem所設定之坐標格式 |
| Circle(number x, number y, number radius) circle | 圓形篩選，填入圓心X、Y坐標及半徑值，坐標須符合 CoordSystem所設定之坐標格式，半徑單位為公尺 |
| string wkt | 多邊形篩選，以WKT字串格式設定多邊形，多邊形節點坐標須符合 CoordSystem所設定之坐標格式 例：POLYGON((121.528 25.044, 121.547 25.043, 121.542 25.031, 121.522 25.036, 121.528 25.044)) |
UnitOptions
| Properties |
|---|
| boolean useDefaultUnit | 是否使用預設統計單位，預設為true。若設為false時則使用資料預設之換算單位或自定義之換算單位 |
| string CostumUnit | 自定義換算單位參數，系統將依照換算單位將原始統計數值進行換算，並顯示於輸出結果中（如原始資料單位為「人」，若換算參數設定為「10e3」，則將所有取出之統計值除以1000後再進行統計地圖/圖表繪製，最終顯示之統計單位為「千人」）。可選擇下列各種單位換算參數 10e1: 十 10e2: 百 10e3: 千 10e4: 萬 10e5: 十萬 10e6: 百萬 10e7: 千萬 |
BufferOptions
| Properties |
|---|
| Array<string> wkts | 環域圖徵，以陣列方式填入WKT字串，支援點（Point）、線（LineString）、多邊形（Polygon）三種圖徵類型，圖徵節點坐標須符合 CoordSystem所設定之坐標格式（必填） 例： POINT(121.528 25.044) LINESTRING(121.528 25.044, 121.547 25.043) POLYGON((121.528 25.044, 121.547 25.043, 121.522 25.036, 121.528 25.044)) |
| number radius | 環域半徑，單位為公尺（必填） |
DataOption
| Properties |
|---|
| string dataType | 統計資料類型（必填） 行政區統計資料：ADMIN 統計區統計資料：CODE 機構別統計資料（XY坐標點）：LOCATE 混合型統計資料：MIX |
| boolean useOrg | 與dataType設定為MIX並用，當開啟此設定後，統計資訊的計算及呈現將會納入混合型中的機構別統計資料。 預設為false |
| TimeOptions timeOpts | 統計時間設定（非必填） |
| string dataLevel | 資料層級類型設定（非必填，預設為縣市，填入字串參考下列各項層級） 縣市：COUNTY 鄉鎮市區：TOWN 村里：VILLAGE 二級發布區：CODE2 一級發布區：CODE1 最小統計區：CODEBASE 機構別：ORG 自定資料：Customize |
| string dataTitle | 自訂欄位命名（非必填） |
| UnitOptions unitOpts | 統計單位設定（非必填） |
| string fieldFormula | 資料欄位計算式設定，可包含加減乘除基本四則運算以及小括弧()，計算式舉例如將欄位A與欄位B相減後除以B，再乘以100，計算式可寫成"(A-B) / B *100" 本公式計算符號之認定分別為eq(加法)、-(減法)、*(乘法)、/(除法) (非必填) |
| boolean multiData | 設定是否為多重統計資料，當開起此設定後，將進行跨資料表功能 |
Envelope
| Properties |
|---|
| number left | 地圖左邊界，坐標格式與輸入資料之 CoordSystem設定一致 |
| number top | 地圖上邊界，坐標格式與輸入資料之 CoordSystem設定一致 |
| number right | 地圖右邊界，坐標格式與輸入資料之 CoordSystem設定一致 |
| number bottom | 地圖下邊界，坐標格式與輸入資料之 CoordSystem設定一致 |
Point
| Properties |
|---|
| number x | 座標 x 軸 |
| number y | 座標 y 軸 |
Circle
| Properties |
|---|
| number x | 座標 x 軸 |
| number y | 座標 y 軸 |
| int radius | 半徑範圍 (公尺) |
ImageSize
| Properties |
|---|
| int height | 圖片之高度。單位為pixel，預設為640 |
| int width | 圖片之寬度。單位為pixel，預設為480 |
Enum Class
CoordSystem
| Properties |
|---|
| EPSG3825 | TWD97坐標系統（中央經線119ﾟE） |
| EPSG3826 | TWD97坐標系統（中央經線121ﾟE） |
| EPSG3857 | Web Mercator坐標系統，使用WGS84經緯度坐標 |
ServiceStatus
| Properties |
|---|
| string ERROR | 與伺服器溝通有誤。 |
| string INVALID_REQUEST | 使用者輸入之參數條件要求無效。 |
| string OK | 繪圖結果正常。 |
| string UNKNOWN_ERROR | 由於伺服器錯誤造成服務無法完成，可再重新請求查詢。 |
AreaSelectType
| Properties |
|---|
| string DISTRICT | 指定行政區/統計區選取 |
| string SPATIAL | 空間篩選 |
| string BUFFER | 環域篩選 |
DataType
| Properties |
|---|
| string ADMIN | 行政區統計資料 |
| string CODE | 統計區統計資料 |
| string LOCATE | 機構別統計資料 |
ClassifyMethod
| Properties |
|---|
| string EQUAL_INTERVAL | 等距法 |
| string EQUAL_INTERVAL_5 | 去除前後5％資料等距法 |
| string QUANTILE | 等量法 |
| string USERDEFINED | 自訂間距 ，間距設定由userLevels參數定義 |
DataLevel
| Properties |
|---|
| string COUNTY | 縣市 |
| string TOWN | 鄉鎮市區 |
| string VILLAGE | 村里 |
| string CODE2 | 二級發布區 |
| string CODE1 | 一級發布區 |
| string CODEBASE | 最小統計區 |
| string ORG | 機構別 |
XAxis
| Properties |
|---|
| string SPATIAL | 行政區/統計區/機構別 |
| string FIELD | 統計欄位 |
| string TIME | 時序 |
MapKind
| Properties |
|---|
| string CHOROPLETH | 面量圖 |
| string BAR | 柱狀圖 |
| string PIE | 圓餅圖 |
| string SYMBOL | 分級符號圖 |
ChartKind
| Properties |
|---|
| string LINE | 折線圖 |
| string BAR | 柱狀圖 |
| string PIE | 圓餅圖 |
CostumUnit
| Properties |
|---|
| string 10e1 | 十 |
| string 10e2 | 百 |
| string 10e3 | 千 |
| string 10e4 | 萬 |
| string 10e5 | 十萬 |
| string 10e6 | 百萬 |
| string 10e4 | 千萬 |
SymbolStyle
| Properties |
|---|
| string CIRCLE | 圓形 |
| string STAR | 星形 |
| string SQUARE | 方形 |
| string TRIANGLE | 三角形 |
DistrictType
| Properties |
|---|
| string COUNTY | 縣市 |
| string TOWN | 鄉鎮市區 |
| string VILLAGE | 村里 |
| string CODE2 | 二級發布區 |
| string CODE1 | 一級發布區 |
| string CODEBASE | 最小統計區 |
BaseLevel
| Properties |
|---|
| string COUNTY | 縣市 |
| string TOWN | 鄉鎮市區 |
| string VILLAGE | 村里 |
LabelContent
| Properties |
|---|
| string NAME | 行政區/統計區名稱 |
| string VALUE | 統計值 |
| string ALL | 行政區/統計區名稱 + 統計值 |
