gdmap-utils 1.2.3 → 1.2.5

package/src/layers/clusterMarkerLayer/MarkerClusterLayer.ts

@@ -1,53 +1,53 @@
-import type {
-  mapIns,
-  MarkerClusterDataOptions,
-  MarkerClusterOptions,
-} from '@/types/index.d';
-
-class MarkerClusterLayer {
-  rawLayer: any; //高德未提供cluster的类型
-
-  map: mapIns;
-
-  constructor(
-    map: mapIns,
-    dataOptions: Array<MarkerClusterDataOptions>,
-    opts: MarkerClusterOptions
-  ) {
-    this.map = map;
-    //@ts-expect-error
-    this.rawLayer = new AMap.MarkerCluster(map, dataOptions, opts);
-  }
-
-  bindEventMarker(clickType: AMap.EventType, callback: () => void) {
-    this.rawLayer.on(clickType, callback);
-  }
-
-  add(dataOption: MarkerClusterDataOptions) {
-    this.rawLayer.addData(dataOption);
-  }
-
-  remove(dataOptions: Array<MarkerClusterDataOptions>) {
-    this.rawLayer.setData(dataOptions);
-  }
-
-  hide() {
-    this.rawLayer.setData([]);
-  }
-
-  show(dataOptions: Array<MarkerClusterDataOptions>) {
-    this.rawLayer.setData(dataOptions);
-  }
-
-  destroy() {
-    this.rawLayer.setData([]);
-    this.rawLayer.setMap(null);
-    this.rawLayer = null;
-  }
-
-  clearAllOvl() {
-    this.rawLayer.setData([]);
-  }
-}
-
-export default MarkerClusterLayer;
+import type {
+  mapIns,
+  MarkerClusterDataOptions,
+  MarkerClusterOptions,
+} from '@/types/index.d';
+
+class MarkerClusterLayer {
+  rawLayer: any; //高德未提供cluster的类型
+
+  map: mapIns;
+
+  constructor(
+    map: mapIns,
+    dataOptions: Array<MarkerClusterDataOptions>,
+    opts: MarkerClusterOptions
+  ) {
+    this.map = map;
+    //@ts-expect-error
+    this.rawLayer = new AMap.MarkerCluster(map, dataOptions, opts);
+  }
+
+  bindEventMarker(clickType: AMap.EventType, callback: () => void) {
+    this.rawLayer.on(clickType, callback);
+  }
+
+  add(dataOption: MarkerClusterDataOptions[]) {
+    this.rawLayer.addData(dataOption);
+  }
+
+  remove(dataOptions: Array<MarkerClusterDataOptions>) {
+    this.rawLayer.setData(dataOptions);
+  }
+
+  hide() {
+    this.rawLayer.setData([]);
+  }
+
+  show(dataOptions: Array<MarkerClusterDataOptions>) {
+    this.rawLayer.setData(dataOptions);
+  }
+
+  destroy() {
+    this.rawLayer.setData([]);
+    this.rawLayer.setMap(null);
+    this.rawLayer = null;
+  }
+
+  clearAllOvl() {
+    this.rawLayer.setData([]);
+  }
+}
+
+export default MarkerClusterLayer;

package/src/layers/clusterMarkerLayer/index.ts

@@ -1,177 +1,204 @@
-import MarkerClusterLayer from './MarkerClusterLayer';
-import type {
-  MarkerClusterLayerType,
-  OverlayData, //OverLayerData图层公共接口
-  MarkerClusterDataOptions,
-  ClusterMarkerLayerInfo,
-  ClusterMarkerLayerOpts,
-} from '@/types';
-import { MapUtils } from '@/MapUtils';
-import type { mapUtilsIns } from '@/MapUtils';
-
-class ClusterMarkerLayer<
-  U extends object,
-  T extends MarkerClusterLayerType = 'markerClusterLayer',
-  V extends ClusterMarkerLayerInfo[T] = ClusterMarkerLayerInfo[T],
-> {
-  // 图层类型与控制器类的映射关系
-  static layerClassMap = new Map<string, ClusterMarkerLayerTypeClass>();
-  /**
-   * 注册图层类型与控制器类的关联
-   * @param {string} layerType - 图层类型
-   * @param {Function} layerClass - 图层控制器类
-   */
-  static registerLayer(
-    layerType: MarkerClusterLayerType,
-    layerClass: ClusterMarkerLayerTypeClass
-  ) {
-    if (typeof layerType !== 'string' || typeof layerClass !== 'function') {
-      MapUtils.error('[LayerManager Error]: Invalid layer type or layer class');
-      return;
-    }
-
-    ClusterMarkerLayer.layerClassMap.set(layerType, layerClass);
-  }
-
-  overlayList: Array<OverlayData<U>>;
-  // 策略模式
-  rawLayerIns: V['layerIns'];
-
-  layerVisible: boolean = true;
-
-  layerName: string;
-
-  mapUtils: mapUtilsIns;
-
-  layerType: MarkerClusterLayerType;
-
-  constructor(opts: ClusterMarkerLayerOpts<U, T>, mapUtils: mapUtilsIns) {
-    const { layerType, layerName, ...rest } = opts;
-
-    const OverlaysLayer = ClusterMarkerLayer.layerClassMap.get(layerType);
-
-    if (OverlaysLayer) {
-      // 将OverlayData转换为MarkerClusterDataOptions
-      const clusterData = this.convertOverlayDataToClusterData(
-        opts.overlayList
-      );
-
-      this.rawLayerIns = new OverlaysLayer(
-        mapUtils.map,
-        clusterData,
-        opts.layerOpts
-      );
-    } else {
-      throw new Error(
-        `[ClusterMarkerLayer Error]: Invalid layer type ${layerType}`
-      );
-    }
-
-    this.layerName = layerName;
-
-    this.mapUtils = mapUtils; //上层,mapUtils的实例
-
-    this.overlayList = opts.overlayList;
-
-    this.layerType = opts.layerType;
-
-    Object.assign(this, rest);
-  }
-
-  /**
-   * 将覆盖物数据转换为聚合标记所需的数据格式
-   * @param overlayList 覆盖物数据列表
-   * @returns 聚合标记数据列表
-   */
-  private convertOverlayDataToClusterData(
-    overlayList: Array<OverlayData<U>>
-  ): Array<MarkerClusterDataOptions> {
-    return overlayList.map(item => {
-      return {
-        lnglat: [item.overlayData.lon, item.overlayData.lat],
-        weight: item.overlayData.weight || 1,
-      };
-    });
-  }
-
-  bindEventOverlays(clickType: AMap.EventType, callback: () => void) {
-    this.rawLayerIns.bindEventMarker(clickType, callback);
-  }
-
-  hide() {
-    this.layerVisible = false;
-    this.rawLayerIns.hide();
-  }
-
-  show() {
-    this.layerVisible = true;
-    const clusterData = this.convertOverlayDataToClusterData(this.overlayList);
-    this.rawLayerIns.show(clusterData);
-  }
-
-  destroy() {
-    // @ts-ignore
-    this.mapUtils.removeLayer(this); //从MapUtils中移除
-    this.rawLayerIns.destroy(); //地图层面移除
-    this.overlayList = [];
-  }
-
-  clearAllOverlay() {
-    this.overlayList = [];
-    this.rawLayerIns.clearAllOvl();
-  }
-
-  add(overlayList: Array<OverlayData<U>>) {
-    const clusterData = this.convertOverlayDataToClusterData(overlayList);
-
-    this.overlayList.push(...overlayList);
-
-    // 逐个添加聚合数据
-    clusterData.forEach(data => {
-      this.rawLayerIns.add(data);
-    });
-  }
-
-  remove(ovs: Array<number | string>) {
-    if (Array.isArray(ovs)) {
-      // 根据ID移除覆盖物
-      const ids = ovs as Array<string | number>;
-
-      // 更新本地覆盖物列表
-      this.overlayList = this.overlayList.filter(
-        item => !ids.includes(item.id)
-      );
-
-      // 重新设置聚合数据
-      const clusterData = this.convertOverlayDataToClusterData(
-        this.overlayList
-      );
-      this.rawLayerIns.remove(clusterData);
-    }
-    // 聚合图层不支持直接移除单个实例
-  }
-
-  // 返回原始图层对象
-  getRawLayer() {
-    return this.rawLayerIns.rawLayer;
-  }
-}
-
-// 注册聚合图层类型
-ClusterMarkerLayer.registerLayer('markerClusterLayer', MarkerClusterLayer);
-
-// MarkerClusterLayer 类型
-export type MarkerClusterLayerIns = InstanceType<typeof MarkerClusterLayer>;
-
-// 所有聚合图层类型的联合类型
-export type ClusterMarkerLayerTypeIns = MarkerClusterLayerIns;
-
-export type ClusterMarkerLayerTypeClass = typeof MarkerClusterLayer;
-
-export type ClusterMarkerLayerClass = typeof ClusterMarkerLayer;
-
-export type ClusterMarkerLayerIns = InstanceType<ClusterMarkerLayerClass>;
-
-export { MarkerClusterLayer };
-
-export default ClusterMarkerLayer;
+import MarkerClusterLayer from './MarkerClusterLayer';
+import type {
+  MarkerClusterLayerType,
+  OverlayData, //OverLayerData图层公共接口
+  MarkerClusterDataOptions,
+  ClusterMarkerLayerInfo,
+  ClusterMarkerLayerOpts,
+} from '@/types';
+import { MapUtils } from '@/MapUtils';
+import type { mapUtilsIns } from '@/MapUtils';
+
+class ClusterMarkerLayer<
+  U extends object,
+  T extends MarkerClusterLayerType = 'markerClusterLayer',
+  V extends ClusterMarkerLayerInfo[T] = ClusterMarkerLayerInfo[T],
+> {
+  // 图层类型与控制器类的映射关系
+
+  /**
+   *@ignore
+   */
+  static layerClassMap = new Map<string, ClusterMarkerLayerTypeClass>();
+  /**
+   * 注册图层类型与控制器类的关联
+   * @param {string} layerType - 图层类型
+   * @param {Function} layerClass - 图层控制器类
+   * @ignore
+   */
+  static registerLayer(
+    layerType: MarkerClusterLayerType,
+    layerClass: ClusterMarkerLayerTypeClass
+  ) {
+    if (typeof layerType !== 'string' || typeof layerClass !== 'function') {
+      MapUtils.error(
+        '[ClusterMarkerLayer Error]: Invalid layer type or layer class'
+      );
+      return;
+    }
+
+    ClusterMarkerLayer.layerClassMap.set(layerType, layerClass);
+  }
+
+  overlayList: Array<OverlayData<U>>;
+  // 策略模式
+  rawLayerIns: V['layerIns'];
+
+  layerVisible: boolean = true;
+
+  layerName: string;
+
+  mapUtils: mapUtilsIns;
+
+  layerType: MarkerClusterLayerType;
+
+  constructor(opts: ClusterMarkerLayerOpts<U, T>, mapUtils: mapUtilsIns) {
+    const { layerType, layerName, ...rest } = opts;
+
+    const OverlaysLayer = ClusterMarkerLayer.layerClassMap.get(layerType);
+
+    if (OverlaysLayer) {
+      // 将OverlayData转换为MarkerClusterDataOptions
+      const clusterData = this.convertOverlayDataToClusterData(
+        opts.overlayList
+      );
+
+      this.rawLayerIns = new OverlaysLayer(
+        mapUtils.map,
+        clusterData,
+        opts.layerOpts
+      );
+    } else {
+      throw new Error(
+        `[ClusterMarkerLayer Error]: Invalid layer type ${layerType}`
+      );
+    }
+
+    this.layerName = layerName;
+
+    this.mapUtils = mapUtils; //mapUtils的实例
+
+    this.overlayList = opts.overlayList;
+
+    this.layerType = opts.layerType;
+
+    Object.assign(this, rest);
+  }
+
+  /**
+   * 将覆盖物数据转换为聚合标记所需的数据格式
+   * @param overlayList 覆盖物数据列表
+   * @returns 聚合标记数据列表
+   */
+  private convertOverlayDataToClusterData(
+    overlayList: Array<OverlayData<U>>
+  ): Array<MarkerClusterDataOptions> {
+    return overlayList.map(item => {
+      return {
+        ...item,
+        lnglat: [item.overlayData.lon, item.overlayData.lat],
+        weight: item.overlayData.weight || 1,
+      };
+    });
+  }
+
+  bindEventOverlays(clickType: AMap.EventType, callback: () => void) {
+    this.rawLayerIns.bindEventMarker(clickType, callback);
+  }
+
+  hide() {
+    this.layerVisible = false;
+    this.rawLayerIns.hide();
+  }
+
+  show() {
+    this.layerVisible = true;
+    const clusterData = this.convertOverlayDataToClusterData(this.overlayList);
+    this.rawLayerIns.show(clusterData);
+  }
+
+  destroy() {
+    this.mapUtils.removeLayer(this); //从MapUtils中移除
+    this.rawLayerIns.destroy(); //地图层面移除
+    this.overlayList = [];
+  }
+
+  clearAllOverlay() {
+    this.overlayList = [];
+    this.rawLayerIns.clearAllOvl();
+  }
+
+  add(overlayList: Array<OverlayData<U>>) {
+    const clusterData = this.convertOverlayDataToClusterData(overlayList);
+
+    this.overlayList.push(...overlayList);
+
+    // 逐个添加聚合数据
+    this.rawLayerIns.add(clusterData);
+  }
+
+  /**
+   * `remove`
+   *
+   * @param {(Array<number | string>)} ovs
+   * @memberof ClusterMarkerLayer
+   */
+  remove(ovs: Array<number | string>) {
+    if (Array.isArray(ovs)) {
+      // 根据ID移除覆盖物
+      const ids = ovs as Array<string | number>;
+
+      // 更新本地覆盖物列表
+      this.overlayList = this.overlayList.filter(
+        item => !ids.includes(item.id)
+      );
+
+      // 重新设置聚合数据
+      const clusterData = this.convertOverlayDataToClusterData(
+        this.overlayList
+      );
+      this.rawLayerIns.remove(clusterData);
+    }
+    // 聚合图层不支持直接移除单个实例
+  }
+
+  /**
+   *
+   *`getRawLayer`方法返回高德覆盖物管理对象, 例如: 图层类型为`markerClusterLayer`,方法返回的对象类型为`new AMap.MarkerCluster(xx,'xxx')`
+   * @return {*}
+   */
+  getRawLayer() {
+    return this.rawLayerIns.rawLayer;
+  }
+}
+
+// 注册聚合图层类型
+ClusterMarkerLayer.registerLayer('markerClusterLayer', MarkerClusterLayer);
+
+/**
+ * MarkerClusterLayer 类型
+ * @ignore
+ */
+export type MarkerClusterLayerIns = InstanceType<typeof MarkerClusterLayer>;
+
+/**
+ * 所有聚合图层类型的联合类型
+ * @ignore
+ */
+export type ClusterMarkerLayerTypeIns = MarkerClusterLayerIns;
+/**
+ * @ignore
+ */
+export type ClusterMarkerLayerTypeClass = typeof MarkerClusterLayer;
+/**
+ * @ignore
+ */
+export type ClusterMarkerLayerClass = typeof ClusterMarkerLayer;
+/**
+ * @ignore
+ */
+export type ClusterMarkerLayerIns = InstanceType<ClusterMarkerLayerClass>;
+
+export { MarkerClusterLayer };
+
+export default ClusterMarkerLayer;

package/src/layers/index.ts

@@ -1,9 +1,9 @@
-// 图层模块入口文件
-// 从baseMarkerLayer目录导入BaseMarkerLayer相关内容并重新导出
-export type * from './baseMarkerLayer';
-
-export type * from './clusterMarkerLayer';
-
-export { default as BaseMarkerLayer } from './baseMarkerLayer';
-
-export { default as ClusterMarkerLayer } from './clusterMarkerLayer';
+// 图层模块入口文件
+// 从baseMarkerLayer目录导入BaseMarkerLayer相关内容并重新导出
+export type * from './baseMarkerLayer';
+
+export type * from './clusterMarkerLayer';
+
+export { default as BaseMarkerLayer } from './baseMarkerLayer';
+
+export { default as ClusterMarkerLayer } from './clusterMarkerLayer';

package/src/types/MapUtils.d.ts

@@ -1,53 +1,53 @@
-// 高德地图实例
-type mapIns = InstanceType<typeof AMap.Map>;
-
-type MapOptions = AMap.MapOptions;
-
-interface MapUtilsCreateOpts extends MapOptions {
-  mountSelector: string;
-}
-
-interface MapUtilsUseExistingOpts extends MapOptions {
-  mapIns: mapIns;
-}
-
-type MapUtilsOpts = {
-  MapUtilsUseExistingOpts: MapUtilsUseExistingOpts;
-  MapUtilsCreateOpts: MapUtilsCreateOpts;
-};
-
-interface MapUtilsStatic extends MapMixinType {
-  new (
-    opts: MapUtilsOpts[keyof MapUtilsOpts],
-    AMap: Simplify<typeof gdAMap>
-  ): MapUtils;
-}
-
-// 图层管理器
-interface LayerManger<T = new (...args: any[]) => any, K = InstanceType<T>> {
-  layers: Map<string, K>; //组合模式
-
-  addLayer(layer: K): void;
-
-  removeLayer(layerIdOrLayer: K | string): void;
-
-  show(): void;
-
-  hide(): void;
-
-  showAll(): void;
-
-  hideAll(): void;
-
-  reload(): void;
-}
-
-export type {
-  mapIns,
-  MapOptions,
-  MapUtilsCreateOpts,
-  MapUtilsUseExistingOpts,
-  MapUtilsOpts,
-  LayerManger,
-  MapUtilsStatic,
-};
+// 高德地图实例
+type mapIns = InstanceType<typeof AMap.Map>;
+
+type MapOptions = AMap.MapOptions;
+
+interface MapUtilsCreateOpts extends MapOptions {
+  mountSelector: string;
+}
+
+interface MapUtilsUseExistingOpts extends MapOptions {
+  mapIns: mapIns;
+}
+
+type MapUtilsOpts = {
+  MapUtilsUseExistingOpts: MapUtilsUseExistingOpts;
+  MapUtilsCreateOpts: MapUtilsCreateOpts;
+};
+
+interface MapUtilsStatic extends MapMixinType {
+  new (
+    opts: MapUtilsOpts[keyof MapUtilsOpts],
+    AMap: Simplify<typeof gdAMap>
+  ): MapUtils;
+}
+
+// 图层管理器
+interface LayerManger<T = new (...args: any[]) => any, K = InstanceType<T>> {
+  layers: Map<string, K>; //组合模式
+
+  addLayer(layer: K): void;
+
+  removeLayer(layerIdOrLayer: K | string): void;
+
+  show(): void;
+
+  hide(): void;
+
+  showAll(): void;
+
+  hideAll(): void;
+
+  reload(): void;
+}
+
+export type {
+  mapIns,
+  MapOptions,
+  MapUtilsCreateOpts,
+  MapUtilsUseExistingOpts,
+  MapUtilsOpts,
+  LayerManger,
+  MapUtilsStatic,
+};

package/src/types/amap.d.ts

@@ -1,11 +1,11 @@
-// 导入高德地图类型声明
-import type { load } from '@amap/amap-jsapi-loader';
-import '@amap/amap-jsapi-types';
-
-type loaderOpts = Parameters<typeof load>[0]; //函数类型取出
-
-type MapOptions = AMap.MapOptions;
-type MarkerOptions = AMap.MarkerOptions;
-type LabelMarkerOptions = AMap.LabelMarkerOptions;
-
-export type { loaderOpts, AMap, MapOptions, MarkerOptions, LabelMarkerOptions };
+// 导入高德地图类型声明
+import type { load } from '@amap/amap-jsapi-loader';
+import '@amap/amap-jsapi-types';
+
+type loaderOpts = Parameters<typeof load>[0]; //函数类型取出
+
+type MapOptions = AMap.MapOptions;
+type MarkerOptions = AMap.MarkerOptions;
+type LabelMarkerOptions = AMap.LabelMarkerOptions;
+
+export type { loaderOpts, AMap, MapOptions, MarkerOptions, LabelMarkerOptions };