Skip to content

Entity

根据 id 获取一个实体 getEntityById

  • @param
参数名type描述默认值
idString实体 id-
  • @returns
返回值type描述默认值
entityObjObjectentity 对象。-
js
let entity = CM.Entity.getEntityById(id);

根据 id 删除一个实体 removeEntityById

  • @param
参数名type描述默认值
idString实体 id-
js
CM.Entity.removeEntityById(id);

删除所有实体 removeAllEntity

js
CM.Entity.removeAllEntity();

注册 Entity 点击事件监听 onClick

  • @param
参数名type描述默认值
callbackFunction回调函数;返回 entity 实体对象;如果当前点击只有一个实体返回当前实体,如果有多个实体返回所有实体对象数组。-
callback 回调函数返回值
属性名type描述
dataArray当前点击对象组成的数组-
eventObject点击事件的 event 对象-
clickTypeString当前点击的类型Entity-实体对象 ImageryLayerFeatures-图层对象(如 pbf 瓦片等)
js
CM.Entity.onClick((et, event, clickType) => {
  console.log(et, event, clickType);
});

注销点击事件 removeClick

js
CM.Entity.removeClick();

注册 Entity 拖拽事件 entityMove

使用拖拽

要使用拖拽必须在创建 entity 点位的时候设置 myData 的 isMove 属性为 true;

  • @param
参数名type描述默认值
callbackFunction回调函数;返回当前托动 entity 实体对象-
js
let pointEntity = CM.Draw.loadMarker({ lng: "", lat: "", height: 0 }, { isMove: true });
CM.Entity.entityMove((entity) => {});

注销拖拽事件 removeEntityMove

js
CM.Entity.removeEntityMove();

加载聚合图标点 loadClusterMarker

  • @param
参数名type描述默认值
positionObject84 坐标-
myDataObject自定义的数据,在监听点击事件时根据此属性获取-
imgUrlObject图标文件,通过 require 获取-
imgSizeObject图标大小{w:40,h:40}
  • @returns
返回值type描述
clusterMarkerObject返回聚合图标点。
js
let clusterMarker = CM.Entity.loadClusterMarker(position, myData, imgUrl);

加载自定义的聚合图标点 loadCustomClusterMarker

  • @param
参数名type描述默认值
entityObjObject参考 cesium 的 entity 配置-
  • @returns
返回值type描述
clusterMarkerObject返回聚合图标点。
js
let clusterMarker = CM.Entity.loadCustomClusterMarker(entityObj);

将所有普通图标点转换为聚合图标点 pointToClusterMarker

  • @returns
返回值type描述默认值
clusterDataSourceObject自定义的聚合图标 DataSource 对象-
js
let clusterDataSource = CM.Entity.pointToClusterMarker();

获取所有聚合图标自定义的 DataSource 对象 getClusterDataSource

  • @returns
返回值type描述默认值
clusterDataSourceObject自定义的聚合图标 DataSource 对象-
js
let clusterDataSource = CM.Entity.getClusterDataSource();

开启聚合图标显示 openCluster

  • @param
参数名type描述默认值
optionObject参考 cesium 的 EntityCluster 配置-
clusterIconConfigObject聚合图标配置-
  • @returns
返回值type描述
clusterDataSourceObject自定义的聚合图标 DataSource 对象
clusterIconConfig
参数名type描述默认值
maxNumber当聚合数量超过此值执行的配置;值为 0 时为默认配置-
colorString聚合图标颜色-
widthNumber图标宽度-
heightNumber图标高度-
fontColorString聚合图标字体图标-
isImgBoolean是否使用自定义图片代替聚合图标-
imgUrlString自定义图片-
js
// clusterIconConfig默认配置
// let clusterIconConfig = [
//   {
//     max: 20, //当聚合数量超过此值执行的配置;值为0时为默认配置
//     color: "#0000ff", //聚合图标颜色
//     // isImg: true, //是否使用自定义图片代替聚合图标
//     // imgUrl: require('@/assets/logo.png'),
//     width: 72, //图标宽度
//     height: 72, //图标高度
//     fontColor: "#fff", //聚合图标字体图标
//   },
//   {
//     max: 12,
//     color: "#F8C71F",
//     // isImg: true,
//     // imgUrl: require('@/assets/logo.png'),
//     width: 56,
//     height: 56,
//     fontColor: "#fff",
//   },
//   {
//     max: 0,
//     color: "#FF1E1E",
//     // isImg: true,
//     // imgUrl: require('@/assets/logo.png'),
//     width: 56,
//     height: 56,
//     fontColor: "#fff",
//   },
// ];
let clusterDataSource = CM.Entity.openCluster(option, clusterIconConfig);

关闭聚合图标显示 removeCluster

js
CM.Entity.removeCluster();