實例方法
關於資料層使用API的詳細說明及範例。
Data
處理地理幾何圖形的圖層，支援座標點、線條、多邊形及圓形，包含 Features 的集合資料。
每個 map內都會有 Data 物件，不用再自行建構。
| Name | Description |
|---|---|
| addGeoJson | 將整份 Geojson 資料集加入地圖。 |
| add | 可獨立加入 Feature 到地圖上。 |
| removeFeature | 從地圖中移除指定的 Feature。 |
| removeFeatureById | 依據唯一值的屬性 ID，從地圖中移除 Feature。 |
| getFeatureById | 根據唯一 id 取得地圖中的指定項目。 |
| setStyle | 設定資料層上所有地圖項目的樣式，可針對地圖項目個別設定。 |
| setGlobalStyle | 全局設定資料層上地圖項目的樣式，不可針對地圖項目個別設定，所有的地圖項目皆須統一套用同一樣式設定。 |
| overrideStyle | 覆蓋指定 Feature 的樣式，暫時改變其外觀。 |
| revertStyle | 移除使用 overrideStyle 覆蓋的樣式。 |
| revertGlobalStyle | 恢復全域樣式屬性為預設值。 |
| toGeoJson | 將資料層內的地圖項目輸出至 GeoJSON 格式。 |
| forEachFeature | 遍歷地圖中的所有 Feature ，用於重複呼叫指定函式。 |
| clear | 移除資料層內所有的地圖項目。 |
| enableCluster | 是否啟用資料層叢集功能。 |
| toggleClusterPoints | 顯示或隱藏所有資料層叢集點。 |
| toggleNonClusterPoints | 顯示或隱藏所有資料層非叢集點。 |
addGeoJson
addGeoJson(geojson)
將整份 Geojson 資料集加入地圖。
Parameters
- geojson
(object): 符合 GeoJSON 格式的幾何圖形資料。
Examples
add
add(feature)
可獨立加入 Feature 到地圖上。
Parameters
- feature
(object): 包含geometry及properties兩種物件。
Example
getFeatureById
getFeatureById(id)
根據 id 取得地圖中的指定項目。
Parameters
- id
(number | string): 各Feature的唯一鍵值。
Returns
object : geojson 的 feature 格式。
Example
removeFeature
removeFeature(feature)
從地圖中移除指定的 Feature。
Parameters
- feature
(object): 接收資料層中的地圖項目。
Example
removeFeatureById
removeFeatureById(id)
依據唯一值的屬性 ID，從地圖中移除 Feature。
Parameters
- id
(number | string): 接收待刪除的地圖項目 id。
Example
setStyle
setStyle(callback | style)
設定資料層上所有地圖項目的樣式，可針對地圖項目個別設定。
Parameters
- callback
(function): 回調函數，返回資料層中所有地圖項目。 - style
(object): 樣式更改結果。
Example
setGlobalStyle
setGlobalStyle(style)
全局設定資料層上的點幾何圖形樣式，不可針對地圖項目個別設定，所有的地圖項目皆須統一套用同一樣式設定。
- 目前支援可設定的屬性：
iconOverlap、textOverlap。
Parameters
- style
(object): 樣式更改結果。
Example
overrideStyle
overrideStyle(feature, style)
覆蓋指定 Feature 的樣式，暫時改變其外觀。
Parameters
- feature
(object): 資料層中的地圖項目。 - style
(object): 覆蓋的樣式。
Example
revertStyle
revertStyle()
移除使用 overrideStyle 所渲染的覆蓋樣式。
Example
revertGlobalStyle
revertGlobalStyle()
恢復全域樣式屬性為預設值。
Example
toGeoJson
toGeoJson(callback)
將資料層內的地圖項目輸出至 GeoJSON 格式。
Parameters
- callback : 以 Geojson 格式輸出整個資料層的地圖項目。
Example
forEachFeature
forEachFeature(callback)
遍歷地圖中的所有 Feature，用於重複呼叫指定函式。
Parameters
- callback
(function): 回調函數，返回資料層中所有地圖項目。
Example
clear
clear()
移除資料層內所有的地圖項目。
Example
enableCluster
enableCluster(enabled, options)
是否啟用資料層叢集功能。詳細使用方法可見資料層叢集。
Parameters
- enabled
(boolean): 是否啟用叢集功能。 - options
(object): 叢集圖的參數。
| Name | Description |
|---|---|
options.radius number | 選填，叢集半徑，以像素為單位，預設為 50。 |
options.maxZoom number | 選填，叢集圖層會停止叢集化的最大縮放級別，預設為 14。 |
options.styles object | 選填，叢集圖的樣式設置。 |
Example
toggleClusterPoints
toggleClusterPoints(visible)
顯示或隱藏所有資料層叢集點。
Parameters
- visible
(boolean): 是否顯示資料層叢集點。
Example
toggleNonClusterPoints
toggleNonClusterPoints(visible)
顯示或隱藏所有資料層非叢集點。
Parameters
- visible
(boolean): 是否顯示資料層非叢集點。
Example
Feature
地圖項目包含唯一 ID 、幾何圖形及屬性資料。
請搭配 data.setStyle 或 data.getFeatureById 一起使用。
| Name | Description |
|---|---|
| setProperty | 設定指定屬性的內容。 |
| getProperty | 回傳屬性的值。 |
| removeProperty | 移除特定屬性。 |
| setGeometry | 設定地圖項目的經緯度位置。 |
| getGeometry | 回傳地圖項目的經緯度位置。 |
| setVisible | 設定地圖項目的顯示與否。 |
| getBounds | 回傳地圖項目的邊界點。 |
| getCenter | 回傳地圖項目的中心點。 |
| getLeft | 回傳地圖項目的最左座標點。 |
| getRight | 回傳地圖項目的最右座標點。 |
| getTop | 回傳地圖項目的最頂部座標點。 |
| getBottom | 回傳地圖項目的最底部座標點。 |
| forEachProperty | 遍歷所有屬性內容 ，用於重複呼叫指定函式。 |
| displayFeatureText | 添加幾何圖形的文字說明，圖形類別：線條為間距顯示，多邊形及圓形則顯示在圖形中央。 |
| removeDisplayText | 移除以 displayFeatureText 方法添加的文字項目。 |
| iconAlongLinestring | 增加 ICON 至線條圖形上。 |
setProperty
setProperty(property, value)
設定指定屬性的內容。
Parameters
- property
(string): 地圖項目的屬性名稱。 - value
(string | number): 需設定的值。
Example
getProperty
getProperty(property)
回傳屬性的值。
Parameters
- property
(string): 指定的屬性名稱。
Example
removeProperty
removeProperty(property)
移除特定屬性，其中 id 為識別地圖項目的唯一值，因此不可刪除。
Parameters
- property
(string): 移除的屬性名稱。
Example
setGeometry
setGeometry(geometry)
設定地圖項目的經緯度位置，經度在前緯度在後。
Parameters
- geometry
(array): 包含經緯度的陣列。
Example
getGeometry
getGeometry()
回傳地圖項目的經緯度位置。
Returns
- geometry
(array): 幾何圖形的經緯度陣列。
Example
setVisible
setVisible(visible)
設定地圖項目的顯示與否。
Parameters
- visible
(boolean): 是否顯示地圖項目。
Example
getBounds
getBounds()
回傳地圖項目的邊界點。
Returns
- geometry
(array): 幾何圖形的邊界經緯度陣列。
Example
getCenter
getCenter()
回傳地圖項目的中心點。
Returns
- geometry
(array): 幾何圖形的中心點經緯度陣列。
Example
getLeft
getLeft()
回傳地圖項目的最左座標點。
Returns
- geometry
(array): 幾何圖形的最左經緯度陣列。
Example
getRight
getRight()
回傳地圖項目的最右座標點。
Returns
- geometry
(array): 幾何圖形的最右經緯度陣列。
Example
getTop
getTop()
回傳地圖項目的最頂部座標點。
Returns
- geometry
(array): 幾何圖形的最頂部經緯度陣列。
Example
getBottom
getBottom()
回傳地圖項目的最底部座標點。
Returns
- geometry
(array): 幾何圖形的最底部經緯度陣列。
Example
forEachProperty
forEachProperty(callback)
遍歷所有屬性內容 ，用於重複呼叫指定函式。
Parameters
- callback
(function): 回調函數，該回調函式返回包含 屬性內容 以及屬性名稱的物件。
Example
displayFeatureText
displayFeatureText(text)
添加幾何圖形的文字說明，若為線條幾何圖形則文字為間距顯示；多邊形及圓形幾何圖形文字則會顯示在圖形中央。
Parameters
- text
(string): 可輸入屬性名稱或是文字內容。
Example
removeDisplayText
removeDisplayText()
移除以 displayFeatureText 方法添加的文字項目。
Example
iconAlongLinestring
iconAlongLinestring()
沿著線條 Feature 增加 ICON 顯示，可依據使用情況調整 ICON 的樣式。
詳細使用方法可見範例：
Parameters
- options
(object): 要設定的ICON樣式。Name Description options.iconImage (string)圖案名稱，預設為 black_location。options.iconSize (number)圖案大小，預設為 1。 options.rotationAlignmentMap (boolean)ICON 的垂直目標，true 為垂直線條方向, false 為垂直地圖視窗方向。 options.iconRotate (number)順時針的旋轉角度，以角度為單位，預設為 0。
Example