SuperMap. FilterParameter API

SuperMap. FilterParameter

查詢過濾條件參數類。該類用於設置查詢數據集的查詢過濾參數。

new SuperMap.FilterParameter(options)

common/iServer/FilterParameter.js, line 6

Name

Type

Description

options

Object

 

可選參數。如:

attributeFilter - {string} 屬性過濾條件。

name - {string} 查詢數據集名稱或者圖層名稱。

joinItems - {Array<SuperMap.JoinItem>} 與外部表的連接信息 SuperMap.JoinItem 數組。

linkItems - {Array<SuperMap.LinkItem>} 與外部表的關聯信息 SuperMap.LinkItem 數組。

ids - {Array} 查詢 id 數組,即屬性表中的 SmID 值。

orderBy - {string} 查詢排序的字段, orderBy 的字段須爲數值型的。

groupBy - {string} 查詢分組條件的字段。

fields - {Array} 查詢字段數組。

Members

attributeFilter string

屬性過濾條件。 相當於 SQL 語句中的 WHERE 子句,其格式爲:WHERE <條件表達式>, attributeFilter 就是其中的“條件表達式”。 該字段的用法爲 attributeFilter = "過濾條件"。 例如,要查詢字段 fieldValue 小於100的記錄,設置 attributeFilter = "fieldValue < 100"; 要查詢字段 name 的值爲“酒店”的記錄,設置 attributeFilter = "name like '%酒店%'",等等。

fields Array.<string>

查詢字段數組,如果不設置則使用系統返回的所有字段。

groupBy string

查詢分組條件的字段。 相當於 SQL 語句中的 GROUP BY 子句,其格式爲:GROUP BY <列名>, 列名即屬性表中每一列的名稱,列又可稱爲屬性,在 SuperMap 中又稱爲字段。 對單個字段分組時,該字段的用法爲 groupBy = "字段名"; 對多個字段分組時,字段之間以英文逗號進行分割,用法爲 groupBy = "字段名1, 字段名2"。 例如,現有一個全球城市數據集,該數據集有兩個字段分別爲“Continent”和“Country”, 分別表示某個城市所屬的洲和國家。 如果要按照國家對全球的城市進行分組, 可以設置 groupBy = "Country"; 如果以洲和國家對城市進行分組,設置 groupBy = "Continent, Country"。

ids Array.<string>

查詢 id 數組,即屬性表中的 SmID 值。

joinItems Array.<SuperMap.JoinItem>

與外部表的連接信息 SuperMap.JoinItem 數組。

linkItems Array.<SuperMap.LinkItem>

與外部表的關聯信息 LinkItem 數組。

name string

查詢數據集名稱或者圖層名稱,根據實際的查詢對象而定,必設屬性。 一般情況下該字段爲數據集名稱,但在進行與地圖相關功能的操作時, 需要設置爲圖層名稱(圖層名稱格式:數據集名稱@數據源別名)。 因爲一個地圖的圖層可能是來自於不同數據源的數據集, 而不同的數據源中可能存在同名的數據集, 使用數據集名稱不能唯一的確定數據集, 所以在進行與地圖相關功能的操作時,該值需要設置爲圖層名稱。

orderBy string

查詢排序的字段,orderBy的字段須爲數值型的。 相當於 SQL 語句中的 ORDER BY 子句,其格式爲:ORDER BY <列名>, 列名即屬性表中每一列的名稱,列又可稱爲屬性,在 SuperMap 中又稱爲字段。 對單個字段排序時,該字段的用法爲 orderBy = "字段名"; 對多個字段排序時,字段之間以英文逗號進行分割,用法爲 orderBy = "字段名1, 字段名2"。 例如,現有一個國家數據集,它有兩個字段分別爲“SmArea”和“pop_1994”, 分別表示國家的面積和1994年的各國人口數量。 如果要按照各國人口數量對記錄進行排序,則 orderBy = "pop_1994"; 如果要以面積和人口進行排序,則 orderBy = "SmArea, pop_1994"。

Methods

destroy()

common/iServer/FilterParameter.js, line 106

釋放資源,將引用資源的屬性置空。

Documentation generated by JSDoc on We

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章