@dullcat/ol-helper 0.0.1

package/dist/olHelper.d.ts

@@ -0,0 +1,74 @@
+import { default as olMap } from 'ol/Map';
+import { ViewOptions } from 'ol/View';
+import { default as VectorLayer } from 'ol/layer/Vector';
+import { default as VectorSource } from 'ol/source/Vector';
+import { default as olSelect, Options as OlSelectOptions, SelectEvent } from 'ol/interaction/Select';
+import { StyleLike } from 'ol/style/Style';
+import { default as Feature } from 'ol/Feature';
+import { default as Geometry } from 'ol/geom/Geometry';
+import { drawTypeEnum, HighlightInfoType, LayerHandlesObject, mapViewInfoType } from './type';
+import { Options as BaseVectorOptions } from 'ol/layer/BaseVector';
+import { default as Draw, DrawEvent, Options as DrawOptions } from 'ol/interaction/Draw.js';
+import { default as Modify, ModifyEvent, Options as ModifyOptions } from 'ol/interaction/Modify.js';
+export * from './presetConfig';
+export * from './presetStyle';
+export default class olHelper {
+    map: olMap;
+    layerHandles: Map<string, LayerHandlesObject>;
+    selectHandles: Map<string, olSelect>;
+    highLightLayer: VectorLayer<VectorSource<Geometry>>;
+    private highlightInfo;
+    constructor(target: string, viewOptions?: {});
+    /**
+     * 初始化地图
+     * @param target
+     * @param viewOptions
+     */
+    initMap(target: string, viewOptions?: ViewOptions): void;
+    refreshMap(): void;
+    setMapCenter(center: [number, number], zoom: number | null): void;
+    toWkt(wkt: string): void;
+    getLayerByName(name: string): import('ol/layer/Base').default | null;
+    getLayerByProperty(key: string, value: string): import('ol/layer/Base').default[];
+    createUniLayer(layerName: string, features?: Feature[], options?: BaseVectorOptions<VectorSource>): VectorLayer<VectorSource<Geometry>>;
+    wktTempRender(wkt: string | string[], properties?: object, style?: StyleLike): void;
+    /**
+     * @description: 创建图层
+     * @param layerName 图层名称
+     * @param update 更新函数
+     * @param options 选项,可以覆盖和融合没有预设的值
+     */
+    createUpdateLayer(layerName: string, update?: (_layer: VectorLayer<VectorSource>) => void, options?: BaseVectorOptions<VectorSource>): void;
+    updateLayerFromFeatures(newFeatures: Feature[], layer: VectorLayer<VectorSource>): void;
+    getMapInfo(options?: object): mapViewInfoType;
+    compareMapInfo(mapInfo1: mapViewInfoType, mapInfo2: mapViewInfoType): boolean;
+    private setHighlightFeature;
+    resetHighLightInfo(): void;
+    locateAndHighlight(highlightInfo: HighlightInfoType, wkt?: string): void;
+    locateFeature(f: Feature | Feature[]): void;
+    /**
+     * 自定义点击事件
+     * @param name 事件名称,用于管理事件
+     * @param options 可选选项
+     */
+    useSelect(name: string, options?: OlSelectOptions): {
+        remove: () => void;
+        setSelectMod: (mod: "click" | "multiSelect") => void;
+        getSelectMod: () => "click" | "multiSelect";
+        setEventFunc: (func: (event: SelectEvent) => void) => void;
+        selectInstance: olSelect;
+    };
+    setSelectActive(activeLayerNameArray?: string[], inactiveLayerNameArray?: string[]): void;
+    clearAllSelect(): void;
+    useDraw(type: drawTypeEnum, options?: Partial<DrawOptions>): {
+        drawInstance: Draw;
+        setEventFunc: (func: (event: DrawEvent) => void) => void;
+        remove: () => void;
+    };
+    useModify(options?: ModifyOptions): {
+        modifyInstance: Modify;
+        setEventFunc: (func: (event: ModifyEvent) => void) => void;
+        remove: () => void;
+    };
+    clearHighLightSource(): void;
+}

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@dullcat/ol-helper",
+  "version": "0.0.1",
+  "main": "./dist/ol-helper.es.js",
+  "types": "./dist/ol-helper.d.ts",
+  "homepage": "https://dullcat-c.github.io/ol-helper/",
+  "keywords": [
+    "openlayers",
+    "utils"
+  ],
+  "files": [
+    "dist"
+  ],
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DullCat-c/ol-helper"
+  },
+  "scripts": {
+    "prepare": "husky",
+    "docs:dev": "vitepress dev docs",
+    "type:check": "vue-tsc --noEmit --skipLibCheck",
+    "lint:eslint": "eslint . --fix",
+    "lint:prettier": "prettier --write  \"*.{js,json,tsx,css,less,scss,vue,html,md}\"",
+    "lint:stylelint": "stylelint --cache --fix \"**/*.{vue,less,postcss,css,scss}\" --cache --cache-location node_modules/.cache/stylelint/",
+    "lint:lint-staged": "lint-staged",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs",
+    "build": "vite build"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/ol-helper.es.js",
+      "require": "./dist/ol-helper.umd.cjs",
+      "types": "./dist/ol-helper.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "lint-staged": {
+    "*.{html,ts,js,json,jsx,tsx}": [
+      "eslint --fix",
+      "prettier --write",
+      "stylelint --fix"
+    ],
+    "*.{js,ts,jsx,tsx,json,mjs}": [
+      "eslint --fix"
+    ]
+  },
+  "author": "John Tsai",
+  "license": "MIT",
+  "description": "",
+  "devDependencies": {
+    "@codemirror/commands": "^6.10.1",
+    "@codemirror/lang-json": "^6.0.2",
+    "@codemirror/language": "^6.12.1",
+    "@codemirror/lint": "^6.9.2",
+    "@commitlint/cli": "^20.2.0",
+    "@commitlint/config-conventional": "^20.2.0",
+    "@eslint/js": "^9.39.1",
+    "@types/node": "^18.19.70",
+    "@unocss/preset-attributify": "^66.3.3",
+    "@unocss/preset-icons": "^66.3.3",
+    "@unocss/preset-wind4": "^66.3.3",
+    "@vitejs/plugin-vue": "^3.2.0",
+    "eslint": "^9.39.1",
+    "eslint-plugin-vue": "^10.6.2",
+    "globals": "^16.5.0",
+    "husky": "^9.1.7",
+    "jiti": "^2.6.1",
+    "lint-staged": "^16.2.7",
+    "postcss-html": "^1.8.0",
+    "prettier": "^3.4.2",
+    "stylelint": "^16.26.1",
+    "stylelint-config-standard": "^39.0.1",
+    "stylelint-order": "^7.0.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.48.0",
+    "unocss": "^66.3.3",
+    "unplugin-auto-import": "^0.14.4",
+    "unplugin-vue-components": "^0.22.12",
+    "vite": "^3.2.11",
+    "vite-plugin-compression": "^0.5.1",
+    "vite-plugin-dts": "^4.5.4",
+    "vitepress": "2.0.0-alpha.13",
+    "vue-codemirror": "^6.1.1",
+    "vue-tsc": "^3.1.8"
+  },
+  "dependencies": {
+    "element-plus": "^2.13.0",
+    "ol": "^7.5.2",
+    "vue": "^3.5.24"
+  },
+  "engines": {
+    "node": ">21"
+  }
+}