gdmap-utils 1.2.3 → 1.2.5

package/src/types/{BaseMarkerLayer.d.ts → baseMarkerLayer.d.ts}

@@ -1,87 +1,86 @@
-import type { MarkerOptions } from './amap';
-import type { MapUtilsConstructor } from '../MapUtils';
-import type {
-  MarkerLayerIns,
-  LabelMarkerLayerIns,
-  MarkerClusterLayerIns,
-  BaseMarkerLayerTypeIns,
-} from '../layers/index';
-
-interface BaseMarkerLayerInfo {
-  markerLayer: {
-    layerIns: MarkerLayerIns;
-    overlayOpts: AMap.MarkerOptions;
-    ovIns: AMap.Marker;
-  };
-  labelMarkerLayer: {
-    layerIns: LabelMarkerLayerIns;
-    overlayOpts: AMap.LabelMarkerOptions;
-    ovIns: AMap.LabelMarker;
-  };
-}
-//定义图层信息
-type MarkerLayerBaseType = 'markerLayer' | 'labelMarkerLayer';
-
-export interface OverlayData<T extends object = {}> {
-  overlayData: {
-    lon: number;
-    lat: number;
-    title: string;
-    id: string;
-    extData: T;
-    weight?: number;
-  };
-  id: string;
-  // 覆盖物配置数据
-  labelShowed: boolean;
-  overlaySelected: boolean; // 当前marker是否被选中
-}
-
-interface LayerOpts<
-  U = {},
-  T extends MarkerLayerBaseType = 'markerLayer',
-  V = BaseMarkerLayerInfo[T],
-> {
-  layerType: T;
-  layerName: string;
-  overlayList: Array<OverlayData<U>>;
-  createOverlays: (mapUtilsIns) => Array<V['overlayIns']>; // 未使用上
-  getIconUrl: (item: OverlayData<U>) => string; //overlayList中优先级更高
-  getOverlayOpts: (
-    item: OverlayData<U>,
-    index: number,
-    MapUtils: MapUtilsConstructor
-  ) => V['overlayOpts']; //动态生成覆盖物配置
-  overlayLayer?: AMap.LabelsLayerOptions;
-}
-
-interface OverlaysLayer<T, U> {
-  rawLayer: U;
-
-  //创建覆盖物
-  createOverlays: (ovOptList: Array<any>) => Array<T>;
-
-  add(markers: Array<any>): void;
-
-  remove(markers: Array<T>): void;
-
-  hide(): void;
-
-  show(): void;
-
-  getAllOverlay(): void;
-
-  destroy: () => void;
-
-  reload: () => void;
-
-  //覆盖物自动适应
-  overlayFitMap: () => void;
-}
-
-export type {
-  BaseMarkerLayerInfo,
-  MarkerLayerBaseType,
-  LayerOpts,
-  OverlaysLayer,
-};
+import type { MarkerOptions } from './amap';
+import type { MapUtilsConstructor } from '../MapUtils';
+import type {
+  MarkerLayerIns,
+  LabelMarkerLayerIns,
+  MarkerClusterLayerIns,
+  BaseMarkerLayerTypeIns,
+} from '../layers/index';
+
+interface BaseMarkerLayerInfo {
+  markerLayer: {
+    layerIns: MarkerLayerIns;
+    overlayOpts: AMap.MarkerOptions;
+    ovIns: AMap.Marker;
+  };
+  labelMarkerLayer: {
+    layerIns: LabelMarkerLayerIns;
+    overlayOpts: AMap.LabelMarkerOptions;
+    ovIns: AMap.LabelMarker;
+  };
+}
+//定义图层信息
+type MarkerLayerBaseType = 'markerLayer' | 'labelMarkerLayer';
+
+export interface OverlayData<T extends object = {}> {
+  overlayData: {
+    lon: number;
+    lat: number;
+    title: string;
+    id: string;
+    extData: T;
+    weight?: number;
+  };
+  id: string;
+  // 覆盖物配置数据
+  labelShowed: boolean;
+  overlaySelected: boolean; // 当前marker是否被选中
+}
+
+interface LayerOpts<
+  U = {},
+  T extends MarkerLayerBaseType = 'markerLayer',
+  V = BaseMarkerLayerInfo[T],
+> {
+  layerType: T;
+  layerName: string;
+  overlayList: Array<OverlayData<U>>;
+  getIconUrl: (item: OverlayData<U>) => string; //overlayList中优先级更高
+  getOverlayOpts: (
+    item: OverlayData<U>,
+    index: number,
+    MapUtils: MapUtilsConstructor
+  ) => V['overlayOpts']; //动态生成覆盖物配置
+  overlayLayer?: AMap.LabelsLayerOptions;
+}
+
+interface OverlaysLayer<T, U> {
+  rawLayer: U;
+
+  //创建覆盖物
+  createOverlays: (ovOptList: Array<any>) => Array<T>;
+
+  add(markers: Array<any>): void;
+
+  remove(markers: Array<T>): void;
+
+  hide(): void;
+
+  show(): void;
+
+  getAllOverlay(): void;
+
+  destroy: () => void;
+
+  reload: () => void;
+
+  //覆盖物自动适应
+  overlayFitMap: () => void;
+}
+
+export type {
+  BaseMarkerLayerInfo,
+  MarkerLayerBaseType,
+  LayerOpts,
+  OverlaysLayer,
+};

package/src/types/clusterMarkerLayer.d.ts

@@ -1,88 +1,89 @@
-import type { MarkerClusterLayerIns } from '@/layers/clusterMarkerLayer/index.ts';
-import type { OverlayData } from './BaseMarkerLayer';
-//定义聚合图层类型
-type MarkerClusterLayerType = 'markerClusterLayer';
-
-//!------------markerClusterLayer.ts类型代码如下------------------
-// 图层配置信息
-interface MarkerClusterOptions {
-  /** 聚合计算时网格的像素大小，默认 60 */
-  gridSize?: number;
-  /** 最大聚合级别，大于该级别不再聚合，默认 18 */
-  maxZoom?: number;
-  /**
-   * 聚合图标位置是否取所有点（或权重最大点）的中心。
-   * 默认为 true。
-   */
-  averageCenter?: boolean;
-  /** 地图缩放过程中是否实时重算聚合，默认 false */
-  clusterByZoomChange?: boolean;
-  /**
-   * 聚合图标样式数组，按聚合数量区间 1-10、11-100、101-1000… 顺序给出。
-   * 当数量超出给定样式时，剩余区间使用默认样式。
-   */
-  styles?: Array<{
-    /** 图标图片地址（必选） */
-    url: string;
-    /** 图标尺寸（必选） */
-    size: AMap.Size;
-    /** 图标定位偏移，默认 (0,0) */
-    offset?: AMap.Pixel;
-    /** 图片背景偏移，等同 CSS background-position，默认 (0,0) */
-    imageOffset?: AMap.Pixel;
-    /** 文字颜色，默认 "#000000" */
-    textColor?: string;
-    /** 文字大小，默认 10 */
-    textSize?: number;
-  }>;
-  /**
-   * 自定义聚合点绘制逻辑，指定后 styles 失效。
-   * @param context 聚合上下文
-   */
-  renderClusterMarker?: (context: {
-    /** 当前聚合包含的 Marker 数量 */
-    count: number;
-    /** 当前聚合所对应的 Marker 对象（可进一步修改其 Icon、内容等） */
-    marker: AMap.Marker;
-  }) => void;
-  /**
-   * 自定义非聚合点绘制逻辑。
-   * @param context 非聚合点上下文
-   */
-  renderMarker?: (context: {
-    /** 非聚合的 Marker 对象 */
-    marker: AMap.Marker;
-  }) => void;
-}
-
-type MarkerClusterDataOptions<T extends {} = {}> = {
-  weight: number;
-  lnglat: [number, number];
-} & T;
-
-type ClusterMarkerLayerInfo = {
-  markerClusterLayer: {
-    layerIns: MarkerClusterLayerIns;
-    layerOpts: MarkerClusterOptions;
-  };
-};
-
-interface ClusterMarkerLayerOpts<
-  U = {},
-  T extends MarkerClusterLayerType = 'markerClusterLayer',
-  V = ClusterMarkerLayerInfo[T],
-> {
-  layerType: T;
-  layerName: string;
-  overlayList: Array<OverlayData<U>>;
-  layerOpts: V['layerOpts'];
-}
-
-export type {
-  MarkerClusterLayerType,
-  MarkerClusterOptions,
-  MarkerClusterDataOptions,
-  // 图层定义类型代码
-  ClusterMarkerLayerInfo,
-  ClusterMarkerLayerOpts,
-};
+import type { MarkerClusterLayerIns } from '@/layers/clusterMarkerLayer/index.ts';
+import type { OverlayData } from './BaseMarkerLayer';
+//定义聚合图层类型
+type MarkerClusterLayerType = 'markerClusterLayer';
+
+//!------------markerClusterLayer.ts类型代码如下------------------
+// 图层配置信息
+interface MarkerClusterOptions {
+  /** 聚合计算时网格的像素大小，默认 60 */
+  gridSize?: number;
+  /** 最大聚合级别，大于该级别不再聚合，默认 18 */
+  maxZoom?: number;
+  /**
+   * 聚合图标位置是否取所有点（或权重最大点）的中心。
+   * 默认为 true。
+   */
+  averageCenter?: boolean;
+  /** 地图缩放过程中是否实时重算聚合，默认 false */
+  clusterByZoomChange?: boolean;
+  /**
+   * 聚合图标样式数组，按聚合数量区间 1-10、11-100、101-1000… 顺序给出。
+   * 当数量超出给定样式时，剩余区间使用默认样式。
+   */
+  styles?: Array<{
+    /** 图标图片地址（必选） */
+    url: string;
+    /** 图标尺寸（必选） */
+    size: AMap.Size;
+    /** 图标定位偏移，默认 (0,0) */
+    offset?: AMap.Pixel;
+    /** 图片背景偏移，等同 CSS background-position，默认 (0,0) */
+    imageOffset?: AMap.Pixel;
+    /** 文字颜色，默认 "#000000" */
+    textColor?: string;
+    /** 文字大小，默认 10 */
+    textSize?: number;
+  }>;
+  /**
+   * 自定义聚合点绘制逻辑，指定后 styles 失效。
+   * @param context 聚合上下文
+   */
+  renderClusterMarker?: (context: {
+    /** 当前聚合包含的 Marker 数量 */
+    count: number;
+    /** 当前聚合所对应的 Marker 对象（可进一步修改其 Icon、内容等） */
+    marker: AMap.Marker;
+  }) => void;
+  /**
+   * 自定义非聚合点绘制逻辑。
+   * @param context 非聚合点上下文
+   */
+  renderMarker?: (context: {
+    /** 非聚合的 Marker 对象 */
+    marker: AMap.Marker;
+  }) => void;
+}
+
+type MarkerClusterDataOptions<T extends {} = {}> = {
+  weight: number;
+  lnglat: [number, number];
+} & T;
+
+type ClusterMarkerLayerInfo = {
+  markerClusterLayer: {
+    layerIns: MarkerClusterLayerIns;
+    layerOpts: MarkerClusterOptions;
+  };
+};
+
+interface ClusterMarkerLayerOpts<
+  U = {},
+  T extends MarkerClusterLayerType = 'markerClusterLayer',
+  V = ClusterMarkerLayerInfo[T],
+> {
+  layerType: T;
+  layerName: string;
+  overlayList: Array<OverlayData<U>>;
+  layerOpts: V['layerOpts']; //类型动态计算
+}
+
+export type {
+  MarkerClusterLayerType,
+  MarkerClusterOptions,
+  MarkerClusterDataOptions,
+  // 图层定义类型代码
+  ClusterMarkerLayerInfo,
+  ClusterMarkerLayerOpts,
+  MarkerClusterLayerIns,
+};

package/src/types/index.d.ts

@@ -1,14 +1,14 @@
-// 从MapUtils.d.ts导入并重新导出类型
-export type * from './MapUtils';
-
-// 从BaseMarkerLayer.d.ts导入并重新导出类型
-export type * from './BaseMarkerLayer';
-
-export type * from './clusterMarkerLayer';
-
-interface Window {
-  _AMapSecurityConfig?: {
-    securityJsCode: string;
-    serviceHost: string;
-  };
-}
+// 从MapUtils.d.ts导入并重新导出类型
+export type * from './MapUtils';
+
+// 从BaseMarkerLayer.d.ts导入并重新导出类型
+export type * from './baseMarkerLayer';
+
+export type * from './clusterMarkerLayer';
+
+interface Window {
+  _AMapSecurityConfig?: {
+    securityJsCode: string;
+    serviceHost: string;
+  };
+}

package/tsconfig.json

@@ -1,27 +1,27 @@
-{
-  "compilerOptions": {
-    "target": "ES5",
-    "module": "ESNext",
-    "lib": ["ES5", "ES2015", "ES2016", "ES2017", "DOM"],
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": false,
-    "typeRoots": ["./src/types", "./node_modules/@types"],
-    "baseUrl": "./",
-    "paths": {
-      "@/*": ["src/*"]
-    }        
-  },
-  "include": ["env.d.ts", "src/**/*", "src/**/*.vue"],
-  "exclude": ["node_modules", "dist"]
+{
+  "compilerOptions": {
+    "target": "ES5",
+    "module": "ESNext",
+    "lib": ["ES5", "ES2015", "ES2016", "ES2017", "DOM"],
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": false,
+    "typeRoots": ["./src/types", "./node_modules/@types"],
+    "baseUrl": "./",
+    "paths": {
+      "@/*": ["src/*"]
+    }        
+  },
+  "include": ["env.d.ts", "src/**/*", "src/**/*.vue"],
+  "exclude": ["node_modules", "dist"]
 }

package/typedoc.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "plugin": ["typedoc-plugin-markdown"],
+  "exclude": ["**/*.d.ts", "node_modules/**", "**/*.test.ts", "**/LabelMarkerLayer.ts", "**/MarkerLayer.ts", "**/MarkerClusterLayer.ts"],
+  "includeVersion": false,
+  "readme": "README.md",
+  "name": "GdMapUtils",
+  "theme": "markdown",
+  "categorizeByGroup": true,
+  "sort": ["source-order"],
+  "skipErrorChecking": true,
+  "hidePageTitle": true,
+  "disableSources": true,
+  "excludePrivate": true,
+  "excludeProtected": true,
+  "excludeInternal": true,
+  "hideGenerator": true,
+  "gitRevision": "main",
+  "excludeExternals": true
+}