# QueryGeoServer
查阅Leaflet API

#### new mars2d.query.QueryGeoServer(options)
query/QueryGeoServer.js 16

GeoServer WFS服务查询类

参数名称 | 类型 | 描述信息
--- | --- | ---
`options` | Object | * | 参数对象，包括以下：
参数名称 | 类型 | 默认值 | 描述信息
--- | --- | --- | ---
`url` | String |  | GeoServer服务地址, 示例：'http://server.mars2d.cn/geoserver/mars/wfs'
`layer` | String |  | 图层名称（命名空间:图层名称），多个图层名称用逗号隔开
`headers` | Object | `{}` | 可选 将被添加到HTTP请求头。 //以下是GeoJsonLayer图层参数
`id` | String | Number | `createGuid()` | 可选 赋予给layer图层，图层id标识
`pid` | String | Number | `-1` | 可选 赋予给layer图层，图层父级的id，一般图层管理中使用
`name` | String | `''` | 可选 赋予给layer图层，图层名称
`symbol` | Object | function |  | 可选 赋予给layer图层，图层矢量数据的style样式，参考`GeoJsonLayer`
`graphicOptions` | Object |  | 可选 赋予给layer图层，图层默认的graphic的构造参数，参考`GeoJsonLayer`
`popup` | String | Array.<Globe.getTemplateHtml_template> | function |  | 可选 赋予给layer图层，图层绑定的popup弹窗值，参考`GeoJsonLayer`
`tooltip` | String | Array.<Globe.getTemplateHtml_template> | function | Object |  | 可选 赋予给layer图层，图层绑定的tooltip弹窗值，参考`GeoJsonLayer`

### 继承自

- BaseClass

### 属性值

#### 只读 layer : GeoJsonLayer
query/QueryGeoServer.js 49

用于显示查询结果的GeoJsonLayer图层，图层参数在当前类构造方法中传入

#### 只读 options : Object
core/BaseClass.js 18

当前类的构造参数

继承自:
  - BaseClass#options

### 方法

#### addEventParent(obj) → BaseClass
core/BaseClass.js 294

添加抛出事件到父类，它将接收传播的事件

参数名称 | 类型 | 描述信息
--- | --- | ---
`obj` | Object | 父类对象

##### 返回值:

当前对象本身,可以链式调用

继承自:
  - BaseClass#addEventParent

#### clear() → void
query/QueryGeoServer.js 315

清除

##### 返回值:

无

#### destroy(noDel) → void
core/BaseClass.js 33

销毁当前对象

参数名称 | 类型 | 默认值 | 描述信息
--- | --- | --- | ---
`noDel` | Boolean | `false` | 可选 false:会自动delete释放所有属性，true：不delete绑定的变量

##### 返回值:

无

继承自:
  - BaseClass#destroy

#### fire(type, data, propagate) → BaseClass
core/BaseClass.js 199

触发指定类型的事件。

参数名称 | 类型 | 默认值 | 描述信息
--- | --- | --- | ---
`type` | EventType | String |  | 事件类型
`data` | Object |  | 可选 传输的数据或对象，可在事件回调方法中event对象中获取进行使用
`propagate` | BaseClass | Object | `null` | 可选 将事件传播给父类 (用addEventParent设置)

##### 返回值:

当前对象本身,可以链式调用

继承自:
  - BaseClass#fire

#### hasEventParent(obj) → BaseClass
core/BaseClass.js 321

是否绑定了抛出事件到指定父类

参数名称 | 类型 | 描述信息
--- | --- | ---
`obj` | Object | 父类对象

##### 返回值:

当前对象本身,可以链式调用

继承自:
  - BaseClass#hasEventParent

#### listens(type, propagate) → Boolean
core/BaseClass.js 244

是否有绑定指定的事件

参数名称 | 类型 | 描述信息
--- | --- | ---
`type` | EventType | String | 事件类型
`propagate` | Object | 可选 是否判断指定的父类 (用addEventParent设置的)

##### 返回值:

是否存在

继承自:
  - BaseClass#listens

#### off(types, fn, context) → BaseClass
core/BaseClass.js 90

解除绑定指定类型事件监听器

参数名称 | 类型 | 描述信息
--- | --- | ---
`types` | EventType | String | Array.<EventType> | 可选 事件类型,未传值时解绑所有事件
`fn` | function | 可选 绑定的监听器回调方法,未传值时解绑所有指定类型对应事件
`context` | Object | 可选 侦听器的上下文(this关键字将指向的对象)。

##### 返回值:

当前对象本身,可以链式调用

继承自:
  - BaseClass#off

#### on(types, fn, context) → BaseClass
core/BaseClass.js 52

绑定指定类型事件监听器, 支持在监听中调用 event.stopPropagation(); 组织事件冒泡

参数名称 | 类型 | 描述信息
--- | --- | ---
`types` | EventType | String | Array.<EventType> | 事件类型
`fn` | function | 可选 绑定的监听器回调方法
`context` | Object | 可选 侦听器的上下文(this关键字将指向的对象)。

##### 返回值:

当前对象本身,可以链式调用

继承自:
  - BaseClass#on

#### once(types, fn, context) → BaseClass
core/BaseClass.js 271

绑定一次性执行的指定类型事件监听器 与on类似，监听器只会被触发一次，然后被删除。

参数名称 | 类型 | 描述信息
--- | --- | ---
`types` | EventType | String | Array.<EventType> | 事件类型
`fn` | function | 可选 绑定的监听器回调方法
`context` | Object | 可选 侦听器的上下文(this关键字将指向的对象)。

##### 返回值:

当前对象本身,可以链式调用

继承自:
  - BaseClass#once

#### query(queryOptions) → QueryGeoServer
query/QueryGeoServer.js 79

查询服务，基于filter条件

参数名称 | 类型 | 描述信息
--- | --- | ---
`queryOptions` | Object | 查询参数
参数名称 | 类型 | 默认值 | 描述信息
--- | --- | --- | ---
`text` | String |  | 可选 检索关键字
`column` | String |  | 可选 检索关键字时，对应的字段名称
`like` | Boolean | `true` | 可选 检索关键字时，是否模糊匹配，false时精确查询
`graphic` | Rectangle | Polygon | Circle | * |  | 可选 限定的搜索区域
`geometryName` | String | `'the_geom'` | 可选 限定的搜索区域时，对应的geometry字段名称
`maxFeatures` | Number | `1000` | 可选 返回结果最大数量
`sortBy` | String |  | 可选 排序的属性名称，默认升序，降序时+D
`更多参数` | * |  | 可选 WFS服务支持的其他参数，均支持
`success` | function |  | 可选 查询完成的回调方法
`error` | function |  | 可选 查询失败的回调方法

##### 返回值:

当前对象本身，可以链式调用

#### queryBySql(queryOptions) → QueryGeoServer
query/QueryGeoServer.js 196

查询服务，基于cql_filter条件

参数名称 | 类型 | 描述信息
--- | --- | ---
`queryOptions` | Object | 查询参数
参数名称 | 类型 | 默认值 | 描述信息
--- | --- | --- | ---
`parameters.cql_filter` | Boolean |  | 筛选服务数据的SQL语句
`graphic` | Rectangle | Polygon | Circle | * |  | 可选 限定的搜索区域,自动转换后加入到cql_filter中，也可以外部自行处理
`geometryName` | String | `'the_geom'` | 可选 限定的搜索区域时，对应的geometry字段名称
`maxFeatures` | Number | `1000` | 可选 返回结果最大数量
`sortBy` | String |  | 可选 排序的属性名称，默认升序，降序时+D
`更多参数` | * |  | 可选 WFS服务支持的其他参数，均支持
`success` | function |  | 可选 查询完成的回调方法
`error` | function |  | 可选 查询失败的回调方法

##### 返回值:

当前对象本身，可以链式调用

#### removeEventParent(obj) → BaseClass
core/BaseClass.js 307

移除抛出事件到父类

参数名称 | 类型 | 描述信息
--- | --- | ---
`obj` | Object | 父类对象

##### 返回值:

当前对象本身,可以链式调用

继承自:
  - BaseClass#removeEventParent