Class: WFSLayer

WFSLayer

new WFSLayer(options)

document/layer/ogc/WFSLayer.js, line 26

支持如下方法：
[1、加载图层资源]
[2、指定图层的要素查询]
[3、查询要素数量]
[4、通过传入的json构造并返回一个新的几何对象]
5、导出为json对象
6、克隆几何对象

WFS图层，
目前二维和三维上支持4326(包括4490，4214以及4610)，3857以及EPSG支持的自定义坐标系，WFS服务会自动读取元信息上的坐标系，不需要用户指定

[ES5引入方式]：
zondy.layer.WFSLayer()
[ES6引入方式]：
import { WFSLayer } from "@mapgis/webclient-common"

针对图层的操作请在图层加载完毕事件中进行
Layer.on('layerview-created', function (result) {
console.log("加载完毕:", result.layer)
});
如果不想在该事件中放入业务代码，则请确认图层资源已加载完毕后再进行操作
if(layer.loadStatus === 'loaded') {
// 你的业务逻辑
}

Name Type Description
options Object

构造参数

Name Type Default Description
url String 可选

服务基地址，目前支持的服务如下：
1、IGS1.0的WFS服务：http://{ip}:{port}/igs/rest/ogc/layer/{folder}:{serviceName}/WFSServer，
2、IGS2.0的WFS服务：http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/WFSServer，示例如下：
[1、添加IGS要素图层-不指定图层]
[2、添加IGS要素图层-指定图层名称]
删除图层方法：[删除图层]
sublayerId String 可选

WFS服务的子图层名称，有如下规则：
1、不指定子图层ID则查询第0个子图层，指定时，则查询指定sublayerId的子图层
2、仅支持单图层的要素查询，不支持多图层和子图层的要素查询
id String 可选

图层id，不给则给一个随机的id
index Number 可选

图层顺序，参考示例：[图层顺序]
opacity Number 1 可选

图层透明度，0到1之间的值，0为完全透明，1为不透明，参考示例：[设置图层透明度]
visible Boolean true 可选

图层显示或隐藏，true则显示，false则隐藏，参考示例：[设置图层显示或隐藏]
renderer BaseRenderer | Object | null 可选

渲染样式，详细的几何类型样式请参考支持的渲染样式文档，所有支持的渲染样式如下：
1、单值专题图
2、分段专题图
3、统一专题图
参考示例：
[1、单值专题图]
[2、分段专题图]
[3、统一专题图]
labelsVisible Boolean false 可选

是否开启动态注记，仅支持三维场景
labelingInfo Array.<LabelClass> [] 可选

注记样式数组，可以和renderer同时启用，默认取数组的第一个样式， 仅支持三维场景，参考示例：[注记样式]
elevationInfo ElevationInfo 可选

高程样式，仅支持三维场景
isReverseXY Boolean | null null 可选

是否翻转x、y坐标。默认为null，未设置是否翻转x，y坐标，按照内部默认情况处理IGS、GeoServer、SuperMap、ArcGIS服务。不同图层参考系和不同厂商，服务元数据中的BoundingBox、以及要素的坐标值XY的顺序会不同，可根据服务的具体情况配置此参数。
Fires
Examples

添加IGS2.0的WFS图层-不指定图层示例

// ES5引入方式
const { WFSLayer } = zondy.layer
// ES6引入方式
import { WFSLayer } from "@mapgis/webclient-common"
// 初始化WFS图层
const wfsLayer = new WFSLayer({
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WFSServer'
})

添加IGS2.0的WFS图层-不指定图层示例

// ES5引入方式
const { WFSLayer } = zondy.layer
// ES6引入方式
import { WFSLayer } from "@mapgis/webclient-common"
// 初始化WFS图层
const wfsLayer = new WFSLayer({
  // 服务基地址，当不指定图层名称时，默认查询第一个子图层
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WFSServer'
})

添加IGS2.0的WFS图层-指定图层名称示例

// ES5引入方式
const { WFSLayer } = zondy.layer
// ES6引入方式
import { WFSLayer } from "@mapgis/webclient-common"
// 初始化WFS图层
const wfsLayer = new WFSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WFSServer',
  // 通过图层名称指定要查询的图层
  sublayerId: 'Map_Hubei4326:t2'
})

单值专题图

// ES5引入方式
const { WFSLayer } = zondy.layer
const { UniqueValueRenderer } = zondy.renderer
const { SimpleFillSymbol } = zondy.symbol
const { Color } = zondy
// ES6引入方式
import { WFSLayer, UniqueValueRenderer, SimpleFillSymbol, Color } from "@mapgis/webclient-common"
const wfsLayer = new WFSLayer({
  // 服务基地址，当不指定图层名称时，默认查询第一个子图层
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WFSServer',
  // 设置渲染样式-单值专题图
  renderer: new UniqueValueRenderer({
    // 专题图过滤字段名
    field: '字段名',
    // 默认样式，当没有匹配到指定值时，会使用默认样式
    // 因为该数据的几何类型为区，因此设置区样式
    defaultSymbol: new SimpleFillSymbol({
      // 填充颜色
      color: new Color(255, 0, 0),
      // 外边线样式
      outline: new SimpleLineSymbol({
        // 线颜色
        color: new Color(0, 0, 0),
        // 线宽
        width: 1
      })
    }),
    // 单值专题图过滤条件数组
    uniqueValueInfos: [
      {
        //指定字段值
        value: '过滤字段值1',
        //匹配到该值后的样式
        // 因为该数据的几何类型为区，因此设置区样式
        symbol: new SimpleFillSymbol({
          // 填充颜色
          color: new Color(255, 0, 0)
        })
      },
      {
        //指定字段值
        // 因为该数据的几何类型为区，因此设置区样式
        value: '过滤字段值2',
        //匹配到该值后的样式
        // 因为该数据的几何类型为区，因此设置区样式
        symbol: new SimpleFillSymbol({
          // 填充颜色
          color: 'rgb(255, 123, 220)'
        })
      }
    ]
  })
})

分段专题图

// ES5引入方式
const { WFSLayer } = zondy.layer
const { ClassBreakRenderer } = zondy.renderer
const { SimpleLineSymbol } = zondy.symbol
const { Color } = zondy
// ES6引入方式
import { WFSLayer, UniqueValueRenderer, SimpleLineSymbol, Color } from "@mapgis/webclient-common"
const wfsLayer = new WFSLayer({
  // 服务基地址，当不指定图层名称时，默认查询第一个子图层
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WFSServer',
  // 设置渲染样式-分段专题图
  renderer: new ClassBreakRenderer({
    // 专题图过滤字段名
    field: '字段名',
    // 默认样式，当没有匹配到指定值时，会使用默认样式
    // 因为该数据的几何类型为线，因此设置线样式
    defaultSymbol: new SimpleLineSymbol({
      // 线符号颜色
      color: new Color(1, 244, 0),
      // 线宽
      width: 3
    }),
    // 分段专题图过滤条件数组
    classBreakInfos: [
      {
        // 最小过滤范围，field对应的值大于等于minValue
        minValue: 0,
        // 最大过滤范围，field对应的值小于maxValue
        maxValue: 2,
        // 匹配到该值后的样式
        // 因为该数据的几何类型为线，因此设置线样式
        symbol: new SimpleLineSymbol({
          // 线符号颜色
          color: new Color(1, 244, 0),
          // 线宽
          width: 3
        })
      },
      {
        // 最小过滤范围，field对应的值大于等于minValue
        minValue: 3,
        // 最大过滤范围，field对应的值小于maxValue
        maxValue: 5,
        // 匹配到该值后的样式
        // 因为该数据的几何类型为线，因此设置线样式
        symbol: new SimpleLineSymbol({
          // 线符号颜色
          color: new Color(111, 144, 10),
          // 线宽
          width: 3
        })
      },
      {
        // 最小过滤范围，field对应的值大于等于minValue
        minValue: 5,
        // 最大过滤范围，field对应的值小于maxValue
        maxValue: 7,
        // 匹配到该值后的样式
        // 因为该数据的几何类型为线，因此设置线样式
        symbol: new SimpleLineSymbol({
          // 线符号颜色
          color: new Color(22, 244, 10),
          // 线宽
          width: 3
        })
      },
      {
        // 最小过滤范围，field对应的值大于等于minValue
        minValue: 7,
        // 最大过滤范围，field对应的值小于maxValue
        maxValue: 9,
        // 匹配到该值后的样式
        // 因为该数据的几何类型为线，因此设置线样式
        symbol: new SimpleLineSymbol({
          // 线符号颜色
          color: new Color(33, 44, 10),
          // 线宽
          width: 3
        })
      },
      {
        // 最小过滤范围，field对应的值大于等于minValue
        minValue: 9,
        // 最大过滤范围，field对应的值小于maxValue
        maxValue: 20,
        // 匹配到该值后的样式
        // 因为该数据的几何类型为线，因此设置线样式
        symbol: new SimpleLineSymbol({
          // 线符号颜色
          color:  new Color(123, 124, 110),
          // 线宽
          width: 3
        })
      }
    ]
  })
})

统一专题图

// ES5引入方式
const { WFSLayer } = zondy.layer
const { SimpleRenderer } = zondy.renderer
const { SimpleLineSymbol } = zondy.symbol
const { Color } = zondy
// ES6引入方式
import { WFSLayer, SimpleRenderer, SimpleLineSymbol, Color } from "@mapgis/webclient-common"
const wfsLayer = new WFSLayer({
  // 服务基地址，当不指定图层名称时，默认查询第一个子图层
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WFSServer',
  // 设置渲染样式-统一专题图
  renderer: new SimpleRenderer({
    // 因为该数据的几何类型为区，因此设置区样式
    symbol: new SimpleFillSymbol({
      // 填充颜色
      color: new Color(255, 0, 0),
      // 外边线样式
      outline: new SimpleLineSymbol({
        // 线颜色
        color: new Color(0, 0, 0),
        // 线宽度
        width: 1
      })
    })
  })
})

启用注记

// ES5引入方式
const { LabelClass, Color, Font } = zondy
const { TextSymbol } = zondy.symbol
const { WFSLayer } = zondy.layer
// ES6引入方式
import { LabelClass, Color, Font, TextSymbol, WFSLayer } from "@mapgis/webclient-common"
// 初始化LabelClass
const labelClass = new LabelClass({
  // 指定文本符号样式
  symbol: new TextSymbol({
    // 文字颜色
    color: new Color(252, 100, 22, 1),
    // 文字样式
    font: new Font({
      // 字体
      family: "微软雅黑",
      // 文字大小，单位像素
      size: 30,
      // 文字是否为斜体，正常模式
      style: "normal",
      // 文字粗细
      weight: "normal"
    })
  })
})
// 初始化WFS图层
const wfsLayer = new WFSLayer({
  // 服务
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WFSServer',
  // 可在此处设置渲染样式
  renderer: {},
  // 启用注记
  labelsVisible: true,
  // 设置注记样式
  labelingInfo: [labelClass]
})
// 添加到容器中
map.add(wfsLayer)

图层顺序

// ES5引入方式
const { IGSMapImageLayer, WFSLayer } = zondy.layer
// ES6引入方式
import { IGSMapImageLayer, WFSLayer } from "@mapgis/webclient-common"
// 加载地图图片图层，设置index为3
const igsMapImageLayer = new IGSMapImageLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/MapServer',
  // 设置index
  index: 3
});

// 加载完毕后，更改图层顺序
map.reorder(layer, '要移动到的index');

// 初始化WFS图层
const wfsLayer = new WFSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WFSServer',
  // 设置index
  index: 4
})

设置图层透明度

// ES5引入方式
const { WFSLayer } = zondy.layer
// ES6引入方式
import { WFSLayer } from "@mapgis/webclient-common"
// 初始化时指定透明度
const wfsLayer = new WFSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WFSServer',
  // 设置opacity
  opacity: 1
})
// 添加到容器中
map.add(wfsLayer)

// 加载完毕后设置透明度
wfsLayer.opacity = 0.5

设置图层可见性

// ES5引入方式
const { WFSLayer } = zondy.layer
// ES6引入方式
import { WFSLayer } from "@mapgis/webclient-common"
// 在初始化时设置
const wfsLayer = new WFSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WFSServer',
  // 设置图层可见性
  visible: true
})

// 加载完毕后设置可见性
wfsLayer.visible = false

Extends

Members

capabilitiesObject

图层支持能力。图层支持能力分为客户端能力和服务端能力，其中客户端能力包含cesium、leaflet、mapboxgl引擎能力。默认图层客户端能力：所有引擎支持图层加载；默认图层服务端能力为空。

版权所有

corporationTypeNumber

地图服务的公司代码

customParametersObject

自定义查询参数customParameters

descriptionString

图层描述

elevationInfoElevationInfo

高程模式参数

extendPropsObject

额外属性，当前图层对象上不支持的属性，二次开发用户希望挂在图层对像上的属性可以存储到该属性中

Default Value:
{}

extensionOptionsObject

初始化图层的额外参数，可以通过该参数传入引擎原生的构造参数

Default Value:
{}

extentExtent null

图层的范围。从元信息或数据中获取，默认为null表示取不到范围。

geometryTypeGeometryType

服务元数据的几何类型

headersObject

设置服务请求头

httpMethodFetchMethod

http请求方式

idString

图层id

isReverseXYBoolean

是否翻转x，y坐标

labelingInfoArray.<LabelClass>

注记样式数组，默认取数组的第一个样式，仅支持三维动态注记渲染

labelsVisibleBoolean

是否开启动态注记,仅支持三维动态注记渲染

loadedBoolean

是否加载完毕

Default Value:
false

loadErrorObject

请求失败后的错误信息，toJSON方法不会导出该属性

Default Value:
null

loadStatusString

图层加载状态

Default Value:
not-loaded

maxScaleNumber

最大显示比例尺，图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例，图层将不可见。默认值为0，如果图层是瓦片类型，maxScale、minScale的默认值能和tileInfo上的保持一致，如果图层是动态图层，则和地图视图保持一致。maxScale应该始终小于minScale。

Default Value:
0

minScaleNumber

最小显示比例尺，图层在视图中可见的最小比例尺(最缩小)。如果地图被缩小到超过这个比例，图层将不可见。默认值为0，如果图层是瓦片类型，maxScale、minScale的默认值能和tileInfo上的保持一致，如果图层是动态图层，则和地图视图保持一致。minScale应该始终大于maxScale。

Default Value:
0

opacityNumber

图层透明度，0到1之间的值，0为完全透明，1为不透明，会触发图层更新完毕事件。IGSSceneLayer图层类型为地形时，不支持该属性。

outFieldsArray.<String>

服务数据库的所有字段名数组

rendererBaseRenderer

renderer渲染器

spatialReferenceSpatialReference null

图层坐标系对象

sublayerIdString

图层id

titleString

图层名称

tokenAttachTypeTokenAttachType

token附加类型。默认psot请求优先附加到body，get请求优先附加到url末尾

tokenKeyString

token名

Default Value:
token

tokenValueString

token值

typeLayerType

图层类型

typeLayerType

图层类型

urlString

服务地址

versionString

WFS服务版本号

visibleNumber

图层显示或隐藏，true则显示，false则隐藏，会触发图层更新完毕事件

wfsCapabilitiesString

wfsCapabilities信息

Events

inherited 图层加载完毕事件

document/layer/baseLayer/Layer.js, line 46

图层加载完毕事件

Properties:
Name Type Description
event Object

事件对象

Properties
Name Type Default Description
type String 'layerview-created' 可选

图层加载完毕事件
message String null 可选

更新描述
UpdateContent Array.<UpdateContent> null 可选

更新详情对象
layer Layer null 可选

地图图层对象
layerView MapView null 可选

图层的视图对象
sourceTarget Layer null 可选

事件发起对象
target Map null 可选

事件接收对象
Example

图层加载完毕事件

Layer.on('layerview-created', function (result) {
  console.log("加载完毕:", result.layer)
});

inherited 图层显隐更新完毕事件

document/layer/baseLayer/Layer.js, line 90

图层显隐更新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

Properties:
Name Type Description
event Object

事件对象

Properties
Name Type Default Description
type String 'layerview-update' 可选

图层更新完毕事件
message String null 可选

更新描述
updateContent Array.<UpdateContent> null 可选

更新详情对象
layer Layer null 可选

地图图层对象
layerView MapView null 可选

图层的视图对象
sourceTarget Layer null 可选

事件发起对象
target Map null 可选

事件接收对象
Example

图层显隐更新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层显隐事件
    if(updateContent[i].name === 'visible'){
      console.log("图层显隐更新事件:", event);
    }
  }
});

inherited 图层比例尺显示隐藏状态更新事件。当前仅支持非组图层以及场景子图层

document/layer/baseLayer/Layer.js, line 144

图层刷新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

Properties:
Name Type Description
event Object

事件对象

Properties
Name Type Default Description
type String 'layerview-update' 可选

图层更新完毕事件
message String null 可选

更新描述
updateContent Array.<UpdateContent> null 可选

更新详情对象
layer Layer null 可选

地图图层对象
layerView MapView null 可选

图层的视图对象
sourceTarget Layer null 可选

事件发起对象
target Map null 可选

事件接收对象
event LayerViewScaleVisibleEvent

事件对象 layer.on('layerview-scale-visible', (event) => { console.log("图层比例尺显示隐藏状态更新事件:", event) })
Example

图层刷新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层刷新完毕事件
    if(updateContent[i].name === 'refresh'){
      console.log("图层刷新完毕事件:", event);
    }
  }
});

/**

inherited 图层视图更新事件

document/layer/baseLayer/Layer.js, line 80

图层视图更新事件

Properties:
Name Type Description
event LayerViewUpdateEvent

事件对象
Example

图层更新完毕事件

Layer.on('layerview-update', function (result) {
  console.log("更新完毕:", result.layer)
});

inherited 图层透明度更新完毕事件

document/layer/baseLayer/Layer.js, line 117

图层透明度更新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

Properties:
Name Type Description
event Object

事件对象

Properties
Name Type Default Description
type String 'layerview-update' 可选

图层更新完毕事件
message String null 可选

更新描述
updateContent Array.<UpdateContent> null 可选

更新详情对象
layer Layer null 可选

地图图层对象
layerView MapView null 可选

图层的视图对象
sourceTarget Layer null 可选

事件发起对象
target Map null 可选

事件接收对象
Example

图层透明度更新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层透明度更新事件
    if(updateContent[i].name === 'opacity'){
      console.log("图层透明度更新事件:", event);
    }
  }
});

inherited 图层销毁完毕事件

document/layer/baseLayer/Layer.js, line 63

图层销毁完毕事件

Properties:
Name Type Description
event Object

事件对象

Properties
Name Type Default Description
type String 'layerview-remove' 可选

图层销毁完毕事件
message String null 可选

更新描述
updateContent Array.<UpdateContent> null 可选

更新详情对象
layer Layer null 可选

要销毁的地图图层对象
layerView MapView null 可选

图层的视图对象
sourceTarget Layer null 可选

事件发起对象
target Map null 可选

事件接收对象
Example

图层销毁完毕事件

Layer.on('layerview-remove', function (result) {
  console.log("销毁完毕:", result.layer)
});

Methods

WFSLayer.fromJSON(json)

document/layer/ogc/WFSLayer.js, line 901

通过传入的json构造并返回一个新的几何对象

Name Type Description
json Object 可选

JSON对象
Example

通过传入的json构造并返回一个新的几何对象

const json = {
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WFSServer'
}
const wfsLayer = new zondy.layer.WFSLayer.fromJSON(json)

clone(){WFSLayer}

document/layer/ogc/WFSLayer.js, line 951

克隆WFSLayer对象

Returns:
Type Description
WFSLayer 克隆后的WFSLayer实例

inherited destroy(){*}

document/layer/baseLayer/Layer.js, line 618
Returns:
Type Description
*

inherited getProperty(path){*}

document/layer/baseLayer/Layer.js, line 818

获取属性

Name Type Description
path String
Returns:
Type Description
* 属性值

inherited isLoaded(){Boolean}

document/layer/baseLayer/Layer.js, line 543

判断图层是否加载成功

Returns:
Type Description
Boolean 图层是否加载成功

load()

document/layer/ogc/WFSLayer.js, line 674

加载图层资源

Example

不加载图层，仅获取图层信息

// ES5引入方式
const { WFSLayer } = zondy.layer
// ES6引入方式
import { WFSLayer } from "@mapgis/webclient-common"
// 初始化图层
const wfsLayer = new WFSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WFSServer'
});
wfsLayer.load().then((result) => {
  // 获取完图层信息
  console.log(wfsLayer)
})

queryFeatures(queryOptions){Promise.<FeatureSet>}

document/layer/ogc/WFSLayer.js, line 823

指定图层的要素查询

Name Type Description
queryOptions Object

参考此接口的入参WFSServer#queryFeatures
Returns:
Type Description
Promise.<FeatureSet>
Example

指定图层的要素查询

wfsLayer.queryFeatures({
  // 图层id
  layerId: '0',
  // where语句
  where: "查询条件"
}).then((result) => {
  console.log('查询结果:', result)
})

queryFeaturesCount(queryOptions){Promise.<Number>}

document/layer/ogc/WFSLayer.js, line 858

查询要素数量

Name Type Description
queryOptions Object

参考此接口的入参WFSServer#queryFeatures
Returns:
Type Description
Promise.<Number>
Example

查询要素数量

igsFeatureLayer.queryFeaturesCount({
  // 图层id
  layerId: '0',
  // where语句
  where: "查询条件"
}).then((result) => {
  console.log('查询结果:', result)
})

inherited refresh()

document/layer/baseLayer/Layer.js, line 747

刷新图层

inherited setProperty(path, value){Boolean}

document/layer/baseLayer/Layer.js, line 778

设置属性值或者属性路径对应的值。由于当前仅支持第一级属性响应，无法解决多级属性响应机制，此方法支持属性路径响应机制。例如:path输入'tileInfo.startLevel',则会响应式更新startLevel。

Name Type Description
path String

属性路径，可以传入单个属性后者一个属性的路径
value *
Returns:
Type Description
Boolean 是否设置成功

toJSON(){Object}

document/layer/ogc/WFSLayer.js, line 920

转换为json对象

Returns:
Type Description
Object json对象