@mapgis/webclient-leaflet-plugin
Version:
1,739 lines • 96.9 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title> common/base/Collection.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/app.min.css">
<link type="text/css" rel="stylesheet" href="styles/iframe.css">
<link type="text/css" rel="stylesheet" href="">
</head>
<body class="layout small-header">
<div id="stickyNavbarOverlay"></div>
<div class="top-nav">
<div class="inner">
<a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
</a>
<div class="logo">
<h1> MapGIS Client for JavaScript API</h1>
</div>
<div class="menu">
<div class="navigation">
<a
class="link user-link "
href="/docs/cesium/index.html"
>
Cesium
</a>
<a
class="link user-link "
href="/docs/mapboxgl/index.html"
>
MapboxGL
</a>
<a
class="link user-link "
href="/docs/leaflet/index.html"
>
Leaflet
</a>
<a
class="link user-link "
href="/docs/openlayers/index.html"
>
OpenLayers
</a>
</div>
</div>
</div>
</div>
<div id="main">
<div
class="sidebar "
id="sidebarNav"
>
<div>
<span class="mapgis-api-document-span"><a href="index.html">API文档</a></span>
</div>
<div class="search-wrapper">
<input id="search" type="text" placeholder="搜索文档..." class="input">
</div>
<nav>
<div class="category"><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">服务模块</div><ul class="mapgis-sidebar-menus"><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="AddressServer.html">AddressServer</a><span style="display: none;"><p>地址服务，基地址：/igs/rest/services/{folder}/{serviceName}/AddressServer</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ArcGISFeatureServer.html">ArcGISFeatureServer</a><span style="display: none;"><p>ArcGIS的FeatureServer服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ArcGISGeometryServer.html">ArcGISGeometryServer</a><span style="display: none;"><p>ArcGIS的GeometryServer服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ArcGISMapServer.html">ArcGISMapServer</a><span style="display: none;"><p>ArcGIS的MapServer服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ArcGISVectorTileServer.html">ArcGISVectorTileServer</a><span style="display: none;"><p>ArcGIS的VectorTileServer服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="BaseServer.html">BaseServer</a><span style="display: none;"><p>服务查询基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Cesium3DTilesServer.html">Cesium3DTilesServer</a><span style="display: none;"><p>3DTiles服务，基地址：/igs/rest/services/{folder}/{serviceName}/3DTilesServer</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Config.html">Config</a><span style="display: none;"><p>全局配置信息<br/>
示例如下：<br/>
<a href='#config1'>[1、设置全局token]</a><br/>
<a href='#config2'>[2、设置全局headers]</a><br/>
<a href='#config3'>[3、设置拦截器 - 在所有链接上设置拦截器]</a><br/>
<a href='#config4'>[4、设置拦截器 - 指定拦截器应用的url]</a><br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="FeatureServer.html">FeatureServer</a><span style="display: none;"><p>要素服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="GeometryServer.html">GeometryServer</a><span style="display: none;"><p>地理几何服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ImageServer.html">ImageServer</a><span style="display: none;"><p>影像服务，服务地址：/igs/rest/services/{folder}/{serviceName}/ImageServer</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Interceptor.html">Interceptor</a><span style="display: none;"><p>请求拦截和相应拦截器参数</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="M3DServer.html">M3DServer</a><span style="display: none;"><p>M3d服务，服务地址:/igs/rest/services/{folder}/{serviceName}/M3dServer</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="MapServer.html">MapServer</a><span style="display: none;"><p>地图服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="PlotServer.html">PlotServer</a><span style="display: none;"><p>标绘服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="PoiServer.html">PoiServer</a><span style="display: none;"><p>兴趣点服务,服务地址：/igs/rest/services/{folder}/{serviceName}/PoiServer</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="RequestConfig.html">RequestConfig</a><span style="display: none;"><p>请求配置参数</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="RequestInterceptor.html">RequestInterceptor</a><span style="display: none;"><p>请求拦截器对象</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ResourceServer.html">ResourceServer</a><span style="display: none;"><p>资源服务，基地址为http://{ip}:{port}/igs/rest/services/system/ResourceServer</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ResponseInterceptor.html">ResponseInterceptor</a><span style="display: none;"><p>响应拦截器对象</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="RootServer.html">RootServer</a><span style="display: none;"><p>根目录服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SceneServer.html">SceneServer</a><span style="display: none;"><p>场景服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SecurityServer.html">SecurityServer</a><span style="display: none;"><p>安全服务,服务地址:/igs/rest/services/SecurityServer</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="TerrainServer.html">TerrainServer</a><span style="display: none;"><p>地形缓存服务，基地址:/igs/rest/services/{folder}/{serviceName}/TerrainServer</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ThemeServer.html">ThemeServer</a><span style="display: none;"><p>专题图服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="TileServer.html">TileServer</a><span style="display: none;"><p>瓦片服务,基地址：/igs/rest/services/{folder}/{serviceName}/TileServer</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="VectorTileServer.html">VectorTileServer</a><span style="display: none;"><p>矢量瓦片服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="WFSServer.html">WFSServer</a><span style="display: none;"><p>IGS的WFS服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="WMSServer.html">WMSServer</a><span style="display: none;"><p>IGS的WMS服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="WMTSServer.html">WMTSServer</a><span style="display: none;"><p>IGS的WMTS服务</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="WorkFlowServer.html">WorkFlowServer</a><span style="display: none;"><p>工作流服务,基地址http://{ip}:{port}/igs/rest/services/workflow/{serviceName}/WorkflowServer</p></span></li></ul><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">图层模块</div><ul class="mapgis-sidebar-menus"><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ArcGISMapImageLayer.html">ArcGISMapImageLayer</a><span style="display: none;"><p>ArcGIS地图图片图层，<br/>
目前二维上支持4326(包括4490，4214以及4610)，3857以及EPSG支持的自定义坐标系，三维上仅支持4326(包括4490，4214以及4610)以及3857坐标系，会自动读取元信息上的坐标系，不需要用户指定
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.ArcGISMapImageLayer() <br/>
[ES6引入方式]：<br/>
import { ArcGISMapImageLayer } from "@mapgis/webclient-common" <br/>
<br/>
针对图层的操作请在图层加载完毕事件中进行<br/>
Layer.on('layerview-created', function (result) {<br/>
console.log("加载完毕:", result.layer)<br/>
});<br/>
如果不想在该事件中放入业务代码，则请确认图层资源已加载完毕后再进行操作<br/>
if(layer.loadStatus === 'loaded') {<br/>
// 你的业务逻辑<br/>
}</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ArcGISMapImageSubLayer.html">ArcGISMapImageSubLayer</a><span style="display: none;"><p>ArcGIS地图图片子图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ArcGISTileLayer.html">ArcGISTileLayer</a><span style="display: none;"><p>ArcGIS瓦片图层，<br>
目前二维上支持4326(包括4490，4214以及4610)，3857以及EPSG支持的自定义坐标系，三维上仅支持4326(包括4490，4214以及4610)以及3857坐标系，会自动读取元信息上的坐标系，不需要用户指定，
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.ArcGISTileLayer() <br/>
[ES6引入方式]：<br/>
import { ArcGISTileLayer } from "@mapgis/webclient-common" <br/>
<br/>
针对图层的操作请在图层加载完毕事件中进行<br/>
Layer.on('layerview-created', function (result) {<br/>
console.log("加载完毕:", result.layer)<br/>
});<br/>
如果不想在该事件中放入业务代码，则请确认图层资源已加载完毕后再进行操作<br/>
if(layer.loadStatus === 'loaded') {<br/>
// 你的业务逻辑<br/>
}</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ArcGISVectorTileLayer.html">ArcGISVectorTileLayer</a><span style="display: none;"><p>ArcGIS矢量瓦片图层
支持通过加载矢量瓦片服务、加载矢量瓦片样式文件和设置矢量瓦片样式的方式创建矢量瓦片图层
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.ArcGISVectorTileLayer() <br/>
[ES6引入方式]：<br/>
import { ArcGISVectorTileLayer } from "@mapgis/webclient-common" <br/>
<br/>
针对图层的操作请在图层加载完毕事件中进行<br/>
Layer.on('layerview-created', function (result) {<br/>
console.log("加载完毕:", result.layer)<br/>
});<br/>
如果不想在该事件中放入业务代码，则请确认图层资源以加载完毕后再进行操作<br/>
if(layer.loadStatus === 'loaded') {<br/>
// 你的业务逻辑<br/>
}
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ArcGISVectorTileSubLayer.html">ArcGISVectorTileSubLayer</a><span style="display: none;"><p>ArcGIS矢量瓦片子图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Cesium3DTilesCacheLayer.html">Cesium3DTilesCacheLayer</a><span style="display: none;"><p>Cesium3DTiles图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="EchartsLayer.html">EchartsLayer</a><span style="display: none;"><p>Echarts图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="FeatureLayer.html">FeatureLayer</a><span style="display: none;"><p>要素图层基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="GeoJSONLayer.html">GeoJSONLayer</a><span style="display: none;"><p>geojson图层，仅支持文件服务<br/>
目前二维和三维上支持4326(包括4490，4214以及4610)，3857以及EPSG支持的自定义坐标系，若是想要绘制源数据为非4326坐标系几何数据，需要在初始化时指定具体坐标系<br/>
参考示例：<br/>
<a href='#add-GeoJSONLayer'>[加载GeoJSON图层]</a>
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.GraphicsLayer() <br/>
[ES6引入方式]：<br/>
import { GraphicsLayer } from "@mapgis/webclient-common"</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="GraphicsLayer.html">GraphicsLayer</a><span style="display: none;"><p>几何图形图层，不支持在线数据，仅支持传入多个几何对象并绘制<br/>
目前二维和三维上支持4326(包括4490，4214以及4610)，3857以及EPSG支持的自定义坐标系，若是想要绘制非4326坐标系几何，需要在初始化要素对象的几何时，指定具体坐标系
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.GraphicsLayer() <br/>
[ES6引入方式]：<br/>
import { GraphicsLayer } from "@mapgis/webclient-common" <br/>
<br/>
针对图层的操作请在图层加载完毕事件中进行<br/>
Layer.on('layerview-created', function (result) {<br/>
console.log("加载完毕:", result.layer)<br/>
});<br/>
如果不想在该事件中放入业务代码，则请确认图层资源已加载完毕后再进行操作<br/>
if(layer.loadStatus === 'loaded') {<br/>
// 你的业务逻辑<br/>
}</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="GroupLayer.html">GroupLayer</a><span style="display: none;"><p>组图层，支持的图层类型有：WMS图层、WMTS图层、地图图层、瓦片图层、cesium3DTiles图层、echarts图层、
M3D图层、场景图层、矢量瓦片图层、mapv图层、地形图层
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.GroupLayer() <br/>
[ES6引入方式]：<br/>
import { GroupLayer } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="IGSFeatureLayer.html">IGSFeatureLayer</a><span style="display: none;"><p>IGS要素图层，<br>
目前二维和三维上支持4326(包括4490，4214以及4610)，3857以及EPSG支持的自定义坐标系，要素服务会自动读取元信息上的坐标系，不需要用户指定
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.IGSFeatureLayer() <br/>
[ES6引入方式]：<br/>
import { IGSFeatureLayer } from "@mapgis/webclient-common" <br/>
<br/>
针对图层的操作请在图层加载完毕事件中进行<br/>
Layer.on('layerview-created', function (result) {<br/>
console.log("加载完毕:", result.layer)<br/>
});<br/>
如果不想在该事件中放入业务代码，则请确认图层资源已加载完毕后再进行操作<br/>
if(layer.loadStatus === 'loaded') {<br/>
// 你的业务逻辑<br/>
}</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="IGSImageLayer.html">IGSImageLayer</a><span style="display: none;"><p>IGS影像图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="IGSMapImageLayer.html">IGSMapImageLayer</a><span style="display: none;"><p>IGS地图图片图层，<br/>
支持IGS1.0和2.0两个服务版本，支持自定义坐标系，当IGS版本是1.0时，需要手动设置图层坐标系，当IGS版本是2.0时，会自动读取元信息上的坐标系，不需要用户指定<br/>
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.IGSMapImageLayer() <br/>
[ES6引入方式]：<br/>
import { IGSMapImageLayer } from "@mapgis/webclient-common" <br/>
<br/>
针对图层的操作请在图层加载完毕事件中进行<br/>
Layer.on('layerview-created', function (result) {<br/>
console.log("加载完毕:", result.layer)<br/>
});<br/>
如果不想在该事件中放入业务代码，则请确认图层资源已加载完毕后再进行操作<br/>
if(layer.loadStatus === 'loaded') {<br/>
// 你的业务逻辑<br/>
}</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="IGSMapImageSubLayer.html">IGSMapImageSubLayer</a><span style="display: none;"><p>IGS地图图片图层的子图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="IGSSceneLayer.html">IGSSceneLayer</a><span style="display: none;"><p>IGS的SceneLayer图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="IGSSceneSubLayer.html">IGSSceneSubLayer</a><span style="display: none;"><p>IGS的SceneLayer子图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="IGSTileLayer.html">IGSTileLayer</a><span style="display: none;"><p>IGS瓦片图层，<br>
支持IGS1.0和2.0两个服务版本，支持自定义坐标系，当IGS版本是1.0时，需要手动设置图层坐标系，当IGS版本是2.0时，会自动读取元信息上的坐标系，不需要用户指定，
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.IGSTileLayer() <br/>
[ES6引入方式]：<br/>
import { IGSTileLayer } from "@mapgis/webclient-common" <br/>
<br/>
针对图层的操作请在图层加载完毕事件中进行<br/>
Layer.on('layerview-created', function (result) {<br/>
console.log("加载完毕:", result.layer)<br/>
});<br/>
如果不想在该事件中放入业务代码，则请确认图层资源已加载完毕后再进行操作<br/>
if(layer.loadStatus === 'loaded') {<br/>
// 你的业务逻辑<br/>
}</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="IGSVectorTileLayer.html">IGSVectorTileLayer</a><span style="display: none;"><p>IGS矢量瓦片图层
支持IGS1.0和2.0两个服务版本，目前二维和三维上支持4326(包括4490，4214以及4610)，3857，会自动读取元信息上的坐标系，不需要用户指定，
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.IGSVectorTileLayer() <br/>
[ES6引入方式]：<br/>
import { IGSVectorTileLayer } from "@mapgis/webclient-common" <br/>
<br/>
针对图层的操作请在图层加载完毕事件中进行<br/>
Layer.on('layerview-created', function (result) {<br/>
console.log("加载完毕:", result.layer)<br/>
});<br/>
如果不想在该事件中放入业务代码，则请确认图层资源以加载完毕后再进行操作<br/>
if(layer.loadStatus === 'loaded') {<br/>
// 你的业务逻辑<br/>
}
<br/>
<br/>
注意:三维上,不支持简单Marker样式设定;二维上,简单Marker的颜色,外边线样式,旋转角度无法在图层初始化和初始化后修改,须在制作数据时进行指定</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="IGSVectorTileSubLayer.html">IGSVectorTileSubLayer</a><span style="display: none;"><p>IGS矢量瓦片子图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Layer.html">Layer</a><span style="display: none;"><p>图层基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="M3DModelCacheLayer.html">M3DModelCacheLayer</a><span style="display: none;"><p>M3D缓存图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="MapImageLayer.html">MapImageLayer</a><span style="display: none;"><p>影像图层基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="MapVLayer.html">MapVLayer</a><span style="display: none;"><p>MapV图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="OGCLayer.html">OGCLayer</a><span style="display: none;"><p>OGS图层基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="OverlayLayer.html">OverlayLayer</a><span style="display: none;"><p>覆盖物图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Scene.html">Scene</a><span style="display: none;"><p>场景对象</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SceneLayer.html">SceneLayer</a><span style="display: none;"><p>场景图层基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SubLayer.html">SubLayer</a><span style="display: none;"><p>子图层基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="TerrainCacheLayer.html">TerrainCacheLayer</a><span style="display: none;"><p>地形图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="TileLayer.html">TileLayer</a><span style="display: none;"><p>瓦片图层基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="UnknownLayer.html">UnknownLayer</a><span style="display: none;"><p>未定义图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="VectorTileLayer.html">VectorTileLayer</a><span style="display: none;"><p>图层基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="WFSLayer.html">WFSLayer</a><span style="display: none;"><p>WFS图层，<br>
目前二维和三维上支持4326(包括4490，4214以及4610)，3857以及EPSG支持的自定义坐标系，WFS服务会自动读取元信息上的坐标系，不需要用户指定
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.WMTSLayer() <br/>
[ES6引入方式]：<br/>
import { WMTSLayer } from "@mapgis/webclient-common" <br/>
<br/>
针对图层的操作请在图层加载完毕事件中进行<br/>
Layer.on('layerview-created', function (result) {<br/>
console.log("加载完毕:", result.layer)<br/>
});<br/>
如果不想在该事件中放入业务代码，则请确认图层资源已加载完毕后再进行操作<br/>
if(layer.loadStatus === 'loaded') {<br/>
// 你的业务逻辑<br/>
}</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="WMSLayer.html">WMSLayer</a><span style="display: none;"><p>WMS图层，<br/>
目前二维上支持4326(包括4490，4214以及4610)，3857以及EPSG支持的自定义坐标系，三维上仅支持4326(包括4490，4214以及4610)以及3857坐标系，会自动读取元信息上的坐标系，不需要用户指定，同时所有的WMS服务都支持动态投影，用户也可指定任意该服务支持的坐标系<br/>
<br>[ES5引入方式]：<br/>
Zondy.Layer.WMSLayer() <br/>
[ES6引入方式]：<br/>
import { WMSLayer } from "@mapgis/webclient-common" <br/>
<br/>
针对图层的操作请在图层加载完毕事件中进行<br/>
Layer.on('layerview-created', function (result) {<br/>
console.log("加载完毕:", result.layer)<br/>
});<br/>
如果不想在该事件中放入业务代码，则请确认图层资源已加载完毕后再进行操作<br/>
if(layer.loadStatus === 'loaded') {<br/>
// 你的业务逻辑<br/>
}</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="WMSSubLayer.html">WMSSubLayer</a><span style="display: none;"><p>WMS子图层</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="WMTSLayer.html">WMTSLayer</a><span style="display: none;"><p>WMTS图层，<br>
目前二维上支持4326(包括4490，4214以及4610)，3857以及EPSG支持的自定义坐标系，三维上仅支持4326(包括4490，4214以及4610)以及3857坐标系，WMTS服务会自动读取元信息上的坐标系，不需要用户指定
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.WMTSLayer() <br/>
[ES6引入方式]：<br/>
import { WMTSLayer } from "@mapgis/webclient-common" <br/>
<br/>
针对图层的操作请在图层加载完毕事件中进行<br/>
Layer.on('layerview-created', function (result) {<br/>
console.log("加载完毕:", result.layer)<br/>
});<br/>
如果不想在该事件中放入业务代码，则请确认图层资源已加载完毕后再进行操作<br/>
if(layer.loadStatus === 'loaded') {<br/>
// 你的业务逻辑<br/>
}</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="WMTSSubLayer.html">WMTSSubLayer</a><span style="display: none;"><p>IGS地图服务图层</p></span></li></ul><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">地图模块</div><ul class="mapgis-sidebar-menus"><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Basemap.html">Basemap</a><span style="display: none;"><p>基础地图对象
<br>[ES5引入方式]：<br/>
Zondy.Basemap() <br/>
[ES6引入方式]：<br/>
import { Map } from "@mapgis/webclient-common" <br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Map.html">Map</a><span style="display: none;"><p>图层管理容器，和地图引擎无关，通过此对象而不是地图引擎来对图层进行管理
<br>[ES5引入方式]：<br/>
Zondy.Map() <br/>
[ES6引入方式]：<br/>
import { Map } from "@mapgis/webclient-common" <br/></p></span></li></ul><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">渲染器模块</div><ul class="mapgis-sidebar-menus"><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="BaseRenderer.html">BaseRenderer</a><span style="display: none;"><p>专题图渲染基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ClassBreakInfo.html">ClassBreakInfo</a><span style="display: none;"><p>三维专题图-分段信息</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ClassBreakRenderer.html">ClassBreakRenderer</a><span style="display: none;"><p>分段专题图渲染样式，支持的图层如下：<br/>
[IGS地图图片图层]{@link IGSMapImageLayer}、[几何图形图层]{@link GraphicsLayer}、[IGS要素图层]{@link IGSFeatureLayer}、
[geojson图层]{@link GeoJSONLayer}、[OGC-WFS图层]{@link WFSLayer}</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ClusterInfo.html">ClusterInfo</a><span style="display: none;"><p>聚合点数量区间内的符号信息</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ClusterRenderer.html">ClusterRenderer</a><span style="display: none;"><p>聚类渲染器，多个点聚集在一起，会形成一个点符号</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ColorStop.html">ColorStop</a><span style="display: none;"><p>颜色分段</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ColorVariable.html">ColorVariable</a><span style="display: none;"><p>color视觉变量</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="HeatmapColorStop.html">HeatmapColorStop</a><span style="display: none;"><p>热力图分段颜色和比率</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="HeatmapRenderer.html">HeatmapRenderer</a><span style="display: none;"><p>热力图渲染器</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="OpacityStop.html">OpacityStop</a><span style="display: none;"><p>透明度分段</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="OpacityVariable.html">OpacityVariable</a><span style="display: none;"><p>opacity视觉变量</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="RandomRenderer.html">RandomRenderer</a><span style="display: none;"><p>随机渲染器，将随机颜色赋予要素，根据zoom等级颜色也将发生变化</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="RankRenderer.html">RankRenderer</a><span style="display: none;"><p>等级符号专题图，符号尺寸随指定字段的值的变化而变化</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SimpleRenderer.html">SimpleRenderer</a><span style="display: none;"><p>统一专题图渲染样式，支持的图层如下：<br/>
[几何图形图层]{@link GraphicsLayer}、[IGS要素图层]{@link IGSFeatureLayer}、
[geojson图层]{@link GeoJSONLayer}、[OGC-WFS图层]{@link WFSLayer}</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SizeStop.html">SizeStop</a><span style="display: none;"><p>size视觉变量</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SizeVariable.html">SizeVariable</a><span style="display: none;"><p>size视觉变量</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="UniqueValueInfo.html">UniqueValueInfo</a><span style="display: none;"><p>三维专题图-单值信息</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="UniqueValueRenderer.html">UniqueValueRenderer</a><span style="display: none;"><p>单值专题图渲染样式，支持的图层如下：<br/>
[IGS地图图片图层]{@link IGSMapImageLayer}、[几何图形图层]{@link GraphicsLayer}、[IGS要素图层]{@link IGSFeatureLayer}、
[geojson图层]{@link GeoJSONLayer}、[OGC-WFS图层]{@link WFSLayer}</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="VisualVariable.html">VisualVariable</a><span style="display: none;"><p>视觉变量基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Zondy.ThemeLayer.GraphThemeLayer.html">GraphThemeLayer</a><span style="display: none;"><p>统计专题图通过为每个要素绘制统计图表来反映其对应的专题值的大小。它可同时表示多个字段属性信息，在区域本身与各区域之间形成横向和纵向的对比。<br>统计专题图多用于具有相关数量特征的地图上，比如表示不同地区多年的粮食产量、GDP、人口等，不同时段客运量、地铁流量等。目前提供的统计图类型有：柱状图（Bar），折线图（Line），饼图（Pie），三维柱状图（Bar3D），点状图（Point），环状图（Ring）。</p></span></li></ul><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">视图模块</div><ul class="mapgis-sidebar-menus"><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="BaseView.html">BaseView</a><span style="display: none;"><p>视图类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="MapView.html">MapView</a><span style="display: none;"><p>二维场景视图(leaflet引擎)，对地图引擎进行管理，如果要对地图图层进行管理请参考[Map]{@link Map}，<br/>
参考示例：
<a href='#MapView'>[初始化二维场景视图]</a>
<br>[ES5引入方式]：<br/>
Zondy.MapView() <br/>
[ES6引入方式]：<br/>
import { MapView } from '@mapgis/webclient-leaflet-plugin' <br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="VideoMapView.html">VideoMapView</a><span style="display: none;">undefined</span></li></ul><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">符号模块</div><ul class="mapgis-sidebar-menus"><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Callout3D.html">Callout3D</a><span style="display: none;"><p>三维索引样式基类，当一个符号相对于原始位置有偏移时，该符号能显示其真实位置</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ColorMaterial.html">ColorMaterial</a><span style="display: none;"><p>颜色材质，适用于所有三维符号</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Edges3D.html">Edges3D</a><span style="display: none;"><p>轮廓线样式</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ExtrudeSymbol3DLayer.html">ExtrudeSymbol3DLayer</a><span style="display: none;"><p>三维拉伸区符号图层，用来在三维场景中绘制拉伸的区几何，不支持二维地图视图<br/>
示例如下：<br/>
<a href='#ExtrudeSymbol3DLayer'>[1、创建三维拉伸区符号图层]</a><br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="FillSymbol.html">FillSymbol</a><span style="display: none;"><p>填充符号基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="FillSymbol3DLayer.html">FillSymbol3DLayer</a><span style="display: none;"><p>三维区符号图层，用于在三维场景中绘制平面区对象，不支持二维视图<br/>
示例如下：<br/>
<a href='#FillSymbol3DLayer'>[1、创建三维区符号图层]</a><br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="FillSymbol3DOutline.html">FillSymbol3DOutline</a><span style="display: none;"><p>三维区符号图层的外边线样式</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="IconResource.html">IconResource</a><span style="display: none;"><p>图标资源，如果没有设置href，则使用系统自带的图标</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="IconSymbol3DLayer.html">IconSymbol3DLayer</a><span style="display: none;"><p>三维图标符号图层，用来在三维场景中绘制图标，不支持二维地图视图<br/>
支持使用网络图片资源或者使用系统自带的图标资源<br/>
是一个始终朝向屏幕，并且立起来的图标<br/>
示例如下：<br/>
<a href='#IconSymbol3DLayer-href'>[1、使用网络资源创建一个三维图标图层对象]</a><br/>
<a href='#IconSymbol3DLayer-primitive'>[2、使用系统自带资源创建一个三维图标图层对象]</a><br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="LabelSymbol3D.html">LabelSymbol3D</a><span style="display: none;"><p>三维注记符号，用于在三维场景中渲染线几何要素，不支持在二维视图中使用；<br/>
三维注记符号必须包含如下符号图层中的一个或多个，才能在三维场景中显示要素：<br/>
[三维文字符号图层]{@link TextSymbol3DLayer}<br/>
示例如下：<br/>
<a href='#LabelSymbol3D'>[1、创建一个三维注记符号对象]</a><br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="LineCallout3D.html">LineCallout3D</a><span style="display: none;"><p>注记索引线样式，该线会链接注记和所属要素，当一个符号相对于原始位置有偏移时，该符号能显示其真实位置</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="LineStyleMarker3D.html">LineStyleMarker3D</a><span style="display: none;"><p>设置线的端点的Marker的样式</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="LineStylePattern3D.html">LineStylePattern3D</a><span style="display: none;"><p>三维虚线样式设置</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="LineSymbol.html">LineSymbol</a><span style="display: none;"><p>线符号基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="LineSymbol3D.html">LineSymbol3D</a><span style="display: none;"><p>三维线符号，用于在三维场景中渲染线几何要素，不支持在二维视图中使用；<br/>
三维线符号必须包含如下符号图层中的一个或多个，才能在三维场景中显示要素：<br/>
[三维线符号图层]{@link LineSymbol3DLayer}、[三维管道符号图层]{@link PathSymbol3DLayer}<br/>
示例如下：<br/>
<a href='#LineSymbol3D'>[1、创建线三维符号]</a><br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="LineSymbol3DLayer.html">LineSymbol3DLayer</a><span style="display: none;"><p>三维线符号图层，用来在三维场景中绘制二维线，不支持二维地图视图<br/>
示例如下：<br/>
<a href='#LineSymbol3DLayer'>[1、创建三维线符号图层]</a><br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="LineSymbolMarker.html">LineSymbolMarker</a><span style="display: none;"><p>标记符号</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="MapGISTextSymbol.html">MapGISTextSymbol</a><span style="display: none;"><p>文本符号，支持点几何对象，参考示例：<a href='#new-MapGISTextSymbol'>[创建文本样式]</a>
<br><br>[ES5引入方式]：<br/>
Zondy.Symbol.MapGISTextSymbol() <br/>
[ES6引入方式]：<br/>
import { MapGISTextSymbol } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="MarkerSymbol.html">MarkerSymbol</a><span style="display: none;"><p>Marker符号基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="ObjectSymbol3DLayer.html">ObjectSymbol3DLayer</a><span style="display: none;"><p>三维体对象符号图层，使用三维体符号来绘制一个点几何要素<br/>
通过设置resource的primitive属性来设置符号形状，支持如下形状：<br/>
sphere、cylinder、cube、cone、inverted-cone、diamond、tetrahedron<br/>
也可通过设置resource中的href属性，来加载gltf数据<br/>
同时通过设置material属性来设置符号的外观<br/>
示例如下：<br/>
<a href='#ObjectSymbol3DLayer-href'>[1、使用网络资源创建一个三维体对象符号图层对象]</a><br/>
<a href='#ObjectSymbol3DLayer-primitive'>[2、使用系统自带资源创建一个三维体对象符号图层对象]</a><br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="PathSymbol3DLayer.html">PathSymbol3DLayer</a><span style="display: none;"><p>三维管道符号图层，定义如何在三维场景视图中绘制一个管道线<br/>
示例如下：<br/>
<a href='#PathSymbol3DLayer'>[1、创建三维管道符号图层]</a><br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="PictureFillSymbol.html">PictureFillSymbol</a><span style="display: none;"><p>图片填充符号</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="PictureMarkerSymbol.html">PictureMarkerSymbol</a><span style="display: none;"><p>图片Marker符号，支持点几何对象，参考示例：<a href='#new-PictureMarkerSymbol'>[图片Marker样式]</a>
<br><br>[ES5引入方式]：<br/>
Zondy.Symbol.PictureMarkerSymbol() <br/>
[ES6引入方式]：<br/>
import { PictureMarkerSymbol } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="PointSymbol3D.html">PointSymbol3D</a><span style="display: none;"><p>三维点符号，在三维场景中渲染点几何要素，不支持二维视图；<br/>
三维点符号必须包含如下符号图层中的一个或多个，才能在三维场景中显示要素：<br/>
[三维图标符号图层]{@link IconSymbol3DLayer}、[三维对象符号图层]{@link ObjectSymbol3DLayer}、[三维文字符号图层]{@link TextSymbol3DLayer}<br/>
示例如下：<br/>
<a href='#PointSymbol3D'>[1、创建一个三维点符号对象]</a><br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="PointSymbol3DOutline.html">PointSymbol3DOutline</a><span style="display: none;"><p>三维点符号图层的外边线样式</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="PolygonSymbol3D.html">PolygonSymbol3D</a><span style="display: none;"><p>三维体符号，用于在三维场景视图中渲染几何要素，不支持二维视图<br/>
三维体符号必须包含如下符号图层中的一个或多个，才能在三维场景中显示要素：<br/>
[三维区符号图层]{@link FillSymbol3DLayer}、[三维拉伸区符号图层]{@link ExtrudeSymbol3DLayer}、[三维线符号图层]{@link LineSymbol3DLayer}、[三维图标符号图层]{@link IconSymbol3DLayer}、[三维体对象符号图层]{@link ObjectSymbol3DLayer}、[三维注记符号图层]{@link TextSymbol3DLayer}<br/>
示例如下：<br/>
<a href='#PolygonSymbol3D'>[1、创建一个三维体符号对象]</a><br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SimpleFillSymbol.html">SimpleFillSymbol</a><span style="display: none;"><p>简单填充符号，参考示例：<a href='#new-SimpleFillSymbol'>[填充符号样式]</a>
<br><br>[ES5引入方式]：<br/>
Zondy.Symbol.SimpleFillSymbol() <br/>
[ES6引入方式]：<br/>
import { SimpleFillSymbol } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SimpleLineSymbol.html">SimpleLineSymbol</a><span style="display: none;"><p>简单线符号，支持线几何对象，参考示例：<a href='#new-SimpleLineSymbol'>[线符号样式]</a>
<br><br>[ES5引入方式]：<br/>
Zondy.Symbol.SimpleLineSymbol() <br/>
[ES6引入方式]：<br/>
import { SimpleLineSymbol } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SimpleMarkerSymbol.html">SimpleMarkerSymbol</a><span style="display: none;"><p>简单Marker符号，支持点几何对象，参考示例：<a href='#new-SimpleMarkerSymbol'>[简单Marker样式]</a>
<br><br>[ES5引入方式]：<br/>
Zondy.Symbol.SimpleMarkerSymbol() <br/>
[ES6引入方式]：<br/>
import { SimpleMarkerSymbol } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="StylePattern3D.html">StylePattern3D</a><span style="display: none;"><p>三维区间隔填充样式设置</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Symbol.html">Symbol</a><span style="display: none;"><p>符号基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Symbol3DLayer.html">Symbol3DLayer</a><span style="display: none;"><p>三维符号图层基类，用来定义在三维中展示的点、线、区几何以及gltf的样式<br/>
所有的三维符号都有一个symbolLayers属性，是一个Symbol3DLayer的集合对象，所有的符号必须至少拥有一个或多个三维符号图层，才能进行正常显示<br/>
现有如下类型的三维符号图层：<br/>
IconSymbol3DLayer、ObjectSymbol3DLayer、LineSymbol3DLayer、PathSymbol3DLayer、FillSymbol3DLayer、WaterSymbol3DLayer、ExtrudeSymbol3DLayer、TextSymbol3DLayer<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Symbol3DVerticalOffset.html">Symbol3DVerticalOffset</a><span style="display: none;"><p>符号垂直偏移量，将一个符号在竖直世界轴的方向上进行平移</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="TextHalo.html">TextHalo</a><span style="display: none;"><p>文字光晕样式</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="TextSymbol.html">TextSymbol</a><span style="display: none;"><p>文本符号，支持点几何对象，参考示例：<a href='#new-TextSymbol'>[创建文本样式]</a>
<br><br>[ES5引入方式]：<br/>
Zondy.Symbol.TextSymbol() <br/>
[ES6引入方式]：<br/>
import { TextSymbol } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="TextSymbol3DLayer.html">TextSymbol3DLayer</a><span style="display: none;"><p>三维注记符号图层，定义如何在三维场景中显示文字，不支持二维视图<br/>
示例如下：<br/>
<a href='#TextSymbol3DLayer'>[1、创建一个三维注记符号图层对象]</a><br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="WaterSymbol3DLayer.html">WaterSymbol3DLayer</a><span style="display: none;"><p>水面符号图层，定义如何在三维场景中沟构造水面几何，不支持二维视图</p></span></li></ul><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">几何模块</div><ul class="mapgis-sidebar-menus"><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Circle.html">Circle</a><span style="display: none;"><p>几何圆，参考示例：<a href='#Circle'>[几何圆对象]</a>
<br><br>[ES5引入方式]：<br/>
Zondy.Geometry.Circle() <br/>
[ES6引入方式]：<br/>
import { Circle } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Extent.html">Extent</a><span style="display: none;"><p>几何范围对象，即左下角和右上角组成的矩形范围几何对象，参考示例：<a href='#Extent'>[几何范围对象]</a>
<br><br>[ES5引入方式]：<br/>
Zondy.Geometry.Extent() <br/>
[ES6引入方式]：<br/>
import { Extent } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Geometry.html">Geometry</a><span style="display: none;"><p>几何图形对象基类
<br><br>[ES5引入方式]：<br/>
Zondy.Geometry.Geometry() <br/>
[ES6引入方式]：<br/>
import { Geometry } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="GeometryEngine.html">GeometryEngine</a><span style="display: none;"><p>几何分析工具</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="LineString.html">LineString</a><span style="display: none;"><p>线几何对象
<br><br>[ES5引入方式]：<br/>
Zondy.Geometry.LineString() <br/>
[ES6引入方式]：<br/>
import { LineString } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="MultiLineString.html">MultiLineString</a><span style="display: none;"><p>多线段几何
<br><br>[ES5引入方式]：<br/>
Zondy.Geometry.MultiLineString() <br/>
[ES6引入方式]：<br/>
import { MultiLineString } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="MultiPoint.html">MultiPoint</a><span style="display: none;"><p>多点几何对象
<br><br>[ES5引入方式]：<br/>
Zondy.Geometry.MultiPoint() <br/>
[ES6引入方式]：<br/>
import { MultiPoint } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="MultiPolygon.html">MultiPolygon</a><span style="display: none;"><p>多区几何
<br><br>[ES5引入方式]：<br/>
Zondy.Geometry.MultiPolygon() <br/>
[ES6引入方式]：<br/>
import { MultiPolygon } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Point.html">Point</a><span style="display: none;"><p>点几何对象
<br><br>[ES5引入方式]：<br/>
Zondy.Geometry.Point() <br/>
[ES6引入方式]：<br/>
import { Point } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Polygon.html">Polygon</a><span style="display: none;"><p>区几何，由多个环(ring)构成的几何对象，仅支持带洞区和非带洞区，不支持带岛区，即三个圈重叠<br/>
多边形的第一个环(ring)即外圈，从第二个环开始为内圈，内圈可以重合、相交、自相交，但是不能超过外圈
<br><br>[ES5引入方式]：<br/>
Zondy.Geometry.Polygon() <br/>
[ES6引入方式]：<br/>
import { Polygon } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Projection.html">Projection</a><span style="display: none;"><p>投影转换工具</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SpatialReference.html">SpatialReference</a><span style="display: none;"><p>空间参考系
<br><br>[ES5引入方式]：<br/>
Zondy.SpatialReference() <br/>
[ES6引入方式]：<br/>
import { SpatialReference } from "@mapgis/webclient-common" <br/>
<br/></p></span></li></ul><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">undefined</div><ul class="mapgis-sidebar-menus"><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="DrawControl.html">DrawControl</a><span style="display: none;"><p>绘制工具</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Screenshot.html">Screenshot</a><span style="display: none;"><p>打印工具</p></span></li></ul><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">基础对象模块</div><ul class="mapgis-sidebar-menus"><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Evented.html">Evented</a><span style="display: none;"><p>事件基类,所有可接收或者发送的对象继承于此</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="UpdateContent.html">UpdateContent</a><span style="display: none;"><p>更新内容对象</p></span></li></ul><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">要素模块</div><ul class="mapgis-sidebar-menus"><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Feature.html">Feature</a><span style="display: none;"><p>要素对象，示例如下：<a id='add-Feature'>[初始化要素对象]</a>
<br><br>[ES5引入方式]：<br/>
Zondy.Feature() <br/>
[ES6引入方式]：<br/>
import { Feature } from "@mapgis/webclient-common" <br/>
<br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="FeatureSet.html">FeatureSet</a><span style="display: none;"><p>要素集合类，示例如下：<a id='add-FeatureSet'>[初始化要素集合对象]</a>
<br><br>[ES5引入方式]：<br/>
Zondy.FeatureSet() <br/>
[ES6引入方式]：<br/>
import { FeatureSet } from "@mapgis/webclient-common" <br/>
<br/></p></span></li></ul><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">undefined</div><ul class="mapgis-sidebar-menus"><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="Popup.html">Popup</a><span style="display: none;"><p>二维场景信息弹窗(leaflet引擎)
参考示例：
<a href='#MapView'>[初始化二维场景视图]</a>
[ES6引入方式]：<br/>
import { Popup } from '@mapgis/webclient-leaflet-plugin' <br/>
自定义样式说明：<br/>
zondy-popup__content 弹窗容器样式<br/>
zondy-popup__tip 弹窗对话框箭头样式<br/>
zondy-popup__header 弹窗头部样式<br/>
zondy-popup__content 弹窗主体样式<br/>
zondy-popup__footer 弹窗底部样式<br/></p></span></li></ul><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">草图编辑模块</div><ul class="mapgis-sidebar-menus"><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SketchBaseDrawTool.html">SketchBaseDrawTool</a><span style="display: none;"><p>草图基础绘图工具类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SketchCircleDrawTool.html">SketchCircleDrawTool</a><span style="display: none;"><p>面绘图工具类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SketchEditor.html">SketchEditor</a><span style="display: none;"><p>草图编辑基类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SketchEditorLeaflet.html">SketchEditorLeaflet</a><span style="display: none;"><p>二维场景草图编辑类<br/>
<br>[ES5引入方式]：<br/>
const { SketchEditorLeaflet } = Zondy <br/>
[ES6引入方式]：<br/>
import { SketchEditorLeaflet } from "@mapgis/webclient-leaflet-plugin" <br/></p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SketchEditorVideo.html">SketchEditorVideo</a><span style="display: none;">undefined</span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SketchEditorVideoBase.html">SketchEditorVideoBase</a><span style="display: none;">undefined</span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SketchExtentDrawTool.html">SketchExtentDrawTool</a><span style="display: none;"><p>面绘图工具类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SketchPointDrawTool.html">SketchPointDrawTool</a><span style="display: none;"><p>点绘图工具类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SketchPolygonDrawTool.html">SketchPolygonDrawTool</a><span style="display: none;"><p>面绘图工具类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SketchPolylineDrawTool.html">SketchPolylineDrawTool</a><span style="display: none;"><p>面绘图工具类</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SketchStage.html">SketchStage</a><span style="display: none;"><p>草图图形集合</p></span></li><li><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SketchStyle.html">SketchStyle</a><span style="display: none;"><p>草图样式管理类</p></span></li></ul></div>
</nav>
</div>
<div class="core" id="main-content-wrapper">
<div class="content">
<header id="page-title" class="page-title">
<span class="page-title-main">类名</span>
<span class="page-title-sub">common/base/Collection.js</span>
</header>
<section>
<article>
<pre class="prettyprint source linenums"><code>import Evented from './Evented'
import Zondy from './Zondy'
import { CollectionChangeEvent } from './event'
// copy from https://github.com/ecrmnn/collect.js/tree/master
// MIT License
function nestedValue(mainObject, key) {
try {
return key.split('.').reduce((obj, property) => obj[property], mainObject)
} catch (err) {
// If we end up here, we're not working with an object, and @var mainObject is the value itself
return mainObject
}
}
function clone(items) {
let cloned
if (Array.isArray(items)) {
cloned = []
cloned.push(...items)
} else {
cloned = {}
Object.keys(items).forEach((prop) => {
cloned[prop] = items[prop]
})
}
return cloned
}
function values(items) {
const valuesArray = []
if (Array.isArray(items)) {
valuesArray.push(...items)
} else if (items.constructor.name === 'Collection') {
valuesArray.push(...items.all())
} else {
Object.keys(items).forEach((prop) => valuesArray.push(items[prop]))
}
return valuesArray
}
/**
* @returns {boolean}
*/
function isArray(item) {
return Array.isArray(item)
}
/**
* @returns {boolean}
*/
function isObject(item) {
return (
typeof item === 'object' && Array.isArray(item) === false && item !== null
)
}
/**
* @returns {boolean}
*/
function isFunction(item) {
return typeof item === 'function'
}
function falsyValue(item) {
if (Array.isArray(item)) {
if (item.length) {
return false
}
} else if (item !== undefined && item !== null && typeof item === 'object') {
if (Object.keys(item).length) {
return false
}
} else if (item) {
return false
}
return true
}
function filterObject(func, items) {
const result = {}
Object.keys(items).forEach((key) => {
if (func) {
if (func(items[key], key)) {
result[key] = items[key]
}
} else if (!falsyValue(items[key])) {
result[key] = items[key]
}
})
return result
}
function filterArray(func, items) {
if (func) {
return items.filter(func)
}
const result = []
for (let i = 0; i < items.length; i += 1) {
const item = items[i]
if (!falsyValue(item)) {
result.push(item)
}
}
return result
}
function variadic(args) {
if (Array.isArray(args[0])) {
return args[0]
}
return args
}
/**
* The Collection object.
* @private
* @example
* let collection = new Collection([1, 2, 3]);
*/
class Collection extends Evented {
/**
* The collection constructor.
*
* @param {Array} [collection=[]] the array to collect.
* @return {Collection} A Collection object.
*/
constructor(collection = []) {
super()
this.type = 'collection'
if (collection instanceof Collection) {
this.items = collection.all()
} else if (Array.isArray(collection)) {
this.items = collection
} else {
this.items = []
}
this.items = this.items.map((v) => this.createInstance(v))
}
/**
* Gets the collected elements in an array.
* @private
* @return {Array} the internal array.
* @example
* const collection = new Collection([1, 2, 3]);
* console.log(collection.all()); // [1, 2, 3]
*/
all() {
return this.items
}
/**
* Chunks the collection into a new collection with equal length arrays as its items.
* @private
* @param {number} size the size of each chunk.
* @return {Collection} the new collection.
* @example
* const collection = new Collection([1, 2, 3, 4, 5]).chunk(2);
* console.log(collection.all()); // [[1, 2], [3, 4], [5]]
*/
chunk(size) {
const chunks = []
let index = 0
if (Array.isArray(this.items)) {
do {
const items = this.items.slice(index, index + size)
const collection = new this.constructor(items)
chunks.push(collection)
index += size
} while (index < this.items.length)
} else if (typeof this.items === 'object') {
const keys = Object.keys(this.items)
do {
const keysOfChunk = keys.slice(index, index + size)
const collection = new this.constructor({})
keysOfChunk.forEach((key) => collection.put(key, this.items[key]))
chunks.push(collection)
index += size
} while (index < keys.length)
} else {
chunks.push(new this.constructor([this.items]))
}
return new this.constructor(chunks)
}
/**
* Concatnates the collection with an array or another collection.
* @private
* @param {Array|Collection} collection the array or the collection to be concatenated with.
* @return {Collection} concatenated collection.
* @example
* const collection = new Collection([1, 2, 3]);
* const array = [4, 5, 6]; // or another collection.
* const newCollection = collection.concat(array);
* console.log(newCollection.all()); // [1, 2, 3, 4, 5, 6]
*/
concat(collectionOrArrayOrObject) {
let list = collectionOrArrayOrObject
if (collectionOrArrayOrObject instanceof this.constructor) {
list = collectionOrArrayOrObject.all()
} else if (typeof collectionOrArrayOrObject === 'object') {
list = []
Object.keys(collectionOrArrayOrObject).forEach((property) => {
list.push(collectionOrArrayOrObject[property])
})
}
const collection = clone(this.items)
list.forEach((item) => {
if (typeof item === 'object') {
Object.keys(item).forEach((key) => collection.push(item[key]))
} else {
collection.push(item)
}
})
return new this.constructor(collection)
}
contains(key, value) {
if (value !== undefined) {
if (Array.isArray(this.items)) {
return (
this.items.filter(
(items) => items[key] !== undefined && items[key] === value
).length > 0
)
}
return this.items[key] !== undefined && this.items[key] === value
}
if (isFunction(key)) {
return this.items.filter((item, index) => key(item, index)).length > 0
}
if (Array.isArray(this.items)) {
return this.items.indexOf(key) !== -1
}
const keysAndValues = values(this.items)
keysAndValues.push(...Object.keys(this.items))
return keysAndValues.indexOf(key) !== -1
}
/**
* Gets the number of items in the collection.
* @private
* @return {number} Number of items in the collection.
* @example
* const collection = new Collection([1, 2, 3]);
* console.log(collection.count()); // 3
*/
count() {
let arrayLength = 0
if (Array.isArray(this.items)) {
arrayLength = this.items.length
}
return Math.max(Object.keys(this.items).length, arrayLength)
}
/**
* Executes a callback for each element in the collection.
* @private
* @param {function} callback the callback to be excuted for each item.
* @return {Collection} The collection object.
* @example
* const collection = new Collection(['this', 'is', 'collectionjs']);
* collection.each(t => console.log(t)); // this is collectionjs
*/
each(fn) {
let stop = false
if (Array.isArray(this.items)) {
const { length } = this.items
for (let index = 0; index < length && !stop; index += 1) {
stop = fn(this.items[index], index, this.items) === false
}
} else {
const keys = Object.keys(this.items)
const { length } = keys
for (let index = 0; index < length && !stop; index += 1) {
const key = keys[index]
stop = fn(this.items[key], key, this.items) === false
}
}
return this
}
/**
* Filters the collection using a predicate (callback that returns a boolean).
* @private
* @param {function} callback A function that returns a boolean expression.
* @return {Collection} Filtered collection.
* @example
* const collection = new Collection([
* { name: 'Arya Stark', age: 9 },
* { name: 'Bran Stark', age: 7 },
* { name: 'Jon Snow', age: 14 }
* ]).filter(stark => stark.age === 14);
* console.log(collection.all()); // [{ name: 'Jon Snow', age: 14 }]
*/
filter(fn) {
const func = fn || false
let filteredItems = null
if (Array.isArray(this.items)) {
filteredItems = filterArray(func, this.items)
} else {
filteredItems = filterObject(func, this.items)
}
return new this.constructor(filteredItems)
}
first(fn, defaultValue) {
if (isFunction(fn)) {
const keys = Object.keys(this.items)
for (let i = 0; i < keys.length; i += 1) {
const key = keys[i]
const item = this.items[key]
if (fn(item, key)) {
return item
}
}
if (isFunction(defaultValue)) {
return defaultValue()
}
return defaultValue
}
if (
(Array.isArray(this.items) && this.items.length) ||
Object.keys(this.items).length
) {
if (Array.isArray(this.items)) {
return this.items[0]
}
const firstKey = Object.keys(this.items)[0]
return this.items[firstKey]
}
if (isFunction(defaultValue)) {
return defaultValue()
}
return defaultValue
}
flatten(depth) {
let flattenDepth = depth || Infinity
let fullyFlattened = false
let collection = []
const flat = function flat(items) {
collection = []
if (isArray(items)) {
items.forEach((item) => {
if (isArray(item)) {
collection = collection.concat(item)
} else if (isObject(item)) {
Object.keys(item).forEach((property) => {
collection = collection.concat(item[property])
})
} else {
collection.push(item)
}
})
} else {
Object.keys(items).forEach((property) => {
if (isArray(items[property])) {
collection = collection.concat(items[property])
} else if (isObject(items[property])) {
Object.keys(items[property]).forEach((prop) => {
collection = collection.concat(items[property][prop])
})
} else {
collection.push(items[property])
}
})
}
fullyFlattened = collection.filter((item) => isObject(item))
fullyFlattened = fullyFlattened.length === 0
flattenDepth -= 1
}
flat(this.items)
// eslint-disable-next-line no-unmodified-loop-condition
while (!fullyFlattened && flattenDepth > 0) {
flat(collection)
}
return new this.constructor(collection)
}
/**
* Gets an element at a specified index.
* @private
* @param {number} index the index of the item.
* @return {*} the item at that index.
* @example
* const collection = new Collection([1, 2, 3]);
* console.log(collection.get(2)); // 3
*/
get(key, defaultValue = null) {
if (this.items[key] !== undefined) {
return this.items[key]
}
if (isFunction(defaultValue)) {
return defaultValue()
}
if (defaultValue !== null) {
return defaultValue
}
return null
}
has(...args) {
const properties = variadic(args)
return (
properties.filter((key) => Object.hasOwnProperty.call(this.items, key))
.length === properties.length
)
}
/**
* Joins the collection elements into a string.
* @private
* @param {string} [seperator=','] The seperator between each element and the next.
* @return {string} The joined string.
*
* @example
* const collection = new Collection(['Wind', 'Rain', 'Fire']);
* console.log(collection.join()); // 'Wind,Rain,Fire'
* console.log(collection.join(', ')); 'Wind, Rain, Fire'
*/
join(glue, finalGlue) {
const collection = this.values()
if (finalGlue === undefined) {
return collection.implode(glue)
}
const count = collection.count()
if (count === 0) {
return ''
}
if (count === 1) {
return collection.last()
}
const finalItem = collection.pop()
return collection.implode(glue) + finalGlue + finalItem
}
/**
* Gets the collection elements keys in a new collection.
* @private
* @return {Collection} The keys collection.
* @example <caption>Objects</caption>
* const keys = new Collection({
* arya: 10,
* john: 20,
* potato: 30
* }).keys();
* console.log(keys); // ['arya', 'john', 'potato']
*
* @example <caption>Regular Array</caption>
* const keys = new Collection(['arya', 'john', 'potato']).keys();
* console.log(keys); // ['0', '1', '2']
*/
keys() {
let collection = Object.keys(this.items)
if (Array.isArray(this.items)) {
collection = collection.map(Number)
}
return new this.constructor(collection)
}
/**
* Gets the last element to satisfy a callback.
* @private
* @param {function} [callback=null] the predicate to be checked on all elements.
* @return {*} The last element in the collection that satisfies the predicate.
* @example <caption>Using a callback</caption>
* const last = new Collection([
* { name: 'Bran Stark', age: 7 },
* { name: 'Arya Stark', age: 9 },
* { name: 'Jon Snow', age: 14 }
* ]).last(item => item.age > 7);
*
* console.log(last); // { name: 'Jon Snow', age: 14 }
* @example <caption>No Arguments</caption>
* const last = new Collection([
* { name: 'Bran Stark', age: 7 },
* { name: 'Arya Stark', age: 9 },
* { name: 'Jon Snow', age: 14 }
* ]).last();
*
* console.log(last); // { name: 'Jon Snow', age: 14 }
*/
last(fn, defaultValue) {
let { items } = this
if (isFunction(fn)) {
items = this.filter(fn).all()
}
if ((Array.isArray(items) && !items.length) || !Object.keys(items).length) {
if (isFunction(defaultValue)) {
return defaultValue()
}
return defaultValue
}
if (Array.isArray(items)) {
return items[items.length - 1]
}
const keys = Object.keys(items)
return items[keys[keys.length - 1]]
}
/**
* Maps each element using a mapping function and collects the mapped items.
* @private
* @param {function} callback the mapping function.
* @return {Collection} collection containing the mapped items.
* @example
* const collection = new Collection([
* { name: 'Bran Stark', age: 7 },
* { name: 'Arya Stark', age: 9 },
* { name: 'Jon Snow', age: 14 }
* ]).map(stark => stark.name);
* console.log(collection.all()); ['Bran Stark', 'Arya Stark', 'Jon Snow']
*/
map(fn) {
if (Array.isArray(this.items)) {
return new this.constructor(this.items.map(fn))
}
const collection = {}
Object.keys(this.items).forEach((key) => {
collection[key] = fn(this.items[key], key)
})
return new this.constructor(collection)
}
/**
* Adds an element to the collection.
* @private
* @param {*} item the item to be added.
* @return {Collection} The collection object.
* @example
* const collection = new Collection().push('First');
* console.log(collection.first()); // "First"
*/
push(...items) {
this.items.push(...items)
return this
}
/**
* Reduces the collection to a single value using a reducing function.
* @private
* @param {function} callback the reducing function.
* @param {*} initial initial value.
* @return {*} The reduced results.
* @example
* const value = new Collection([1, 2, 3]).reduce(
* (previous, current) => previous + current,
* 0
* );
* console.log(value); // 6
*/
reduce(fn, carry) {
let reduceCarry = null
if (carry !== undefined) {
reduceCarry = carry
}
if (Array.isArray(this.items)) {
this.items.forEach((item) => {
reduceCarry = fn(reduceCarry, item)
})
} else {
Object.keys(this.items).forEach((key) => {
reduceCarry = fn(reduceCarry, this.items[key], key)
})
}
return reduceCarry
}
/**
* Removes the elements that do not satisfy the predicate.
* @private
* @param {function} callback the predicate used on each item.
* @return {Collection} A collection without the rejected elements.
* @example
* const collection = new Collection([
* { name: 'Arya Stark', age: 9 },
* { name: 'Bran Stark', age: 7 },
* { name: 'Jon Snow', age: 14 }
* ]).reject(stark => stark.age < 14);
* console.log(collection.all()); // [{ name: 'Jon Snow', age: 14 }]
*/
reject(fn) {
return new this.constructor(this.items).filter((item) => !fn(item))
}
/**
* Reverses the collection order.
* @private
* @return {Collection} A new collection with the reversed order.
* @example
* const collection = new Collection(['one', 'two', 'three']).reverse();
* console.log(collection.all()); // ['three', 'two', 'one']
*/
reverse() {
const collection = [].concat(this.items).reverse()
return new this.constructor(collection)
}
/**
* Skips a specified number of elements.
* @private
* @param {number} count the number of items to be skipped.
* @return {Collection} A collection without the skipped items.
* @example
* const collection = new Collection(['John', 'Arya', 'Bran', 'Sansa']).skip(2);
* console.log(collection.all()); // ['Bran', 'Sansa']
*/
skip(number) {
if (isObject(this.items)) {
return new this.constructor(
Object.keys(this.items).reduce((accumulator, key, index) => {
if (index + 1 > number) {
accumulator[key] = this.items[key]
}
return accumulator
}, {})
)
}
return new this.constructor(this.items.slice(number))
}
/**
* Slices the collection starting from a specific index and ending at a specified index.
* @private
* @param {number} start The zero-based starting index.
* @param {number} [end=length] The zero-based ending index.
* @return {Collection} A collection with the sliced items.
* @example <caption>start and end are specified</caption>
* const collection = new Collection([0, 1, 2, 3, 4, 5, 6]).slice(2, 4);
* console.log(collection.all()); // [2, 3]
*
* @example <caption>only start is specified</caption>
* const collection = new Collection([0, 1, 2, 3, 4, 5, 6]).slice(2);
* console.log(collection.all()); // [2, 3, 4, 5, 6]
*/
slice(remove, limit) {
let collection = this.items.slice(remove)
if (limit !== undefined) {
collection = collection.slice(0, limit)
}
return new this.constructor(collection)
}
/**
* Sorts the elements of a collection and returns a new sorted collection.
* note that it doesn't change the orignal collection and it creates a
* shallow copy.
* @private
* @param {function} [compare=undefined] the compare function.
* @return {Collection} A new collection with the sorted items.
*
* @example
* const collection = new Collection([5, 3, 4, 1, 2]);
* const sorted = collection.sort();
* // original collection is intact.
* console.log(collection.all()); // [5, 3, 4, 1, 2]
* console.log(sorted.all()); // [1, 2, 3, 4, 5]
*/
sort(fn) {
const collection = [].concat(this.items)
if (fn === undefined) {
if (this.every((item) => typeof item === 'number')) {
collection.sort((a, b) => a - b)
} else {
collection.sort()
}
} else {
collection.sort(fn)
}
return new this.constructor(collection)
}
/**
* Sorts the collection by key value comaprison, given that the items are objects.
* It creates a shallow copy and retains the order of the orignal collection.
* @private
* @param {string} property the key or the property to be compared.
* @param {string} [order='asc'] The sorting order.
* use 'asc' for ascending or 'desc' for descending, case insensitive.
* @return {Collection} A new Collection with the sorted items.
*
* @example
* const collection = new Collection([
* { name: 'Jon Snow', age: 14 },
* { name: 'Arya Stark', age: 9 },
* { name: 'Bran Stark', age: 7 },
* ]).sortBy('age');
*
* console.log(collection.pluck('name').all()); // ['Brand Stark', 'Arya Stark', 'Jon Snow']
*/
sortBy(valueOrFunction) {
const collection = [].concat(this.items)
const getValue = (item) => {
if (isFunction(valueOrFunction)) {
return valueOrFunction(item)
}
return nestedValue(item, valueOrFunction)
}
collection.sort((a, b) => {
const valueA = getValue(a)
const valueB = getValue(b)
if (valueA === null || valueA === undefined) {
return 1
}
if (valueB === null || valueB === undefined) {
return -1
}
if (valueA < valueB) {
return -1
}
if (valueA > valueB) {
return 1
}
return 0
})
return new this.constructor(collection)
}
sortByDesc(valueOrFunction) {
return this.sortBy(valueOrFunction).reverse()
}
sortDesc() {
return this.sort().reverse()
}
sortKeys() {
const ordered = {}
Object.keys(this.items)
.sort()
.forEach((key) => {
ordered[key] = this.items[key]
})
return new this.constructor(ordered)
}
sortKeysDesc() {
const ordered = {}
Object.keys(this.items)
.sort()
.reverse()
.forEach((key) => {
ordered[key] = this.items[key]
})
return new this.constructor(ordered)
}
/**
* Sums the values of the array, or the properties, or the result of the callback.
* @private
* @param {undefined|string|function} [property=null] the property to be summed.
* @return {*} The sum of values used in the summation.
* @example <caption>Summing elements</caption>
* const collection = new Collection([1, 2, 3]);
* console.log(collection.sum()); // 6
*
* @example <caption>Summing a property</caption>
* const collection = new Collection([
* { name: 'Arya Stark', age: 9 },
* { name: 'Bran Stark', age: 7 },
* { name: 'Jon Snow', age: 14 }
* ]);
* console.log(collection.sum('age')); // 30
*
* @example <caption>Summing using a callback</caption>
* const collection = new Collection([
* { name: 'Arya Stark', age: 9 },
* { name: 'Bran Stark', age: 7 },
* { name: 'Jon Snow', age: 14 }
* ]);
* console.log(collection.sum(i => i.age + 1)); // 33
*/
sum(key) {
const items = values(this.items)
let total = 0
if (key === undefined) {
for (let i = 0, { length } = items; i < length; i += 1) {
total += parseFloat(items[i])
}
} else if (isFunction(key)) {
for (let i = 0, { length } = items; i < length; i += 1) {
total += parseFloat(key(items[i]))
}
} else {
for (let i = 0, { length } = items; i < length; i += 1) {
total += parseFloat(items[i][key])
}
}
return parseFloat(total.toPrecision(12))
}
/**
* Gets a new collection with the number of specified items from the begining or the end.
* @private
* @param {number} count the number of items to take. Takes from end if negative.
* @return {Collection} A collection with the taken items.
* @example <caption>From the beginning</caption>
* const collection = new Collection([1, 2, 3, 4, 5]).take(3);
* console.log(collection.all()); // [1, 2, 3]
*
* @example <caption>From the end</caption>
* const collection = new Collection([1, 2, 3, 4, 5]).take(-3);
* console.log(collection.all()); // [5, 4 ,3]
*/
take(length) {
if (!Array.isArray(this.items) && typeof this.items === 'object') {
const keys = Object.keys(this.items)
let slicedKeys
if (length < 0) {
slicedKeys = keys.slice(length)
} else {
slicedKeys = keys.slice(0, length)
}
const collection = {}
keys.forEach((prop) => {
if (slicedKeys.indexOf(prop) !== -1) {
collection[prop] = this.items[prop]
}
})
return new this.constructor(collection)
}
if (length < 0) {
return new this.constructor(this.items.slice(length))
}
return new this.constructor(this.items.slice(0, length))
}
/**
* Remove duplicate values from the collection.
* @private
* @param {function|string} [callback=null] The predicate that returns a value
* which will be checked for uniqueness, or a string that has the name of the property.
* @return {Collection} A collection containing ue values.
* @example <caption>No Arguments</caption>
* const unique = new Collection([2, 1, 2, 3, 3, 4, 5, 1, 2]).unique();
* console.log(unique); // [2, 1, 3, 4, 5]
* @example <caption>Property Name</caption>
* const students = new Collection([
* { name: 'Rick', grade: 'A'},
* { name: 'Mick', grade: 'B'},
* { name: 'Richard', grade: 'A'},
* ]);
* // Students with unique grades.
* students.unique('grade'); // [{ name: 'Rick', grade: 'A'}, { name: 'Mick', grade: 'B'}]
* @example <caption>With Callback</caption>
* const students = new Collection([
* { name: 'Rick', grade: 'A'},
* { name: 'Mick', grade: 'B'},
* { name: 'Richard', grade: 'A'},
* ]);
* // Students with unique grades.
* students.unique(s => s.grade); // [{ name: 'Rick', grade: 'A'}, { name: 'Mick', grade: 'B'}]
*/
unique(key) {
let collection
if (key === undefined) {
collection = this.items.filter(
(element, index, self) => self.indexOf(element) === index
)
} else {
collection = []
const usedKeys = []
for (
let iterator = 0, { length } = this.items;
iterator < length;
iterator += 1
) {
let uniqueKey
if (isFunction(key)) {
uniqueKey = key(this.items[iterator])
} else {
uniqueKey = this.items[iterator][key]
}
if (usedKeys.indexOf(uniqueKey) === -1) {
collection.push(this.items[iterator])
usedKeys.push(uniqueKey)
}
}
}
return new this.constructor(collection)
}
/**
* Gets the values without preserving the keys.
* @private
* @return {Collection} A Collection containing the values.
* @example
* const collection = new Collection({
* 1: 2,
* 2: 3,
* 4: 5
* }).values();
*
* console.log(collection.all()); / /[2, 3, 5]
*/
values() {
return new this.constructor(values(this.items))
}
/**
* Filters the collection using a callback or equality comparison to a property in each item.
* @private
*/
where(key, operator, value) {
let comparisonOperator = operator
let comparisonValue = value
const items = values(this.items)
if (operator === undefined || operator === true) {
return new this.constructor(
items.filter((item) => nestedValue(item, key))
)
}
if (operator === false) {
return new this.constructor(
items.filter((item) => !nestedValue(item, key))
)
}
if (value === undefined) {
comparisonValue = operator
comparisonOperator = '==='
}
const collection = items.filter((item) => {
switch (comparisonOperator) {
case '==':
return (
nestedValue(item, key) === Number(comparisonValue) ||
nestedValue(item, key) === comparisonValue.toString()
)
default:
case '===':
return nestedValue(item, key) === comparisonValue
case '!=':
case '<>':
return (
nestedValue(item, key) !== Number(comparisonValue) &&
nestedValue(item, key) !== comparisonValue.toString()
)
case '!==':
return nestedValue(item, key) !== comparisonValue
case '<':
return nestedValue(item, key) < comparisonValue
case '<=':
return nestedValue(item, key) <= comparisonValue
case '>':
return nestedValue(item, key) > comparisonValue
case '>=':
return nestedValue(item, key) >= comparisonValue
}
})
return new this.constructor(collection)
}
/**
* Pairs each item in the collection with another array item in the same index.
* @private
* @param {Array|Collection} array the array to be paired with.
* @return {Collection} A collection with the paired items.
* @example
* const array = ['a', 'b', 'c']; // or a collection.
* const collection = new Collection([1, 2, 3]).zip(array);
* console.log(collection.all()); // [[1, 'a'], [2, 'b'], [3, 'c']]
*/
zip(array) {
let values = array
if (values instanceof this.constructor) {
values = values.all()
}
const collection = this.items.map(
(item, index) => new this.constructor([item, values[index]])
)
return new this.constructor(collection)
}
every(fn) {
const items = values(this.items)
return items.every(fn)
}
findIndex(callback) {
return this.items.findIndex(callback)
}
forEach(callback) {
return this.each(callback)
}
/**
* 创建实例
* @private
* @return {any} any object
*/
createInstance(item) {
return item
}
/**
* Adds an item to the collection.
* @private
* @param {*} item the item to be added.
* @return {Collection} the collection object.
* @example
* const collection = new Collection();
* collection.add('Arya');
* console.log(collection.first()); //outputs 'Arya'
*/
add(item) {
const instance = this.createInstance(item)
this.items.push(instance)
this.fire(
'change',
new CollectionChangeEvent({
removed: [],
added: [instance]
})
)
return this
}
/**
* Removes an item from the collection.
* @private
* @param {*} item the item to be searched and removed, first occurance will be removed.
* @return {boolean} True if the element was removed, false otherwise.
* @example
* const collection = new Collection(['john', 'arya', 'bran']);
* collection.remove('john');
* console.log(collection.all()); // ['arya', 'bran']
*/
remove(item) {
const index = this.items.indexOf(item)
if (index > -1) {
this.items.splice(index, 1)
this.fire(
'change',
new CollectionChangeEvent({
removed: [item],
added: []
})
)
return true
}
return false
}
/**
* 创建实例
* @private
* @return {any} any object
*/
addMany(items) {
if (Array.isArray(items)) {
const instances = items.map((v) => this.createInstance(v))
this.items = this.items.concat(instances)
this.fire(
'change',
new CollectionChangeEvent({
removed: [],
added: instances
})
)
}
}
/**
* 删除实例
* @private
* @return {any} any object
*/
removeMany(items) {
if (Array.isArray(items)) {
const removed = []
for (let i = 0; i < items.length; i++) {
const flag = this.remove(items[i])
if (flag) {
removed.push(items[i])
}
}
this.fire(
'change',
new CollectionChangeEvent({
removed,
added: []
})
)
}
}
/**
* 删除实例
* @private
* @return {any} any object
*/
removeAll() {
const removed = this.items.map((v) => v)
this.fire(
'change',
new CollectionChangeEvent({
removed,
added: []
})
)
this.items = []
}
/**
* Static constructor.
* cool if you don't like using the 'new' keyword.
* @private
* @param {Array} collectable the array or the string to wrapped in a collection.
* @return {Collection} A collection that wraps the collectable items.
* @example
* const collection = Collection.collect([1, 2, 3]);
* console.log(collection.all()); // [1, 2, 3]
*/
static collect(collectable) {
return new Collection(collectable)
}
}
Zondy.Collection = Collection
export default Collection
</code></pre>
</article>
</section>
</div>
<footer class="footer">
<div class="content has-text-centered">
<p>文档生成<a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a></p>
<p class="sidebar-created-by">
<a href="http://www.smaryun.com" target="_blank">司马云</a> <span>© 2023 云生态圈</span>
<a href="http://192.168.82.89:8086/#/index" target="_blank">MapGIS Client for JavaScript</a>
</p>
</div>
</footer>
</div>
<div id="side-nav" class="side-nav">
<div style="margin-bottom: 10px;">
<img style="vertical-align: middle;margin-right: 10px;width: 30px;" src="./styles/anchor.png"/><a href="#page-title">构造函数</a>
</div>
<div style="margin-bottom: 10px;">
<img style="vertical-align: middle;margin-right: 10px;width: 30px;" src="./styles/anchor.png"/><a href="#member">成员变量</a>
</div>
<div style="margin-bottom: 10px;">
<img style="vertical-align: middle;margin-right: 10px;width: 30px;" src="./styles/anchor.png"/><a href="#function">方法</a>
</div>
<div>
<img style="vertical-align: middle;margin-right: 10px;width: 30px;" src="./styles/anchor.png"/><a href="#event">事件</a>
</div>
</div>
</div>
<script src="scripts/linenumber.js"> </script>
<script src="scripts/search.js"> </script>
</body>
</html>