map-ol-utils 0.1.28 → 0.1.29

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { Layer, Tile } from 'ol/layer';
 import { Style } from 'ol/style';
-import { Map as Map$1, Feature, Overlay } from 'ol';
+import { Map as Map$1, Overlay, Feature } from 'ol';
 import { CRSTypes } from 'gcoord';
 import * as ol_source from 'ol/source';
 import { Source, XYZ, WMTS } from 'ol/source';
@@ -9,15 +9,15 @@ import { FeatureLike } from 'ol/Feature';
 import { Emitter, EventType } from 'mitt';
 import TileLayer from 'ol/layer/Tile';
 import * as ol_renderer_Layer from 'ol/renderer/Layer';
-import * as ol_geom from 'ol/geom';
-import { Point, SimpleGeometry } from 'ol/geom';
 import { Options } from 'ol/Overlay';
-import Cluster from 'ol/source/Cluster';
-import { Select } from 'ol/interaction';
 import VectorLayer from 'ol/layer/Vector';
-import { StyleLike } from 'ol/style/Style';
-import VectorSource from 'ol/source/Vector';
+import * as ol_geom from 'ol/geom';
+import { SimpleGeometry, Point } from 'ol/geom';
 import { FitOptions, AnimationOptions } from 'ol/View';
+import { Select } from 'ol/interaction';
+import VectorSource from 'ol/source/Vector';
+import { StyleLike } from 'ol/style/Style';
+import Cluster from 'ol/source/Cluster';
 
 interface CustomMap extends Map$1 {
     activeBaseLayer?: string;
@@ -167,47 +167,88 @@ declare const resetMap: (config?: {
     isClearAll: boolean;
 }) => void;
 
+/**
+ * 移除带指定属性键的 Overlay（默认按 'position'）
+ * @param key
+ */
 declare const removeOverlays: (key?: string) => void;
+/**
+ * 创建动画标注 Overlay
+ * @param imgUrl
+ * @param data
+ */
 declare const createAnimationMarker: (imgUrl: string, data: MassData) => void;
 /**
- * 重置激活的矢量数据
+ * 创建 Overlay
+ * @param config
  */
-declare const resetActiveVector: () => void;
+declare const createOverlay: (config?: Options) => Overlay;
+
 /**
- * 根据Array<Coordinate> Fit
+ * 根据 Array<Coordinate> Fit
  * @param coords
  * @param mapInstance
  * @param fitOptions
  */
 declare const setFitViewByCoords: (coords: Array<Coordinate>, mapInstance?: CustomMap, fitOptions?: FitOptions | AnimationOptions) => void;
 /**
- * 根据SimpleGeometry Fit
+ * 根据 SimpleGeometry Fit
  * @param geom
  * @param mapInstance
  * @param fitOptions
  */
 declare const setFitViewByGeom: (geom: SimpleGeometry, mapInstance?: CustomMap, fitOptions?: FitOptions) => void;
 /**
- * 根据VectorLayer要素的四至信息Fit
+ * 根据 VectorLayer 要素的四至信息 Fit
  * @param layer
  * @param mapInstance
  * @param fitOptions
  */
 declare const setFitViewByLayer: (layer: VectorLayer, mapInstance?: CustomMap, fitOptions?: FitOptions) => void;
+
+/**
+ * 创建点击交互
+ * @param vectorLayer
+ */
+declare const createSelectByLayer: (vectorLayer: VectorLayer) => Select;
+
+/**
+ * 重置激活的矢量数据（清空 overlay 与各图层选择交互的要素集合）
+ */
+declare const resetActiveVector: () => void;
+/**
+ * 移除覆盖物以及所有非底图自定义图层
+ */
+declare const removeAllLayers: () => void;
+/**
+ * 重置激活 Feature
+ */
+declare const resetActiveFeature: () => void;
+/**
+ * 按 _uuid 激活要素
+ * @param uid
+ */
+declare const activeFeatureByUid: (uid: string) => void;
+
+/**
+ * 创建业务矢量图层（自动推断线/面，生成默认/激活样式）
+ * @param dataList
+ * @param config
+ */
 declare const createBusinessLayer: (dataList: MassData[], config: VectorConfig) => VectorLayer<VectorSource<Feature<ol_geom.Geometry, {
     [x: string]: any;
 }>>, Feature<ol_geom.Geometry, {
     [x: string]: any;
 }>>;
 /**
- * 追加Features
+ * 追加 Features
  * @param targetLayer
  * @param dataList
  * @param crsForm
  */
 declare const appendFeaturesByLayer: (targetLayer: VectorLayer, dataList: MassData[], crsForm?: CRSTypes) => void;
 /**
- * 创建面状数据
+ * 创建面状图层
  * @param dataList
  * @param config
  */
@@ -226,39 +267,22 @@ declare const createVectorLineLayer: (dataList: MassData[] | undefined, config:
 }>>, Feature<ol_geom.Geometry, {
     [x: string]: any;
 }>>;
+
 /**
- * 移除覆盖物以及自定义图层
- */
-declare const removeAllLayers: () => void;
-/**
- * 重置激活Feature
- */
-declare const resetActiveFeature: () => void;
-/**
- * 激活要素
- * @param uid
- */
-declare const activeFeatureByUid: (uid: string) => void;
-/**
- * 构建MassMarks样式数组
+ * 构建 MassMarks 样式数组（默认段 + 激活段，长度 statusNum * 2）
  */
 declare const buildMassMarksStyles: (getImgUrlFn: GetImgUrlFn) => (iconConfig: IconConfig) => any[];
 /**
- * 创建点击交互
- * @param vectorLayer
- */
-declare const createSelectByLayer: (vectorLayer: VectorLayer) => Select;
-/**
- * 添加Features
+ * 向海量点图层增量添加 Features
  * @param targetLayer
  * @param dataList
  * @param config
  */
 declare const addFeaturesByLayer: (targetLayer: VectorLayer, dataList: MassData[], config: {
-    clear: false;
+    clear?: boolean;
 }) => void;
 /**
- * 创建massMarksLayer
+ * 创建 massMarksLayer
  * @param dataList
  * @param styleList
  */
@@ -268,7 +292,7 @@ declare const createMassMarksLayer: (dataList: MassData[], styleList?: StyleLike
     [x: string]: any;
 }>>;
 /**
- * 添加massMarksLayer
+ * 添加 massMarksLayer（按需附带线/面图层）
  * @param getImgUrlFn
  */
 declare const addMassMarksLayer: (getImgUrlFn: GetImgUrlFn) => (dataList: never[] | undefined, iconConfig: IconConfig, openClick?: boolean) => VectorLayer<VectorSource<Feature<Point, {
@@ -277,17 +301,13 @@ declare const addMassMarksLayer: (getImgUrlFn: GetImgUrlFn) => (dataList: never[
     [x: string]: any;
 }>>;
 /**
- * 更新图层根据选中状态列表
+ * 按选中状态列表更新海量点显隐
  * @param checkedStatusList
  */
 declare const updateMarksLayersByStatus: (checkedStatusList?: string[]) => MassData[];
+
 /**
- * 创建Overlay
- * @param config
- */
-declare const createOverlay: (config?: Options) => Overlay;
-/**
- * 创建聚合图层
+ * 创建聚合图层（半径/颜色随聚合数量动态计算）
  * @param dataList
  * @param config
  */

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Layer, Tile } from 'ol/layer';
 import { Style } from 'ol/style';
-import { Map as Map$1, Feature, Overlay } from 'ol';
+import { Map as Map$1, Overlay, Feature } from 'ol';
 import { CRSTypes } from 'gcoord';
 import * as ol_source from 'ol/source';
 import { Source, XYZ, WMTS } from 'ol/source';
@@ -9,15 +9,15 @@ import { FeatureLike } from 'ol/Feature';
 import { Emitter, EventType } from 'mitt';
 import TileLayer from 'ol/layer/Tile';
 import * as ol_renderer_Layer from 'ol/renderer/Layer';
-import * as ol_geom from 'ol/geom';
-import { Point, SimpleGeometry } from 'ol/geom';
 import { Options } from 'ol/Overlay';
-import Cluster from 'ol/source/Cluster';
-import { Select } from 'ol/interaction';
 import VectorLayer from 'ol/layer/Vector';
-import { StyleLike } from 'ol/style/Style';
-import VectorSource from 'ol/source/Vector';
+import * as ol_geom from 'ol/geom';
+import { SimpleGeometry, Point } from 'ol/geom';
 import { FitOptions, AnimationOptions } from 'ol/View';
+import { Select } from 'ol/interaction';
+import VectorSource from 'ol/source/Vector';
+import { StyleLike } from 'ol/style/Style';
+import Cluster from 'ol/source/Cluster';
 
 interface CustomMap extends Map$1 {
     activeBaseLayer?: string;
@@ -167,47 +167,88 @@ declare const resetMap: (config?: {
     isClearAll: boolean;
 }) => void;
 
+/**
+ * 移除带指定属性键的 Overlay（默认按 'position'）
+ * @param key
+ */
 declare const removeOverlays: (key?: string) => void;
+/**
+ * 创建动画标注 Overlay
+ * @param imgUrl
+ * @param data
+ */
 declare const createAnimationMarker: (imgUrl: string, data: MassData) => void;
 /**
- * 重置激活的矢量数据
+ * 创建 Overlay
+ * @param config
  */
-declare const resetActiveVector: () => void;
+declare const createOverlay: (config?: Options) => Overlay;
+
 /**
- * 根据Array<Coordinate> Fit
+ * 根据 Array<Coordinate> Fit
  * @param coords
  * @param mapInstance
  * @param fitOptions
  */
 declare const setFitViewByCoords: (coords: Array<Coordinate>, mapInstance?: CustomMap, fitOptions?: FitOptions | AnimationOptions) => void;
 /**
- * 根据SimpleGeometry Fit
+ * 根据 SimpleGeometry Fit
  * @param geom
  * @param mapInstance
  * @param fitOptions
  */
 declare const setFitViewByGeom: (geom: SimpleGeometry, mapInstance?: CustomMap, fitOptions?: FitOptions) => void;
 /**
- * 根据VectorLayer要素的四至信息Fit
+ * 根据 VectorLayer 要素的四至信息 Fit
  * @param layer
  * @param mapInstance
  * @param fitOptions
  */
 declare const setFitViewByLayer: (layer: VectorLayer, mapInstance?: CustomMap, fitOptions?: FitOptions) => void;
+
+/**
+ * 创建点击交互
+ * @param vectorLayer
+ */
+declare const createSelectByLayer: (vectorLayer: VectorLayer) => Select;
+
+/**
+ * 重置激活的矢量数据（清空 overlay 与各图层选择交互的要素集合）
+ */
+declare const resetActiveVector: () => void;
+/**
+ * 移除覆盖物以及所有非底图自定义图层
+ */
+declare const removeAllLayers: () => void;
+/**
+ * 重置激活 Feature
+ */
+declare const resetActiveFeature: () => void;
+/**
+ * 按 _uuid 激活要素
+ * @param uid
+ */
+declare const activeFeatureByUid: (uid: string) => void;
+
+/**
+ * 创建业务矢量图层（自动推断线/面，生成默认/激活样式）
+ * @param dataList
+ * @param config
+ */
 declare const createBusinessLayer: (dataList: MassData[], config: VectorConfig) => VectorLayer<VectorSource<Feature<ol_geom.Geometry, {
     [x: string]: any;
 }>>, Feature<ol_geom.Geometry, {
     [x: string]: any;
 }>>;
 /**
- * 追加Features
+ * 追加 Features
  * @param targetLayer
  * @param dataList
  * @param crsForm
  */
 declare const appendFeaturesByLayer: (targetLayer: VectorLayer, dataList: MassData[], crsForm?: CRSTypes) => void;
 /**
- * 创建面状数据
+ * 创建面状图层
  * @param dataList
  * @param config
  */
@@ -226,39 +267,22 @@ declare const createVectorLineLayer: (dataList: MassData[] | undefined, config:
 }>>, Feature<ol_geom.Geometry, {
     [x: string]: any;
 }>>;
+
 /**
- * 移除覆盖物以及自定义图层
- */
-declare const removeAllLayers: () => void;
-/**
- * 重置激活Feature
- */
-declare const resetActiveFeature: () => void;
-/**
- * 激活要素
- * @param uid
- */
-declare const activeFeatureByUid: (uid: string) => void;
-/**
- * 构建MassMarks样式数组
+ * 构建 MassMarks 样式数组（默认段 + 激活段，长度 statusNum * 2）
  */
 declare const buildMassMarksStyles: (getImgUrlFn: GetImgUrlFn) => (iconConfig: IconConfig) => any[];
 /**
- * 创建点击交互
- * @param vectorLayer
- */
-declare const createSelectByLayer: (vectorLayer: VectorLayer) => Select;
-/**
- * 添加Features
+ * 向海量点图层增量添加 Features
  * @param targetLayer
  * @param dataList
  * @param config
  */
 declare const addFeaturesByLayer: (targetLayer: VectorLayer, dataList: MassData[], config: {
-    clear: false;
+    clear?: boolean;
 }) => void;
 /**
- * 创建massMarksLayer
+ * 创建 massMarksLayer
  * @param dataList
  * @param styleList
  */
@@ -268,7 +292,7 @@ declare const createMassMarksLayer: (dataList: MassData[], styleList?: StyleLike
     [x: string]: any;
 }>>;
 /**
- * 添加massMarksLayer
+ * 添加 massMarksLayer（按需附带线/面图层）
  * @param getImgUrlFn
  */
 declare const addMassMarksLayer: (getImgUrlFn: GetImgUrlFn) => (dataList: never[] | undefined, iconConfig: IconConfig, openClick?: boolean) => VectorLayer<VectorSource<Feature<Point, {
@@ -277,17 +301,13 @@ declare const addMassMarksLayer: (getImgUrlFn: GetImgUrlFn) => (dataList: never[
     [x: string]: any;
 }>>;
 /**
- * 更新图层根据选中状态列表
+ * 按选中状态列表更新海量点显隐
  * @param checkedStatusList
  */
 declare const updateMarksLayersByStatus: (checkedStatusList?: string[]) => MassData[];
+
 /**
- * 创建Overlay
- * @param config
- */
-declare const createOverlay: (config?: Options) => Overlay;
-/**
- * 创建聚合图层
+ * 创建聚合图层（半径/颜色随聚合数量动态计算）
  * @param dataList
  * @param config
  */