mirage2d 1.1.93 → 1.1.94

package/dist/Tools/SpatialAnalysis.d.ts

@@ -4,7 +4,15 @@ import { Geometry } from "ol/geom";
 import * as olExtent from 'ol/extent';
 import { GraphicLayer } from "src/Layer";
 export declare class SpatialAnalysis {
-    static sector(origin: any, radius: any, antBearing: any, rotation: any): Feature<Geometry>;
+    /**
+   * @description:   创建给定半径和中心点的圆的一个扇形，位于(顺时针)bearing1和bearing2之间;0方位为中心点以北，顺时针正。
+   * @param {Feature<Geometry>} center 中心点
+   * @param {number} radius 圆的半径，单位km
+   * @param {number} antBearing 扇区第一个半径的角度，以十进制为单位
+   * @param {number} rotation 扇形第二半径的角度，以十进制度数表示
+   * @return {Feature <Geometry>}
+   */
+    static sector(center: any, radius: any, antBearing: any, rotation: any): Feature<Geometry>;
     /**
      * @description: 获取一个参考点和一个具有点几何特征的FeatureCollection，并从FeatureCollection最接近的参考点返回点。这个计算是测地线的。
      * @param {Feature<Geometry>} targetPoint
@@ -38,11 +46,18 @@ export declare class SpatialAnalysis {
     static lineOffset(line: Feature<Geometry>, unitsNum?: number): Feature<Geometry>;
     /**
      * @description: 获取一个点和一个LineString，并计算(多)LineString上最近的点。
-     * @param {*} point
-     * @param {*} line
+     * @param { Feature<Geometry>} point
+     * @param { Feature<Geometry>} line
      * @return {*}
      */
-    static nearestPointOnLine(point: any, line: any): Feature<Geometry>;
+    static nearestPointOnLine(point: Feature<Geometry>, line: Feature<Geometry>): Feature<Geometry>;
+    /**
+    * @description: 获取一个点和一个LineString，并计算(多)LineString上最近的点。
+    * @param { Feature<Geometry>} point
+    * @param { Feature<Geometry>} line
+    * @return {*}
+    */
+    static nearestPointOnLines(point: any, line: any): Feature<Geometry>;
     /**
      * @description: 比较相同维度的两个几何图形，如果它们的交集集产生的几何图形与两个几何图形不同，但维度相同，则返回true
      * @param {Feature} f1
@@ -57,7 +72,6 @@ export declare class SpatialAnalysis {
    * @return {*}
    */
     static booleanPointInPolygon(f1: Feature<Geometry>, f2: Feature<Geometry>): boolean;
-    static nearestPointOnLines(point: any, line: any): Feature<Geometry>;
     /**
      * @description: 缓冲区分析
      * @param {Feature<Geometry>} feature
@@ -86,35 +100,128 @@ export declare class SpatialAnalysis {
      * @return {*} 包含的featureList
      */
     static booleanContains(feature: any, featureList: any): any[];
+    /**
+   * @description: 创建泰森多边形
+   * @param {string} type 范围pointToPolygonType.voronoi tin convex
+   * @param {Array<Feature<Geometry>>} featureList 参与运算的点数据数组
+   * @param {string} strokecolor 可选 边框色
+   * @param {string} fillcolor 可选 填充色
+   * @return {*} 包含的featureList
+   */
     static createPolygon(type: string, featureList: Array<Feature<Geometry>>, strokecolor?: string, fillcolor?: string): any[] | Feature<Geometry>;
+    /**
+  * @description: 创建多边形网格
+  * @param {string} type 范围datagridType.point hex square triangle
+  * @param {*} option  { box: [0, 0, 0, 0], cellSide: 50 } box 生成四角范围【minLng,minLat,maxLng,maxLat】 cellSide km单位 默认50
+  * @return {*}  要素数组
+  */
     static createGrid(type: any, option?: {
         box: number[];
         cellSide: number;
     }): any[];
+    /**
+   * @description: 等值面
+   * @param {FeatureCollection <Point>} points 点数据数组
+   * @param {number[]} breaks 级别数组 示例 [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+   * @param {string} zProperty 分组属性字段名
+   * @return {*}  要素数组
+   */
     static isobands(points: any, breaks: any, zProperty: any): Feature<Geometry>[];
+    /**
+  * @description:   采用带有z值的点特征的网格FeatureCollection和一组断点值并生成等值线。
+  * @param {FeatureCollection<Point>} points 点数据数组
+  * @param {number[]} breaks 级别数组 示例 [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+  * @param {string} zProperty 分组属性字段名
+  * @return {*}  要素数组
+  */
     static isolines(points: any, breaks: any, zProperty: any): Feature<Geometry>[];
+    /**
+  * @description: 随机面，随机节点数 最小3最大10
+  * @param {FeatureCollection <Point>} box   生成四角范围【minLng,minLat,maxLng,maxLat】
+  * @param {number} maxRadialLength 顶点可以到达多边形中心以外的纬度或经度的最大十进制度数。默认0.0111
+  * @param {number} maxNum 最大数量
+  * @return {*}  要素数组
+  */
     static randomPolygons(box: any, maxRadialLength?: number, maxNum?: number): any[];
+    /**
+  * @description: 随机线，随机节点数 最小3最大10
+  * @param {FeatureCollection <Point>} box   生成四角范围【minLng,minLat,maxLng,maxLat】
+  * @param {number} maxlength 是顶点可以与其前一个顶点相距的最大小数度数。默认0.0111
+  * @param {number} maxNum 最大数量
+  * @return {*}  要素数组
+  */
     static randomPolylines(box: any, maxlength?: number, maxNum?: number): any[];
+    /**
+  * @description: 随机点，随机节点数 最小3最大10
+  * @param {FeatureCollection <Point>} box   生成四角范围【minLng,minLat,maxLng,maxLat】
+  * @param {number} maxNum 最大数量
+  * @return {*}  要素数组
+  */
     static randomPoints(box: any, maxNum?: number): any[];
+    /**
+  * @description: 计算多边形面积
+  * @param {Feature<Geometry>} polygon
+  * @return {*}  计算后结果
+  */
     static formatArea(polygon: any): any;
+    /**
+  * @description: 转化范围4326to3857
+  * @param {Extent} box
+  * @return {*}  计算后结果
+  */
     static transTo3857(box: any): olExtent.Extent;
+    /**
+  * @description: 取区域内的随机点，默认在中国范围内
+  * @param {Extent} box
+  * @return {*}  计算后结果
+  */
     static randomLatLng(box: any): {
         lnglat: number[];
         box: olExtent.Extent;
     };
+    /**
+  * @description: 最短路径
+  * @param {Feature<Geometry>} startPoint
+  * @param {Feature<Geometry>} endPoint
+  * @param {*} options?: {
+      obstacles?: Feature<Geometry>[];障碍面
+      minDistance?: number;最短路径与障碍物之间的最小距离
+      units?: string; 分辨率和最小距离将以表示的单位；可以是度、弧度、英里、公里
+      resolution?: number;计算路径的矩阵点之间的距离
+    }
+  * @return {Feature<Geometry>}  计算后结果line
+  */
     static shortestPath(startPoint: Feature<Geometry>, endPoint: Feature<Geometry>, options?: {
         obstacles?: Feature<Geometry>[];
         minDistance?: number;
         units?: string;
         resolution?: number;
     }): Feature<Geometry>;
+    /**
+    * @description: 多线段合并成单线段
+    * @param {Feature<Geometry>[]} Features
+    * @param {number} distance  指定长度 默认1 单位km
+    * @return {Feature<Geometry>}  计算后结果line
+    */
     static lineMerger(Features: Feature<Geometry>[], distance?: number): {
         line: Feature<Geometry>;
         nodeData: any[];
         coordinates: any[];
     };
-    static along(coord: any, distance: any): any[];
-    static lineAttr(coords: any): any[];
+    /**
+    * @description: 按线坐标指定长度返回数组
+    * @param {Feature<Geometry>[]} 线的坐标点
+    * @param {number} distance  指定长度 默认1 单位km
+    * @return {Feature<Geometry>[]}  点数组
+    */
+    private static along;
+    /**
+    * @description: 线坐标分段距离
+    * @param {Feature<Geometry>[]} coords 线的坐标点
+    * @param {number} distance  指定长度 默认1 单位km
+    * @return {Feature<Geometry>[]}  点数组
+    */
+    private static lineAttr;
     static movePointContain(geoMarkerCircle: any, attr: any): {
         coordIndex: number;
         distance: number;
@@ -128,72 +235,163 @@ export declare class SpatialAnalysis {
     static arrayDup(arr: any): any[];
     /**
   
-   * 对传入的路径集合 进行去重并分段添加虚拟点处理后返回
+   * @description: 对传入的路径集合 进行去重并分段添加虚拟点处理后返回
    * @param {*} path
    * @param {*} segmentLength
    * @returns
    */
     static decoratePath(path: any, segmentLength: any): any;
     /**
-    * 线分割，按起始点分割线段
+    * @description:线分割，按起始点分割线段
     * @param {*} path
     * @param {*} segmentLength
     * @returns
     */
     static lineSlice(_startPoint: Feature<Geometry>, _stopPoint: Feature<Geometry>, _line: Feature<Geometry>): Feature<Geometry>;
     /**
-  * 判断点是否在线上
-  * @param {*} _point
-  * @param {*} _line
-  * @returns
-  */
+    * @description:判断点是否在线上
+    * @param {*} _point
+    * @param {*} _line
+    * @returns
+    */
     static booleanPointOnLine(_point: Feature<Geometry>, _line: Feature<Geometry>): boolean;
     /**
-    * 判断线线是否相交
+    * @description:判断线线是否相交
     * @param {*} _line1
     * @param {*} _line2
     * @returns
     */
     static booleanCrosses(_line1: Feature<Geometry>, _line2: Feature<Geometry>): boolean;
     /**
-  * 获取任何LineString或PolygonGeoJSON，并返回相交点
-  * @param {*} _line1
-  * @param {*} _line2
-  * @returns
-  */
+    * @description:获取任何LineString或PolygonGeoJSON，并返回相交点
+    * @param {*} _line1
+    * @param {*} _line2
+    * @returns
+    */
     static lineIntersect(_line1: Feature<Geometry>, _line2: Feature<Geometry>): Feature<Geometry>[];
+    /**
+    * @description:通过另一个Feature分割一个LineString。
+    * @param {*} _line1
+    * @param {*} _feature
+    * @returns {Feature<Geometry>[]} 分割后的要素集合
+    */
     static lineSplit(_line1: Feature<Geometry>, _feature: Feature<Geometry>): Feature<Geometry>;
     /**
-  *  线线是否相交打断
-  * @param {*} _line1
-  * @param {*} _line2
-  * @returns
-  */
+    * @description:线线是否相交打断
+    * @param {layer} layer GraphicLayer 图层
+    * @param {Array<Feature<Geometry>>} lineList  线数组
+    * @param {Function} callback 回调函数 返回 Feature, 及原properties
+    * @returns 不返回值 通过回调函数获取打断后数据
+    */
     static lineCrossesSplit(layer: GraphicLayer, lineList: Array<Feature<Geometry>>, callback: Function): void;
+    /**
+    * @description:擦除线
+    * @param {layer} layer GraphicLayer 图层
+    * @param {number[]} coordinate  擦除点位置
+    * @param {number} bufferExtent  点缓冲大小，以中心点辐射一个圆形，单位km
+    * @param {Array<Feature<Geometry>>} lineList  线数组
+    * @param {Function} callback 回调函数 返回 Feature, 及原properties
+    * @returns 不返回值 通过回调函数获取打断后数据
+    */
     static lineErase(layer: GraphicLayer, coordinate: number[], bufferExtent: number, lineList: Array<Feature<Geometry>>, callback: Function): void;
     /**
-  *  转为geoJson格式
-  * @param {Feature<Geometry>} Feature
-  * @returns
-  */
+    * @description 转为geoJson格式，不改变坐标系
+    * @param {Feature<Geometry>} Feature
+    * @returns
+    */
     static featureToJson(Feature: Feature<Geometry>): import("geojson").Feature<import("geojson").Geometry, {
         [name: string]: any;
     }>;
     /**
-  *  转为geoJson格式
-  * @param {Feature<Geometry>} Feature
-  * @return {GeoJSONFeature} "EPSG:4326" Object.
-  */
+    * @description:转为geoJson格式，元数据为3857转为4326
+    * @param {Feature<Geometry>} Feature
+    * @return {GeoJSONFeature} "EPSG:4326" Object.
+    */
     static featureTo4326(Feature: Feature<Geometry>): any;
     /**
-  *  转为geoJson数组格式
-  * @param {Feature<Geometry>[]} Feature
-  * @return {GeoJSONFeature} "EPSG:4326" Object.
-  */
+    * @description 转为geoJson数组格式，适用于数组转换
+    * @param {Feature<Geometry>[]} Feature
+    * @return {GeoJSONFeature} "EPSG:4326" Object.
+    */
     static featuresTo4326(Feature: Feature<Geometry>[]): import("geojson").FeatureCollection<import("geojson").Geometry, {
         [name: string]: any;
     }>;
+    /**
+  * @description 获取中心点坐标
+  * @param {Feature<Geometry>[]} Feature
+  * @return {Coordinate} "EPSG:4326" Object.
+  */
     static getCenter(feature: Feature<Geometry> | Geometry): import("ol/coordinate").Coordinate;
+    /**
+  * @description 转为geoJson数组格式，4326转3857
+  * @param {Feature<Geometry>[]} Feature
+  * @return {GeoJSONFeature} "EPSG:4326" Object.
+  */
     static to3857(Feature: any): Feature<Geometry>;
+    /**
+  * @description 转为geoJson数组格式，适用于数组转换
+  * @param {Feature<Geometry>[]} Feature
+  * @return {GeoJSONFeature} "EPSG:4326" Object.
+  */
     static to3857_featureList(Features: any): Feature<Geometry>[];
+    static lineClipPolygon(clipLine: Feature<Geometry>, polygonList: Feature<Geometry>[], callback: Function, errCallback: Function): void;
+    /**
+         * geoJson数据处理模块(需要引入turf.js)
+         * 输入输出数据均为标准geoJson格式
+         */
+    static geoUtil: {
+        /**
+         * 合并多边形
+         */
+        unionPolygon: (polygons: any) => any;
+        /**
+         * 线分割面
+         * 面类型只能是polygon 但可以是环
+         * 注:线与多边形必须有两个交点
+         */
+        polygonClipByLine: (polygon: any, clipLine: any) => any;
+        _singlePolygonClip: (polyLine: any, clipLine: any) => turf.helpers.FeatureCollection<turf.helpers.Polygon, {
+            [name: string]: any;
+        }>;
+        _multiPolygonClip: (polyLine: any, clipLine: any) => turf.helpers.FeatureCollection<turf.helpers.Polygon, {
+            [name: string]: any;
+        }>;
+        /**
+         * 连接两条线
+         * 方法会将两条线段最近的一段直接连接
+         */
+        connectLine: (line1: any, line2: any) => turf.helpers.Feature<turf.helpers.LineString, {
+            [name: string]: any;
+        }>;
+        /**
+         * 判断点是否在线里面
+         * 注：线组成的坐标对比
+         */
+        isOnLine: (point: any, line: any) => boolean;
+        /**
+         * 获得两条线交点
+         */
+        getIntersectPoints: (line1: any, line2: any) => turf.helpers.FeatureCollection<turf.helpers.Point, {
+            [name: string]: any;
+        }>;
+        /**
+         * multiPolygon转polygons,不涉及属性
+         */
+        multiPolygon2polygons: (multiPolygon: any) => any[];
+        /**
+         * polygons转multiPolygon,不涉及属性，只输出属性为{}
+         * 考虑polygons中就存在多面的情况
+         */
+        polygons2MultiPolygon: (geoJson: any) => {
+            type: string;
+            features: {
+                geometry: {
+                    coordinates: any[];
+                    type: string;
+                };
+                type: string;
+                properties: {};
+            }[];
+        };
+    };
 }