MapGIS Client for JavaScript API

new GeoJSONLayer(options)

document/layer/GeoJSONLayer.js, line 18

支持如下方法：

[1、加载图层资源]
[2、销毁图层]
[3、返回所有要素]
[4、查询要素数量]
[5、通过传入的json构造并返回一个新的几何对象]
6、导出为json对象
7、克隆几何对象

geojson图层，仅支持文件服务
目前二维和三维上支持4326(包括4490，4214以及4610)，3857以及EPSG支持的自定义坐标系，若是想要绘制源数据为非4326坐标系几何数据，需要在初始化时指定具体坐标系
参考示例：
[加载GeoJSON图层]

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

Name Type Description

options

Object

构造参数

Name	Type	Default	Description
`url`	String \| Object		可选支持TopoJSON和GeoJSON数据的加载，可以传入GeoJSON Object或TopoJSON Object，如果传入为url，仅支持文件服务：参考示例： [1、加载GeoJSON图层] [2、加载自定义坐标系的GeoJSON图层] [3、删除GeoJSON图层]
`id`	String		可选图层id，若不填则给一个随机id
`visible`	Boolean	show	可选图层可见性，参考示例：[图层可见性]
`opacity`	Number	1	可选图层透明度，0~1之间的值，0完全透明，1不透明，参考示例：[图层透明度]
`spatialReference`	SpatialReference		可选图层坐标系，默认为4326，若是想要绘制源数据为非4326坐标系几何数据，需要在初始化时指定具体坐标系
`renderer`	BaseRenderer \| Object \| null		可选渲染样式，目前支持如下样式： `1、单值专题图` `2、分段专题图` `3、统一专题图` 参考示例： [1、单值专题图] [2、分段专题图] [3、统一专题图]
`labelsVisible`	Boolean	false	可选是否开启动态注记,仅支持三维动态注记渲染
`labelingInfo`	Array.<LabelClass>	[]	可选注记样式数组，可以和renderer同时启用，默认取数组的第一个样式，仅支持三维场景，参考示例：[注记样式]
`elevationInfo`	ElevationInfo		可选设置高程参数，指定几何是否贴地、贴模型、都贴、都不贴或者是绝对高度
`minScale`	Number	0	可选最小显示比例尺，图层在视图中可见的最小比例尺。
`maxScale`	Number	0	可选最大显示比例尺，图层在视图中可见的最大比例尺。
`tokenKey`	String	'token'	可选 token名
`tokenValue`	String		可选 token值，只有当tokenValue存在时，才会绑定token
`customParameters`	Object	{}	可选自定义查询参数，键值对，填写该参数后，会在数据请求的来链接后面以&key=value的形式拼接字符串

Fires

Examples

初始化GeoJSON图层

// 初始化图层管理容器
// ES5引入方式
const { GeoJSONLayer } = zondy.layer
// ES6引入方式
import { GeoJSONLayer } from "@mapgis/webclient-common"
// 创建图层
const geojsonLayer = new GeoJSONLayer({
  // 服务基地址
  url: 'json数据地址'
})

加载自定义坐标系的GeoJSON图层

// ES5引入方式
const { SpatialReference } = zondy
const { GeoJSONLayer } = zondy.layer
// ES6引入方式
import { SpatialReference, GeoJSONLayer } from "@mapgis/webclient-common"
// 创建图层
const geojsonLayer = new GeoJSONLayer({
  // 服务基地址
  url: 'json数据地址',
  // 设置坐标系
  spatialReference: new SpatialReference({
    wkid: '坐标系的wkid'
  })
})

删除GeoJSON图层

// 删除图层
map.remove(geojsonLayer)

单值专题图-区数据

// ES5引入方式
const { Color} = zondy
const { GeoJSONLayer } = zondy.layer
const { UniqueValueRenderer } = zondy.renderer
const { SimpleLineSymbol,SimpleFillSymbol } = zondy.symbol
// ES6引入方式
import { Color,GeoJSONLayer,UniqueValueRenderer,SimpleLineSymbol,SimpleFillSymbol } from "@mapgis/webclient-common"
// 创建图层
const geojsonLayer = new GeoJSONLayer({
  // 服务基地址
  url: 'json数据地址',
  // 渲染样式 - 单值专题图 - 区数据
  renderer: new UniqueValueRenderer({
    //字段名
    field: '你的字段名',
    // 默认符号，不在专题图指定范围内的会采用该样式，可不设置
    defaultSymbol: new zondy.symbol.SimpleFillSymbol({
      // 填充颜色
      color: zondy.Color(1 , 1, 252),
      // 外边线样式
      outline: new SimpleLineSymbol({
        //线颜色
        color: new Color(255, 1, 0, 1),
        //线宽
        width: 1
      })
    }),
    //单值专题图字段样式
    uniqueValueInfos: [{
      //指定字段值
      value: "指定的值",
      //匹配到该值后的样式
      symbol: new SimpleFillSymbol({
        // 填充颜色
        color: Color(1, 1, 252),
        // 外边线样式
        outline: new SimpleLineSymbol({
          //线符号颜色
          color: new Color(255, 1, 0),
          //线宽
          width: 1
          })
        })
      },{
        //指定字段值
        value: "指定的值",
        //匹配到该值后的样式
        symbol: new SimpleFillSymbol({
          // 填充颜色
          color: new Color(211, 111, 11, 1)
        })
      }]
  })
})

分段专题图-区数据

// ES5引入方式
const { Color} = zondy
const { GeoJSONLayer } = zondy.layer
const { ClassBreakRenderer } = zondy.renderer
const { SimpleLineSymbol,SimpleFillSymbol } = zondy.symbol
// ES6引入方式
import { Color,GeoJSONLayer,ClassBreakRenderer, SimpleLineSymbol,SimpleFillSymbol} from "@mapgis/webclient-common"
// 创建图层
const geojsonLayer = new GeoJSONLayer({
  // 服务基地址
  url: 'json数据地址',
  // 渲染样式 - 分段专题图 - 区数据
  renderer: new ClassBreakRenderer({
     //字段名
     field: '你的字段名',
     // 指定默认样式，不在专题图指定范围内的会采用该样式，可不设置
     defaultSymbol:  new SimpleFillSymbol({
       // 填充颜色
       color: new Color(222, 1, 252),
       // 线符号样式
       outline: new SimpleLineSymbol({
         //线符号颜色
         color: new zondy.Color(255, 1, 0),
         //线宽
         width: 1
       })
     }),
     //分段专题图字段样式
     classBreakInfos: [{
       // 最大范围
       maxValue: "最大范围",
       // 最小范围
       minValue: "最小范围",
       //匹配到该值后的样式
       symbol:  new SimpleFillSymbol({
         // 填充颜色
         color: new Color(1, 1, 252),
         // 线符号样式
         outline: new SimpleLineSymbol({
           //线符号颜色
           color: new Color(255, 1, 0, 1),
           //线宽
           width: 1
         })
       })
     }]
   })
})

统一专题图-区数据

// ES5引入方式
const { GeoJSONLayer } = zondy.layer
const { SimpleRenderer } = zondy.renderer
const { SimpleFillSymbol,SimpleLineSymbol } = zondy.symbol
const { Color } = zondy
// ES6引入方式
import { Color,GeoJSONLayer, SimpleRenderer,SimpleLineSymbol,SimpleFillSymbol} from "@mapgis/webclient-common"
const geojsonLayer = new GeoJSONLayer({
  // 服务基地址
  url: 'json数据地址',
  // 渲染样式 - 统一专题图 - 区数据
  renderer: new SimpleRenderer({
    // 设置几何的样式
    symbol: new SimpleFillSymbol({
      //线符号颜色
      color: randomColor(),
      // 外边线样式
      outline: new SimpleLineSymbol({
        // 外边线颜色
        color: new Color(1, 1, 252),
        // 外边线宽度
        width: 1
      })
    })
  })
})

设置图层顺序

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

图层可见性

// 创建图层
// ES5引入方式
const { GeoJSONLayer } = zondy.layer
// ES6引入方式
import { GeoJSONLayer } from "@mapgis/webclient-common"
const geojsonLayer = new GeoJSONLayer({
  // 服务基地址
  url: 'json数据地址',
  // 设置图层可见性
  visible: true
})

// 图层加载完成后，设置可见性
geojsonLayer.visible = !geojsonLayer.visible

图层透明度

// 创建图层
 // ES5引入方式
const { GeoJSONLayer } = zondy.layer
// ES6引入方式
import { GeoJSONLayer } from "@mapgis/webclient-common"
const geojsonLayer = new zondy.layer.GeoJSONLayer({
  // 服务基地址
  url: 'json数据地址',
  // 设置图层透明度
  opacity: 1
})

// 图层加载完成后，设置可见性
geojsonLayer.opacity = 0.5

启用注记

 // ES5引入方式
const { LabelClass,Font } = zondy
const { TextSymbol } = zondy.symbol
const { GeoJSONLayer } = zondy.layer
// ES6引入方式
import { LabelClass,Font,TextSymbol,GeoJSONLayer } 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"
    })
  })
})
// 初始化GeoJSON图层
const geojsonLayer = new GeoJSONLayer({
  // 服务基地址，当不指定图层名称时，默认查询第一个子图层
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/FeatureServer',
  // 可在此处设置渲染样式
  renderer: {},
  // 启用注记
  labelsVisible: true,
  // 设置注记样式
  labelingInfo: [labelClass]
})

Extends

Layer

Members

capabilitiesObject

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

copyrightString

customParametersObject

自定义查询参数customParameters

descriptionString

图层描述

elevationInfoElevationInfo

高程模式参数

extendPropsObject

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

Default Value:

extensionOptionsObject

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

Default Value:

extentExtent null

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

geometryTypeGeometryType

几何类型

headersObject

设置服务请求头

httpMethodFetchMethod

http请求方式

idString

图层id

labelingInfoArray.<LabelClass>

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

labelsVisibleBoolean

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

loadedBoolean

是否加载完毕

Default Value:

loadErrorObject

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

Default Value:

loadStatusString

图层加载状态

Default Value:

maxScaleNumber

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

Default Value:

minScaleNumber

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

Default Value:

opacityNumber

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

rendererBaseRenderer Object

渲染器

spatialReferenceSpatialReference null

图层坐标系对象

titleString

图层名称

tokenAttachTypeTokenAttachType

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

tokenKeyString

token名

Default Value:

tokenValueString

token值

typeString

图层类型

urlString

请求地址或者geojson对象

visibleNumber

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

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);
    }
  }
});

图层样式更新完毕事件 document/layer/GeoJSONLayer.js, line 316

图层样式更新完毕事件，请注意该事件是图层更新事件(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 === 'renderer'){
      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

GeoJSONLayer.fromJSON(json) document/layer/GeoJSONLayer.js, line 649

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

Name	Type	Description
`json`	Object	可选 JSON对象

Example

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

const json = {
  // 服务基地址
  url: 'json数据地址'
}
const geojsonLayer = new zondy.layer.GeoJSONLayer.fromJSON(json)

clone(){GeoJSONLayer} document/layer/GeoJSONLayer.js, line 687

克隆GeoJSONLayer对象

Returns:

Type	Description
GeoJSONLayer	克隆后的GeoJSONLayer实例

destroy() document/layer/GeoJSONLayer.js, line 575

销毁图层

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	图层是否加载成功

queryFeatures(){Promise.<FeatureSet>} document/layer/GeoJSONLayer.js, line 581

返回所有要素

Returns:

Type	Description
Promise.<FeatureSet>

queryFeaturesCount(){Promise.<Number>} document/layer/GeoJSONLayer.js, line 591

查询要素数量

Returns:

Type	Description
Promise.<Number>

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/GeoJSONLayer.js, line 661

导出json对象

Returns:

Type	Description
Object	json对象

Class: GeoJSONLayer

new GeoJSONLayer(options)

支持如下方法：

Fires

Examples

Extends

Members

capabilitiesObject

copyrightString

customParametersObject

descriptionString

elevationInfoElevationInfo

extendPropsObject

extensionOptionsObject

extentExtent null

geometryTypeGeometryType

headersObject

httpMethodFetchMethod

idString

labelingInfoArray.<LabelClass>

labelsVisibleBoolean

loadedBoolean

loadErrorObject

loadStatusString

maxScaleNumber

minScaleNumber

opacityNumber

rendererBaseRenderer Object

spatialReferenceSpatialReference null

titleString

tokenAttachTypeTokenAttachType

tokenKeyString

tokenValueString

typeString

urlString

visibleNumber

Events

inherited 图层加载完毕事件

Properties:

Properties

Example

inherited 图层显隐更新完毕事件

Properties:

Properties

Example

图层显隐更新完毕事件

图层样式更新完毕事件

Properties:

Properties

Example

图层样式更新完毕事件

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

Properties:

Properties

Example

图层刷新完毕事件

inherited 图层视图更新事件

Properties:

Example

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

Properties:

Properties

Example

图层透明度更新完毕事件

inherited 图层销毁完毕事件

Properties:

Properties

Example

Methods

GeoJSONLayer.fromJSON(json)

Example

clone(){GeoJSONLayer}

Returns:

destroy()

inherited getProperty(path){*}

Returns:

inherited isLoaded(){Boolean}

Returns:

queryFeatures(){Promise.<FeatureSet>}

Returns: