@tianditu/core 0.1.0

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@tianditu/core",
+  "version": "0.1.0",
+  "description": "Headless core for tianditu — idempotent SDK loader, map session, and lifecycle orchestration shared by every framework adapter, with a component definition layer for Vue and Web Components",
+  "keywords": [
+    "core",
+    "framework-agnostic",
+    "gis",
+    "headless",
+    "lbs",
+    "map",
+    "overlay",
+    "sdk-loader",
+    "tianditu",
+    "typescript"
+  ],
+  "homepage": "https://github.com/DemoMacro/tianditu#readme",
+  "bugs": {
+    "url": "https://github.com/DemoMacro/tianditu/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Demo Macro",
+    "email": "abc@imst.xyz",
+    "url": "https://www.demomacro.com/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DemoMacro/tianditu.git"
+  },
+  "files": [
+    "dist",
+    "types"
+  ],
+  "main": "dist/index.mjs",
+  "types": "dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./modular": {
+      "types": "./types/modular.d.ts"
+    }
+  },
+  "dependencies": {
+    "@vue/reactivity": "3.4.37"
+  },
+  "devDependencies": {},
+  "scripts": {
+    "build": "vp pack && node ./scripts/inject-types.mjs"
+  }
+}

package/types/base.d.ts

@@ -0,0 +1,97 @@
+export {};
+
+declare global {
+  namespace T {
+    class LngLat {
+      /**
+       * 根据给定经度和纬度创建地理位置坐标点
+       * @param lng 地理经度
+       * @param lat 地理纬度
+       */
+      constructor(lng: number, lat: number);
+      /** 经度 */
+      lng: number;
+      /** 纬度 */
+      lat: number;
+      /** 获取地理坐标点的经度 */
+      getLng(): number;
+      /** 获取地理坐标点的经度 */
+      getLat(): number;
+      /** 计算当前地理坐标点与给定坐标点之间的距离 */
+      distanceTo(lnglat: LngLat): number;
+      /** 判断坐标点是否相等，当且仅当两点的经度和纬度均相等时返回true */
+      equals(other: LngLat): boolean;
+    }
+
+    class LngLatBounds {
+      /**
+       * 根据给定的多个地理位置坐标点创建矩形
+       * @param sw 矩形区域的西南角
+       * @param ne 矩形区域的东北角
+       */
+      constructor(sw: LngLat, ne: LngLat);
+      /** 返回西南点坐标 */
+      getSouthWest(): LngLat;
+      /** 返回东北点坐标 */
+      getNorthEast(): LngLat;
+      /** 返回边界的中心点 */
+      getCenter(): LngLat;
+      /** 放大此矩形，使其包含给定的点 */
+      extend(lnglat: LngLat): LngLatBounds;
+      /** 如果点的地理坐标位于此矩形内或者传入的矩形区域完全包含于此矩形区域中，则返回true */
+      contains(lnglat: LngLat | LngLatBounds): boolean;
+      /** 如果矩形与给定边界相交则返回true */
+      intersects(other: LngLatBounds): boolean;
+    }
+
+    class Point {
+      /**
+       * 根据给定x和y坐标创建地图上的一个像素坐标点
+       * @param x 像素坐标中x坐标，x坐标向右增大
+       * @param y 像素坐标中y坐标，y坐标向下增大
+       */
+      constructor(x: number, y: number);
+      /** x坐标 */
+      x: number;
+      /** y坐标 */
+      y: number;
+      /** 判断坐标点是否相等，当且仅当两点的x坐标和y坐标均相等时返回true */
+      equals(point: Point): boolean;
+      /**获得当前点与给定点的距离 */
+      distanceTo(point: Point): number;
+    }
+
+    class LayerGroup {
+      /**
+       * 构建一个存储图层的容器。
+       * @param layers 叠加层数组
+       */
+      constructor(layers: Overlay[]);
+      /** 从容器中增加一个图层 */
+      addLayer(layer: Overlay): void;
+      /** 从容器中移除一个图层 */
+      removeLayer(layer: Overlay): void;
+      /** 判断图层是否在容器中 */
+      hasLayer(layer: Overlay): boolean;
+      /** 得到容器中的所有图层 */
+      getLayers(): Overlay[];
+      /** 清除容器中的所有图层 */
+      clearLayers(): void;
+      /**设置容器z-index值 */
+      setZIndex(): void;
+      /**通过ID获取其对应的图层 */
+      getLayer(id: string): Overlay;
+      /** 获取容器中存在图层的唯一ID */
+      getLayerId(layer: Overlay): string;
+    }
+
+    class MapType {
+      /** 创建TMapType对象实例 */
+      constructor(layers: TileLayer[], name: string);
+      /**	返回地图类型名称 */
+      getName(): string;
+      /** 返回地图类型对应的图层 */
+      getLayers(): MapType;
+    }
+  }
+}

package/types/control/control.d.ts

@@ -0,0 +1,55 @@
+export {};
+
+declare global {
+  namespace T {
+    /**
+     * 自定义控件基类
+     */
+    class Control {
+      static Zoom: typeof ControlZoom;
+      static Scale: typeof ControlScale;
+      static Copyright: typeof ControlCopyright;
+      static OverviewMap: typeof ControlOverviewMap;
+      static MapType: typeof ControlMapType;
+      /** 标绘工具条（官方命名 Control.militarySymbols，末段即为小写） */
+      static militarySymbols: typeof ControlMilitarySymbols;
+
+      constructor(opts?: ControlOptions);
+      /**
+       * 设置控件的位置。参数请参见ControlPosition常量。
+       * @param position "topleft" | "topright" | "bottomleft" | "bottomright"
+       */
+      setPosition(position: ControlPosition): void;
+      /** 返回控件的位置 */
+      getPosition(): ControlPosition;
+      /** 向地图上添加叠加物。当调用map.addControl时，API将调用此方法。自定义控件时需要实现此方法。自定义控件时需要将控件对应的HTML元素返回 */
+      onAdd(map: Map): void;
+      /** 移除控件，释放控件对象所占用的内存。自定义控件时需要实现此方法 */
+      onRemove(): void;
+      /** 返回控件所在的容器的标签 */
+      getContainer(): HTMLElement;
+      /** 显示控件 */
+      show(): void;
+      /** 隐藏控件 */
+      hide(): void;
+      /** 判断控件的可见性 */
+      isVisible(): boolean;
+      /** 设置控件停靠的偏移量 */
+      setOffset(offset: Point): void;
+      /** 返回控件停靠的偏移量 */
+      getOffset(): Point;
+      /** 对ControlOptions属性值赋值 */
+      setOptions(opt: ControlOptions): ControlOptions;
+    }
+
+    type ControlPosition = "topleft" | "topright" | "bottomleft" | "bottomright";
+
+    interface ControlOptions {
+      /**
+       * 控件的位置。参数请参见ControlPosition常量。
+       * "topleft" | "topright" | "bottomleft" | "bottomright"
+       */
+      position?: ControlPosition;
+    }
+  }
+}

package/types/control/copyright.d.ts

@@ -0,0 +1,30 @@
+export {};
+
+declare global {
+  namespace T {
+    /**
+     * 此类表示版权控件，您可以在地图上添加自己的版权信息。每一个版权信息需要包含如下内容：版权的唯一标识、版权内容和其适用的区域范围。
+     */
+    class ControlCopyright extends T.Control {
+      /** 创建一个版权控件 */
+      constructor(opts?: ControlCopyrightOptions);
+      /** 添加一个版权信息 */
+      addCopyright(copyright: ControlCopyrightOptions): void;
+      /** 移除版权信息 */
+      removeCopyright(copyright: ControlCopyrightOptions): void;
+      /** 获得单个版权信息 */
+      getCopyright(id: string): ControlCopyrightOptions;
+      /** 获得版权信息列表 */
+      getCopyrightCollection(): ControlCopyright[];
+    }
+
+    interface ControlCopyrightOptions extends T.ControlOptions {
+      /** 该版权信息的唯一标识符 */
+      id?: string;
+      /** 该版权的文本信息，用于显示在地图上，支持HTML内容 */
+      content?: string;
+      /** 该版权信息所适用的地理区域 */
+      bounds?: LngLatBounds;
+    }
+  }
+}

package/types/control/index.d.ts

@@ -0,0 +1,6 @@
+import "./control";
+import "./copyright";
+import "./mapType";
+import "./overviewMap";
+import "./scale";
+import "./zoom";

package/types/control/mapType.d.ts

@@ -0,0 +1,63 @@
+export {};
+
+declare global {
+  namespace T {
+    /**
+     * 负责切换地图类型的控件
+     */
+    class ControlMapType extends T.Control {
+      /**
+       * 创建地图类型控件，opts为可选参数。
+       * @param mapTypes 控件展示的地图类型，默认为普通图、卫星图、卫星加路网混合图。通过此属性可配置控件展示的地图类型。
+       */
+      constructor(opts?: ControlMapTypeOptions);
+    }
+
+    type TMapTypeControlOptions = ControlMapTypeOptions;
+
+    interface ControlMapTypeOptions extends T.ControlOptions {
+      /** 控件展示的地图类型，默认为普通图、卫星图、卫星加路网混合图 */
+      mapTypes?: ControlMapTypeOptionsMapType[];
+    }
+
+    /**
+     * ```
+     * [
+     *   {
+     *     title: "地图";
+     *     icon: "http://api.tianditu.gov.cn/v4.0/image/map/maptype/vector.png";
+     *     layer: TMAP_NORMAL_MAP;
+     *   },
+     *   {
+     *     title: "卫星";
+     *     icon: " http://api.tianditu.gov.cn/v4.0/image/map/maptype/satellite.png";
+     *     layer: TMAP_SATELLITE_MAP;
+     *   },
+     *   {
+     *     title: "卫星混合";
+     *     icon: "http://api.tianditu.gov.cn/v4.0/image/map/maptype/satellitepoi.png";
+     *     layer: TMAP_HYBRID_MAP;
+     *   },
+     *   {
+     *     title: "地形";
+     *     icon: " http://api.tianditu.gov.cn/v4.0/image/map/maptype/terrain.png";
+     *     layer: TMAP_TERRAIN_MAP;
+     *   },
+     *   {
+     *     title: "地形混合";
+     *     icon: " http://api.tianditu.gov.cn/v4.0/image/map/maptype/terrainpoi.png";
+     *     layer: TMAP_TERRAIN_HYBRID_MAP;
+     *   }
+     * ]
+     * ```
+     */
+    interface ControlMapTypeOptionsMapType {
+      /** 地图控件上所要显示的图层名称 */
+      title?: string;
+      /**  地图控件上所要显示的图层图标（默认图标大小80x80） */
+      icon?: string;
+      /** 地图类型对象，即MapType */
+      layer?: MapType;
+    }
+  }
+}

package/types/control/overviewMap.d.ts

@@ -0,0 +1,64 @@
+export {};
+
+declare global {
+  namespace T {
+    /**
+     * 鹰眼地图控件，用来显示一个鹰眼地图, 继承自Control基类，拥有基类的所有方法。
+     */
+    class ControlOverviewMap extends T.Control {
+      /** 创建一个鹰眼地图控件 */
+      constructor(opts?: ControlOverviewMapOptions);
+      /**
+       * 设置鹰眼地图的按钮图片，要同时设置鹰眼地图打开和关闭状态下的两张图片。
+       * @param imgOpen 鹰眼地图在打开状态下的按钮图片。
+       * @param imgClose 鹰眼地图在关闭状态下的按钮图片。
+       */
+      setButtonImage(imgOpen: string, imgClose: string): void;
+      /** 设置鹰眼地图和主地图之间空隙的背景颜色 */
+      setBorderColor(color: string): void;
+      /** 设置鹰眼地图上的矩形框边框颜色 */
+      setRectBorderColor(color: string): void;
+      /** 设置鹰眼地图上的矩形框背景颜色 */
+      setRectBackColor(color: string): void;
+      /** 切换鹰眼地图的开-合状态 */
+      changeView(): void;
+      /** 返回该鹰眼的视图是否被打开 */
+      isOpen(): boolean;
+      /** 返回该鹰眼的地图对象 */
+      getMiniMap(): Map;
+      /** 添加事件监听函数 */
+      addEventListener<E extends keyof ControlOverviewMapEvents>(
+        event: E,
+        handler: ControlOverviewMapEvents[E],
+      ): void;
+      /** 移除事件监听函数 */
+      removeEventListener<E extends keyof ControlOverviewMapEvents>(
+        event: E,
+        handler: ControlOverviewMapEvents[E],
+      ): void;
+    }
+
+    interface ControlOverviewMapOptions {
+      /** 控件的停靠位置 */
+      anchor?: T.ControlPosition;
+      /** 缩略地图控件的大小 */
+      size?: Point;
+      /** 缩略地图添加到地图后的开合状态，默认为关闭。true表示显示，false表示隐藏 */
+      isOpen?: boolean;
+    }
+
+    interface ControlOverviewMapEvents {
+      /** 鹰眼视图控件的开合状态变化时触发事件 */
+      viewchange(e: ControlOverviewMapEvent): void;
+    }
+
+    interface ControlOverviewMapEvent {
+      /** 事件类型 */
+      type: string;
+      /** 鹰眼地图控件对象 */
+      target: ControlOverviewMap;
+      /** 是否打开状态 */
+      isOpen: boolean;
+    }
+  }
+}

package/types/control/scale.d.ts

@@ -0,0 +1,17 @@
+export {};
+
+declare global {
+  namespace T {
+    /**
+     * 地图比例尺控件，用来实时的显示地图的当前比例尺。
+     */
+    class ControlScale extends T.Control {
+      /** 创建一个地图比例尺控件 */
+      constructor(opts?: ControlScaleOptions);
+      /** 设置设置比例尺控件的颜色 */
+      setColor(color: string): void;
+    }
+
+    type ControlScaleOptions = T.ControlOptions;
+  }
+}

package/types/control/zoom.d.ts

@@ -0,0 +1,24 @@
+export {};
+
+declare global {
+  namespace T {
+    /**
+     * 地图缩放控件，可以缩放和移动地图。
+     */
+    class ControlZoom extends T.Control {
+      /** 创建一个地图缩放控件 */
+      constructor(opts?: ControlZoomOptions);
+    }
+
+    interface ControlZoomOptions extends T.ControlOptions {
+      /** 放大层级按钮的文字显示。default:"+" */
+      zoomInText?: string;
+      /** 缩小层级按钮的文字显示。default:"-" */
+      zoomOutText?: string;
+      /** 放大层级按钮的标题显示。default:"放大" */
+      zoomInTitle?: string;
+      /** 缩小层级按钮的标题显示。default:"缩小" */
+      zoomOutTitle?: string;
+    }
+  }
+}

package/types/global.d.mts

@@ -0,0 +1,2 @@
+// 全局 SDK 类型声明聚合入口：以模块形式引出全部 declare global 声明。
+import "./index.d.ts";

package/types/index.d.ts

@@ -0,0 +1,19 @@
+import "./base";
+import "./control";
+import "./layer";
+import "./map";
+import "./militarySymbols";
+import "./mousetool";
+import "./overlay";
+import "./service";
+
+declare global {
+  interface Window {
+    T: typeof T;
+    TMAP_NORMAL_MAP: T.MapType;
+    TMAP_SATELLITE_MAP: T.MapType;
+    TMAP_HYBRID_MAP: T.MapType;
+    TMAP_TERRAIN_MAP: T.MapType;
+    TMAP_TERRAIN_HYBRID_MAP: T.MapType;
+  }
+}

package/types/layer/gridlineLayer.d.ts

@@ -0,0 +1,33 @@
+export {};
+
+declare global {
+  namespace T {
+    class GridlineLayer extends TileLayer {
+      constructor(opts?: GridlineLayerOptions);
+    }
+
+    interface GridlineLayerOptions {
+      /** 设置格网图层的网格大小，单位是像素。default:256 */
+      tileSize?: number;
+      /** 显示格网图层的最小层级。default:0 */
+      minZoom?: number;
+      /** 显示格网图层的最大层级。default:18 */
+      maxZoom?: number;
+      /** 设置格网图层的透明度。default:1 */
+      opacity?: number;
+      /** 设置格网图层边线的颜色、宽度、线样式。default:{width:1, style:'solid', color:'#999'} */
+      outlineSize?: {
+        width: number;
+        style: string;
+        color: string;
+      };
+      /** 设置格网图层文字的样式，图层文字表现网格的行号、列号、层级。default:{display:false, fontSize:'14', fontWeight:true, color:'black'} */
+      textSize?: {
+        display: boolean;
+        fontSize: string;
+        fontWeight: boolean;
+        color: string;
+      };
+    }
+  }
+}

package/types/layer/index.d.ts

@@ -0,0 +1,4 @@
+import "./gridlineLayer";
+import "./tdt";
+import "./tileLayer";
+import "./wms";

package/types/layer/tdt.d.ts

@@ -0,0 +1,14 @@
+export {};
+
+declare global {
+  namespace T {
+    class TileLayerTDT extends TileLayer {
+      constructor(url: string, opts?: TileLayerTDTOptions);
+    }
+
+    interface TileLayerTDTOptions extends TileLayerOptions {
+      /** 用来描述图层信息 */
+      attribution?: string;
+    }
+  }
+}

package/types/layer/tileLayer.d.ts

@@ -0,0 +1,78 @@
+export {};
+
+declare global {
+  namespace T {
+    namespace TileLayer {
+      class WMS extends TileLayerWMS {}
+      class TDT extends TileLayerTDT {}
+    }
+    class TileLayer {
+      // static WMS: typeof TileLayerWMS;
+      // static TDT: typeof TileLayerTDT;
+
+      /** 以指定的参数创建TileLayer对象,这个对象是在地图上叠加栅格地图的时候用到的 */
+      constructor(url: string, opts?: TileLayerOptions);
+      /** 改变图层的透明度 */
+      setOpacity(opacity: number): TileLayer;
+      /** 设置图层的叠放顺序 */
+      setZIndex(zIndex: number): TileLayer;
+      /** 重新加载所有添加到此 TileLayer 的可见瓦片 */
+      refresh(): TileLayer;
+      /** 更新图层的URL地址并重绘他们 */
+      setUrl(url: string): TileLayer;
+      /** 瓦片的标签容器 */
+      getContainer(): HTMLElement;
+      /** 添加事件监听函数 */
+      addEventListener<E extends keyof TileLayerEvents>(
+        event: E,
+        handler: TileLayerEvents[E],
+      ): void;
+      /** 移除事件监听函数 */
+      removeEventListener<E extends keyof TileLayerEvents>(
+        event: E,
+        handler: TileLayerEvents[E],
+      ): void;
+    }
+
+    interface TileLayerOptions {
+      /** 此图层的最低缩放级别。default:0 */
+      minZoom?: number;
+      /** 此图层的最高缩放级别 。default:18*/
+      maxZoom?: number;
+      /** 当没有瓦片时所显示的错误图片地址 */
+      errorTileUrl?: string;
+      /** 设置图层的透明度（0.0-1.0）。default:1.0 */
+      opacity?: number;
+      /** 图层的显示顺序 */
+      zIndex?: number;
+      /** 设置指定范围内显示瓦片 */
+      bounds?: LngLatBounds;
+    }
+
+    interface TileLayerEvents {
+      /** 当瓦片图层开始加载瓦片时触发 */
+      loading(e: Pick<TileLayerEvent, "type" | "target">): void;
+      /** 当瓦片图层加载完可见瓦片后触发 */
+      load(e: Pick<TileLayerEvent, "type" | "target">): void;
+      /** 瓦片请求和开始加载时触发 */
+      tileloadstart(e: TileLayerEvent): void;
+      /** 在加载瓦片时触发 */
+      tileload(e: TileLayerEvent): void;
+      /** 在瓦片被移除时触发（比如打开了unloadInvisibleTiles） */
+      tileunload(e: TileLayerEvent): void;
+      /** 瓦片错误时触发 */
+      tileerror(e: TileLayerEvent): void;
+    }
+
+    interface TileLayerEvent {
+      /** 事件类型 */
+      type: string;
+      /** 图层对象 */
+      target: TileLayer;
+      /** 像素坐标对象 */
+      coords: Point;
+      /** 瓦片图片 */
+      tile: HTMLImageElement;
+    }
+  }
+}

package/types/layer/wms.d.ts

@@ -0,0 +1,24 @@
+export {};
+
+declare global {
+  namespace T {
+    class TileLayerWMS extends TileLayer {
+      constructor(url: string, opts?: TileLayerWMSOptions);
+    }
+
+    interface TileLayerWMSOptions extends TileLayerOptions {
+      /** 用","分隔的多个图层列表 */
+      layers?: string;
+      /** 每个请求图层的用","分隔的描述样式 */
+      styles?: string;
+      /** 输出图像的类型。default:"image/jpeg" */
+      format?: string;
+      /** 输出图像背景是否透明。default:false */
+      transparent?: boolean;
+      /** 请求服务的版本。default:"1.1.1" */
+      version?: string;
+      /** 地图投影类型。default:"EPSG:900913" */
+      srs?: string;
+    }
+  }
+}