Class: JoinItem

JoinItem

连接信息类。 该类用于矢量数据集与外部表的连接。外部表可以为另一个矢量数据集（其中纯属性数据集中没有空间几何信息）所对应的 DBMS 表，也可以是用户自建的业务表。 需要注意的是，矢量数据集与外部表必须属于同一数据源。
表之间的联系的建立有两种方式，一种是连接（join），一种是关联（link）。 连接，实际上是依据相同的字段将一个外部表追加到指定的表；而关联是基于一个相同的字段定义了两个表格之间的联系，但不是实际的追加。 用于连接两个表的字段的名称不一定相同，但类型必须一致。当两个表格之间建立了连接，通过对主表进行操作，可以对外部表进行查询，制作专题图以及分析等。 当两个表格之间是一对一或多对一的关系时，可以使用 join 连接。当为多对一的关系时，允许指定多个字段之间的关联。
注意：JoinItem 目前支持左连接和内连接，不支持全连接和右连接，UDB 引擎不支持内连接。并且用于建立连接的两个表必须在同一个数据源下。

new JoinItem(options)

Usage
// 浏览器
<script type="text/javascript" src="https://iclient.supermap.io/dist/mapboxgl/iclient-mapboxgl.js"></script>
<script>
  new mapboxgl.supermap.JoinItem(options);
  
  // 弃用的写法
  new SuperMap.JoinItem(options);

</script>

// ES6 Import
import { JoinItem } from '@supermapgis/iclient-mapboxgl';

new JoinItem(options);
common/iServer/JoinItem.js, line 6
Name Type Description
options Object

参数。

Name Type Description
foreignTableName string

外部表的名称。
joinFilter string

矢量数据集与外部表之间的连接表达式，即设定两个表之间关联的字段。
joinType JoinType

两个表之间连接类型。
Example
下面以 SQL 查询说明 joinItem 的使用方法：
(start code)
  function queryBySQL() {
      // 设置与外部表的连接信息
      var joinItem = new JoinItem({
          foreignTableName: "foreignTable",
          joinFilter: "foreignTable.CONTINENT = Countries.CONTINENT",
          joinType: "LEFTJOIN"
      })
      var queryParam, queryBySQLParams, queryBySQLService;
      // 设置查询参数，在查询参数中添加joinItem关联条件信息
      queryParam = new FilterParameter({
           name: "Countries@World",
           joinItems: [joinItem]
        }),
      queryBySQLParams = new QueryBySQLParameters({
            queryParams: [queryParam]
        }),
      queryBySQLService = new QueryBySQLService(url);
      queryBySQLService.processAsync(queryBySQLParams, processCompleted);
 }
 function processCompleted(queryEventArgs) {//todo}
 function processFailed(e) {//todo}
(end)

Members

foreignTableNamestring

外部表的名称。 如果外部表的名称是以 “表名@数据源名” 命名方式，则该属性只需赋值表名。 例如：外部表 Name@changchun，Name 为表名，changchun 为数据源名称，则该属性的赋值应为：Name。

joinFilterstring

矢量数据集与外部表之间的连接表达式，即设定两个表之间关联的字段。 例如，将房屋面数据集（Building）的 district 字段与房屋拥有者的纯属性数据集（Owner）的 region 字段相连接， 两个数据集对应的表名称分别为 Table_Building 和 Table_Owner， 则连接表达式为 Table_Building.district = Table_Owner.region。 当有多个字段相连接时，用 AND 将多个表达式相连。

joinTypeJoinType

两个表之间连接类型。 连接类型决定了对两个表进行连接查询后返回的记录的情况。支持左连接 LEFTJOIN 和内连接 INNERJOIN。

Methods

destroy()

common/iServer/JoinItem.js, line 83

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

toServerJSONObject()

common/iServer/JoinItem.js, line 94

转换成对应的 JSON 格式对象。