SuperMap.REST.FilterParameter

查询过滤条件参数类。 该类用于设置查询数据集的查询过滤参数。

Summary
SuperMap.REST.FilterParameter 查询过滤条件参数类。 该类用于设置查询数据集的查询过滤参数。
Properties
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.REST.JoinItem)} 与外部表的连接信息 JoinItem 数组。
linkItems {Array(SuperMap.REST.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”。
Constructor
SuperMap.REST.FilterParameter 查询过滤条件参数类构造函数。
Functions
destroy 释放资源,将引用资源的属性置空。

Properties

attributeFilter

{String} 属性过滤条件。 相当于 SQL 语句中的 WHERE 子句,其格式为:WHERE <条件表达式>, attributeFilter 就是其中的“条件表达式”。 该字段的用法为 attributeFilter = “过滤条件”。 例如,要查询字段 fieldValue 小于100的记录,设置 attributeFilter = “fieldValue < 100”; 要查询字段 name 的值为“酒店”的记录,设置 attributeFilter = “name like ‘%酒店%’”,等等。

name

{String} 查询数据集名称或者图层名称,根据实际的查询对象而定,必设属性。 一般情况下该字段为数据集名称,但在进行与地图相关功能的操作时, 需要设置为图层名称(图层名称格式:数据集名称@数据源别名)。 因为一个地图的图层可能是来自于不同数据源的数据集, 而不同的数据源中可能存在同名的数据集, 使用数据集名称不能唯一的确定数据集, 所以在进行与地图相关功能的操作时,该值需要设置为图层名称。

joinItems

{Array(SuperMap.REST.JoinItem)} 与外部表的连接信息 JoinItem 数组。

linkItems

{Array(SuperMap.REST.LinkItem)} 与外部表的关联信息 LinkItem 数组。

ids

{Array(String)} 查询 id 数组,即属性表中的 SmID 值。

orderBy

{String} 查询排序的字段,orderBy的字段须为数值型的。 相当于 SQL 语句中的 ORDER BY 子句,其格式为:ORDER BY <列名>, 列名即属性表中每一列的名称,列又可称为属性,在 SuperMap 中又称为字段。 对单个字段排序时,该字段的用法为 orderBy = “字段名”; 对多个字段排序时,字段之间以英文逗号进行分割,用法为 orderBy = “字段名1, 字段名2”。 例如,现有一个国家数据集,它有两个字段分别为“SmArea”和“pop_1994”, 分别表示国家的面积和1994年的各国人口数量。 如果要按照各国人口数量对记录进行排序,则 orderBy = “pop_1994”; 如果要以面积和人口进行排序,则 orderBy = “SmArea, pop_1994”。

groupBy

{String} 查询分组条件的字段。 相当于 SQL 语句中的 GROUP BY 子句,其格式为:GROUP BY <列名>, 列名即属性表中每一列的名称,列又可称为属性,在 SuperMap 中又称为字段。 对单个字段分组时,该字段的用法为 groupBy = “字段名”; 对多个字段分组时,字段之间以英文逗号进行分割,用法为 groupBy = “字段名1, 字段名2”。 例如,现有一个全球城市数据集,该数据集有两个字段分别为“Continent”和“Country”, 分别表示某个城市所属的洲和国家。 如果要按照国家对全球的城市进行分组, 可以设置 groupBy = “Country”; 如果以洲和国家对城市进行分组,设置 groupBy = “Continent, Country”。

fields

{Array(String)} 查询字段数组,如果不设置则使用系统返回的所有字段。

Constructor

SuperMap.REST.FilterParameter

查询过滤条件参数类构造函数。

Parameters

options {Object} 参数。

Allowed options properties

attributeFilter {String} 属性过滤条件。
name {String} 查询数据集名称或者图层名称。
joinItems {Array(SuperMap.REST.JoinItem)} 与外部表的连接信息 JoinItem 数组。
linkItems {Array(SuperMap.REST.LinkItem)} 与外部表的关联信息 LinkItem 数组。
ids {Array(String)} 查询 id 数组,即属性表中的 SmID 值。
orderBy {String} 查询排序的字段, orderBy 的字段须为数值型的。
groupBy {String} 查询分组条件的字段。
fields {Array(String)} 查询字段数组。

Functions

destroy

destroy: function()

释放资源,将引用资源的属性置空。

连接信息类。 该类用于矢量数据集与外部表的连接。外部表可以为另一个矢量数据集(其中纯属性数据集中 没有空间几何信息)所对应的 DBMS 表,也可以是用户自建的业务表。需要注意的是,矢 量数据集与外部表必须属于同一数据源。表之间的联系的建立有两种方式,一种是连接 (join),一种是关联(link)。连接,实际上是依据相同的字段将一个外部表追加到指定的表; 而关联是基于一个相同的字段定义了两个表格之间的联系,但不是实际的追加。用于连接两个表 的字段的名称不一定相同,但类型必须一致。当两个表格之间建立了连接,通过对主表进行操作, 可以对外部表进行查询,制作专题图以及分析等。当两个表格之间是一对一或多对一的关系时, 可以使用 join 连接。当为多对一的关系时,允许指定多个字段之间的关联。
关联信息类。 该类用于矢量数据集与外部表的关联。 外部表是另一个数据集(其中纯属性数据集中没有空间几何信息)中的 DBMS 表, 矢量数据集与外部表可以属于不同的数据源,但数据源类型目前只支持SQL Server和Oracle类型。 使用LinkItem时, 空间数据和属性数据必须满足关联条件,即主空间数据集与外部属性表之间存在关联字段。 LinkItem 只支持左连接,UDB、PostgreSQL 和 DB2 数据源不支持 LinkItem; 另外,用于建立关联关系的两个表可以不在同一个数据源下。
destroy: function()
释放资源,将引用资源的属性置空。
Close