@tianditu/core 0.1.0

package/types/mousetool/polylineTool.d.ts

@@ -0,0 +1,47 @@
+export {};
+
+declare global {
+  namespace T {
+    class PolylineTool extends Mousetool<PolylineToolEvents> {
+      /** 折线工具，可以通过事件来获取用户绘制的折线，包含测距功能 */
+      constructor(map: Map, opts?: PolylineToolOptions);
+      /**
+       * 跟随鼠标移动的说明文字
+       * @param text 文字内容
+       */
+      setTips(text: string): void;
+      /**
+       * 计算一系列地理坐标点的距离总和
+       * @param points 点坐标LngLat数组
+       */
+      getDistance(points: LngLat[]): number;
+      /** 获取所有编辑完成的线 */
+      getPolylines(): Polyline[];
+      /** 完成一个折线的绘制，运行此方法相当于用户点击双击结束当前折线的绘制 */
+      endDraw(): void;
+    }
+
+    interface PolylineToolOptions extends PolylineOptions {
+      /** 是否显示距离，如果不显示距离，则可以作为画线控件使用。default:false */
+      showLabel?: boolean;
+    }
+
+    interface PolylineToolEvents {
+      /** 用户双击完成一次折线绘制时触发事件 */
+      draw(e: PolylineToolEvent): void;
+      /** 用户在多边形绘制过程中，每次点击底图添加节点时触发事件 */
+      addpoint(e: PolylineToolEvent): void;
+    }
+
+    interface PolylineToolEvent extends ToolEvent<Polyline> {
+      /** 用户当前绘制的折线的点坐标数组 */
+      currentLnglats: LngLat[];
+      /** 用户当前绘制的折线的地理长度 */
+      currentDistance: number;
+      /** 当前测距所画线的对象 */
+      currentPolyline: Polyline;
+      /** 返回所有工具绘制的线对象 */
+      allPolylines: Polyline[];
+    }
+  }
+}

package/types/mousetool/rectangleTool.d.ts

@@ -0,0 +1,28 @@
+export {};
+
+declare global {
+  namespace T {
+    class RectangleTool extends Mousetool<RectangleToolEvents> {
+      /** 矩形工具，用来实现在地图上选择一个矩形区域或绘制矩形的功能 */
+      constructor(map: Map, opts?: RectangleToolOptions);
+      /** 返回工具所有绘制的矩形 */
+      getRectangles(): Rectangle[];
+    }
+
+    type RectangleToolOptions = RectangleOptions;
+
+    interface RectangleToolEvents {
+      /** 用户每次完成拉框操作时触发事件 */
+      draw(e: RectangleToolEvent): void;
+    }
+
+    interface RectangleToolEvent extends ToolEvent<Rectangle> {
+      /** 用户拉框选择的地理范围 */
+      currentBounds: LngLat;
+      /** 用户绘制的矩形图形对象 */
+      currentRectangle: Rectangle;
+      /** 所有绘制的矩形对象 */
+      allRectangles: Rectangle[];
+    }
+  }
+}

package/types/overlay/circle.d.ts

@@ -0,0 +1,67 @@
+export {};
+
+declare global {
+  namespace T {
+    class Circle extends OverlayBase<CircleEvents> {
+      /**
+       * 创建圆覆盖物
+       * @param center 圆心经纬度坐标
+       * @param radius 圆的半径，以米点单位
+       */
+      constructor(center: LngLat, radius: number, opts?: CircleOptions);
+      /** 设置圆的中心点。 */
+      setCenter(lnglat: LngLat): void;
+      /** 返回圆的中心点。 */
+      getCenter(): LngLat;
+      /** 设置圆的半径。 */
+      setRadius(radius: number): void;
+      /** 返回圆的半径。 */
+      getRadius(): number;
+      /** 返回圆的地理区域范围 */
+      getBounds(): LngLatBounds;
+      /** 设置圆边线的颜色 */
+      setColor(color: string): void;
+      /** 返回圆边线的颜色 */
+      getColor(): string;
+      /** 设置圆边线的宽度 */
+      setWeight(weight: number): void;
+      /** 返回圆边线的宽度 */
+      getWeight(): number;
+      /** 设置圆边线是为实线或虚线 */
+      setLineStyle(style: PolylineOptions["lineStyle"]): void;
+      /** 返回当前圆边线样式状态，实线或者虚线 */
+      getLineStyle(): string;
+      /** 设置圆的填充颜色，参数为合法的CSS颜色值。当参数为空字符串时，圆覆盖物填充颜色与边线颜色相同 */
+      setFillColor(color: string): void;
+      /** 返回圆的填充颜色 */
+      getFillColor(): string;
+      /** 设置圆的填充透明度。当参数为0时，圆覆盖物将没有填充效果 */
+      setFillOpacity(opacity: number): void;
+      /** 返回圆的填充透明度 */
+      getFillOpacity(): number;
+      /** 启用圆编辑功能 */
+      enableEdit(): void;
+      /** 禁用圆编辑功能 */
+      disableEdit(): void;
+      /** 是否启用圆编辑功能，true表示启用，false表示禁止 */
+      isEditable(): boolean;
+    }
+
+    interface CircleOptions {
+      /** 圆边线颜色。default:"#0000FF" */
+      color?: string;
+      /** 圆边线的宽度，以像素为单位。default:3 */
+      weight?: number;
+      /** 圆边线的透明度（范围0-1 之间）。default:0.5 */
+      opacity?: number;
+      /** 圆填充颜色。当参数为空时，圆覆盖物将没有填充效果。default:"#0000FF" */
+      fillColor?: string;
+      /** 圆填充的透明度（范围0-1 之间）。default:0.2 */
+      fillOpacity?: number;
+      /** 圆边线的样式（solid或dashed）。default:"solid" */
+      lineStyle?: "solid" | "dashed";
+    }
+
+    type CircleEvents = OverlayEvents<Circle, LngLat>;
+  }
+}

package/types/overlay/cloudMarkerCollection.d.ts

@@ -0,0 +1,50 @@
+export {};
+
+declare global {
+  namespace T {
+    class CloudMarkerCollection extends OverlayBase<CloudMarkerCollectionEvents> {
+      constructor(lnglats: LngLat[], opts: CloudMarkerCollectionOptions);
+      setLnglats(lnglats: LngLat[]): void;
+      setStyles(styles: CloudMarkerCollectionOptions): void;
+      clear(): void;
+    }
+
+    interface CloudMarkerCollectionOptions {
+      /**
+       * 海量点的预设形状。
+       * CIRCLE 圆形(默认)；
+       * STAR 星形；
+       * SQUARE 方形；
+       * RHOMBUS 菱形；
+       * WATERDROP 滴状
+       */
+      ShapeType?: "CIRCLE" | "RHOMBUS" | "SQUARE" | "STAR" | "WATERDROP";
+      /**
+       * 海量点的预设尺寸。
+       * TINY 超小，宽高为2px * 2px；
+       * SMALLER 很小，宽高为4px * 4px；
+       * SMALL 小，宽高为8px * 8px；
+       * NORMAL 正常，宽高为10px * 10px(默认)；
+       * BIG 大，宽高为16px * 16px；
+       * BIGGER 很大，宽高为20px * 20px；
+       * HUGE 超大，宽高为30px * 30px
+       */
+      SizeType?: "TINY" | "SMALLER" | "SMALL" | "NORMAL" | "HUGE" | "BIGGER" | "BIG";
+      /**
+       * 海量点的颜色，默认为'#fa937e'。
+       * 同时支持颜色字符串，如'red'；
+       * 哈希字符串'#000000'；
+       * rgb字符串，如'rgb(0,0,0)’；
+       * rgba字符串，如'rgb(255,0,0,0.1)'；
+       * hsl字符串，如'hsl(0,100%,50%)'；
+       * hsla字符串，如'hsla(0,100%,50%,0.4)'
+       */
+      color?: string;
+    }
+
+    type CloudMarkerCollectionEvents = Pick<
+      OverlayEvents<CloudMarkerCollection, LngLat, Overlay>,
+      "click" | "mouseover" | "mouseout"
+    >;
+  }
+}

package/types/overlay/contextMenu.d.ts

@@ -0,0 +1,75 @@
+export {};
+
+declare global {
+  namespace T {
+    interface ContextMenuOptions {
+      /** 菜单宽度（像素） */
+      width?: number;
+    }
+
+    /**
+     * 右键菜单
+     */
+    class ContextMenu {
+      /**
+       * 创建一个右键菜单实例。
+       * SDK 实现不判空：无参调用会在内部读 options.width 报错，
+       * 调用时至少传入一个 options 对象。
+       */
+      constructor(options?: ContextMenuOptions);
+      /** 添加菜单项 */
+      addItem(item: MenuItem): void;
+      /** 返回指定索引位置的菜单项，第一个菜单项的索引为 0 */
+      getItem(index: number): MenuItem;
+      /** 移除菜单项 */
+      removeItem(item: MenuItem): void;
+      /** 添加分隔符 */
+      addSeparator(): void;
+      /** 移除指定索引位置的分隔符，第一个分隔符的索引为 0 */
+      removeSeparator(index: number): void;
+      /** 返回所有菜单项 */
+      getItems(): MenuItem[];
+      /** 返回所有分割线 */
+      getAllSeparator(): unknown[];
+      /** 添加事件监听函数 */
+      addEventListener<E extends keyof ContextMenuEvents>(
+        event: E,
+        handler: ContextMenuEvents[E],
+      ): void;
+      /** 移除事件监听函数 */
+      removeEventListener<E extends keyof ContextMenuEvents>(
+        event: E,
+        handler: ContextMenuEvents[E],
+      ): void;
+    }
+
+    /**
+     * 右键菜单项。菜单项被点击时，以菜单弹出时的地理坐标点为参数调用回调函数
+     */
+    class MenuItem {
+      constructor(text: string, callback: (lnglat: LngLat) => void);
+      /** 设置菜单项显示的文本 */
+      setText(text: string): void;
+      /** 启用菜单项 */
+      enable(): void;
+      /** 禁用菜单项 */
+      disable(): void;
+    }
+
+    interface ContextMenuEvent {
+      /** 事件类型 */
+      type: string;
+      /** 菜单对象 */
+      target: ContextMenu;
+      /** 菜单开启时的像素坐标点 */
+      point: Point;
+    }
+
+    interface ContextMenuEvents {
+      /** 右键菜单打开时触发 */
+      open(e: ContextMenuEvent): void;
+      /** 右键菜单关闭时触发 */
+      close(e: Pick<ContextMenuEvent, "type" | "target">): void;
+    }
+  }
+}

package/types/overlay/icon.d.ts

@@ -0,0 +1,33 @@
+export {};
+
+declare global {
+  namespace T {
+    class Icon {
+      /** 以给定的图像地址和大小创建图标对象实例 */
+      constructor(opts: IconOptions);
+      /** 设置图片资源的地址 */
+      setIconUrl(iconUrl: string): void;
+      /** 获取图标使用的图片URL */
+      getIconUrl(): string;
+      /** 设置图标可视区域的大小 */
+      setIconSize(size: Point): void;
+      /** 获取图标可视区域的大小 */
+      getIconSize(): Point;
+      /** 设置相对于图片左上角的像素距离 */
+      setIconAnchor(anchor: Point): void;
+      /** 获取相对于图片左上角的像素距离 */
+      getIconAnchor(): Point;
+
+      static Default(): Icon;
+    }
+
+    interface IconOptions {
+      /** 请求图标图片的URL（绝对或相对路径） */
+      iconUrl?: string;
+      /** 图标可视区域的大小。default:Point(25, 41) */
+      iconSize?: Point;
+      /** 图标的定位锚点。此点用来决定图标与地理位置的关系，是相对于图标左上角的偏移值，默认等于图标宽度和高度的中间值。default:Point(12, 41) */
+      iconAnchor?: Point;
+    }
+  }
+}

package/types/overlay/index.d.ts

@@ -0,0 +1,13 @@
+import "./circle";
+import "./cloudMarkerCollection";
+import "./contextMenu";
+import "./icon";
+import "./infowindow";
+import "./label";
+import "./marker";
+import "./markerClusterer";
+import "./overlay";
+import "./polygon";
+import "./polyline";
+import "./rectangle";
+import "./svg";

package/types/overlay/infowindow.d.ts

@@ -0,0 +1,59 @@
+export {};
+
+declare global {
+  namespace T {
+    class InfoWindow extends OverlayBase<InfoWindowEvents> {
+      /** 创建一个信息窗实例 */
+      constructor(content: string | HTMLElement, opts?: InfoWindowOptions);
+      /** 关闭信息浮窗 */
+      closeInfoWindow(): void;
+      /** 设置或改变信息浮窗所指向的地理位置坐标 */
+      setLngLat(lnglat: LngLat): void;
+      /** 返回信息浮窗所指向的地理位置坐标 */
+      getLngLat(): LngLat;
+      /** 返回信息窗口的打开状态 */
+      isOpen(): boolean;
+      /** 设置信息浮窗的显示 HTML 内容 */
+      setContent(content: string | HTMLElement): void;
+      /** 返回信息浮窗的显示 HTML 内容 */
+      getContent(): string | HTMLElement;
+      /** 重绘信息窗口，当信息窗口内容发生变化时进行调用 */
+      /** 设置信息浮窗显示时向右下角偏移量（像素） */
+      setOffset(offset: Point): void;
+      /** 返回信息浮窗显示时向右下角偏移量 */
+      getOffset(): Point;
+      /** 重绘信息窗口，当信息窗口内容发生变化时进行调用 */
+      update(): void;
+    }
+
+    interface InfoWindowOptions {
+      /** 弹出框的最小宽度。default:50 */
+      minWidth?: number;
+      /** 弹出框的最大宽度。default:300 */
+      maxWidth?: number;
+      /** 设置后，如果内容超过弹出窗口的给定高度则产生一个可以滚动的容器 */
+      maxHeight?: number;
+      /** 是否开启信息窗口打开时地图自动移动（默认关闭）。default:false */
+      autoPan?: boolean;
+      /** 控制弹出窗口中出现的关闭按钮。default:true */
+      closeButton?: boolean;
+      /** 弹出窗口位置的补偿值。在同一图层中打开弹出窗口时对于控制锚点比较有用。default:Point(0,7) */
+      offset?: Point;
+      /** 在地图视图自动平移产生后弹出窗口和地图视图之间的边缘。default:Point(5,5) */
+      autoPanPadding?: Point;
+      /** 是否开启点击地图关闭信息窗口（默认关闭）。default:false */
+      closeOnClick?: boolean;
+    }
+
+    interface InfoWindowEvents {
+      /** 信息窗口被关闭时触发此事件 */
+      close(e: Pick<InfoWindowEvent, "type" | "target" | "lnglat">): void;
+      /** 信息窗口被打开时触发此事件 */
+      open(e: Pick<InfoWindowEvent, "type" | "target" | "lnglat">): void;
+      /** 点击信息窗口的关闭按钮时触发此事件 */
+      clickclose(e: Pick<InfoWindowEvent, "type" | "target">): void;
+    }
+
+    type InfoWindowEvent = OverlayEvent<InfoWindow, LngLat>;
+  }
+}

package/types/overlay/label.d.ts

@@ -0,0 +1,53 @@
+export {};
+
+declare global {
+  namespace T {
+    class Label extends OverlayBase<LabelEvents> {
+      /** 根据给定参数对象创建文本标注 */
+      constructor(opts: LabelOptions);
+      /** 设置文本所在的地理位置坐标 */
+      setLngLat(lnglat: LngLat): void;
+      /** 返回文本所在的地理位置坐标 */
+      getLngLat(): LngLat;
+      /** 设置文本的内容 */
+      setLabel(content: string): void;
+      /** 返回文本的内容 */
+      getLabel(): string;
+      /** 设置文本的提示内容 */
+      setTitle(title: string): void;
+      /** 返回文本的提示内容 */
+      getTitle(): string;
+      /** 设置文本的文本内容字体大小 */
+      setFontSize(size: number): void;
+      /** 返回文本内容字体大小 */
+      getFontSize(): number;
+      /** 设置文本的文本的字体颜色 */
+      setFontColor(color: string): void;
+      /** 返回文本的字体颜色 */
+      getFontColor(): string;
+      /** 设置文本的背景色 */
+      setBackgroundColor(color: string): void;
+      /** 返回文本的背景色*/
+      getBackgroundColor(): string;
+      /** 设置文本的边框线宽 */
+      setBorderLine(width: number): void;
+      /** 返回文本的边框线宽 */
+      getBorderLine(): number;
+      /** 设置文本的边框颜色 */
+      setBorderColor(color: string): void;
+      /** 返回文本的边框颜色 */
+      getBorderColor(): string;
+    }
+
+    interface LabelOptions {
+      /** 文本标注的内容 */
+      text?: string;
+      /** 文本标注的位置偏移值。default:Point(0,0) */
+      offset?: Point;
+      /** 文本标注的地理位置。default:LngLat(0,0) */
+      position?: LngLat;
+    }
+
+    type LabelEvents = OverlayEvents<Label, LngLat>;
+  }
+}

package/types/overlay/marker.d.ts

@@ -0,0 +1,50 @@
+export {};
+
+declare global {
+  namespace T {
+    class Marker extends OverlayBase<MarkerEvents> {
+      /** 创建一个图像标注实例。lnglat参数指定了图像标注所在的地理位置 */
+      constructor(lnglat: LngLat, opts?: MarkerOptions);
+      /** 设置标注所在的地理位置坐标 */
+      setLngLat(lnglat: LngLat): void;
+      /** 返回标注所在的地理位置坐标 */
+      getLngLat(): LngLat;
+      /** 设置标注所用的图标对象 */
+      setIcon(icon: Icon): void;
+      /** 返回标记显示时所使用的图标对象 */
+      getIcon(): Icon;
+      /** 设置z-index */
+      setZIndexOffset(num: number): void;
+      /** 开启标注拖拽功能 */
+      enableDragging(): void;
+      /** 关闭标注拖拽功能 */
+      disableDragging(): void;
+    }
+
+    interface MarkerOptions {
+      /** 图标类用来表达注记。default:T.Icon.Default() */
+      icon?: Icon;
+      /** 决定注记是否可被鼠标或触摸拖动。default:false */
+      draggable?: boolean;
+      /** 默认情况下，注记图片的叠置顺序由纬度自动设置。如果你想将某一注记放置于其他之上可用这个选项，设置一个较大的值即可，比如1000（或是相反地设置一个较大的负值） */
+      title?: string;
+      /** 设置z-index。default:0 */
+      zIndexOffset?: number;
+      /** 设置透明度。default:1.0 */
+      opacity?: number;
+      /** 设置其他参数。 */
+      [index: string]: any;
+    }
+
+    interface MarkerEvents extends OverlayEvents<Marker, LngLat> {
+      dragstart(e: Pick<MarkerEvent, "type" | "target">): void;
+      drag(e: Pick<MarkerEvent, "type" | "target" | "lnglat">): void;
+      dragend(e: Pick<MarkerEvent, "type" | "target" | "lnglat">): void;
+    }
+
+    /** @deprecated 拼写笔误，请使用 {@linkcode MarkerEvents} */
+    type MakerEvents = MarkerEvents;
+
+    type MarkerEvent = OverlayEvent<Marker, LngLat>;
+  }
+}

package/types/overlay/markerClusterer.d.ts

@@ -0,0 +1,103 @@
+export {};
+
+declare global {
+  namespace T {
+    class MarkerClusterer extends OverlayBase<MarkerClustererEvents> {
+      /** 创建一个点聚合组件 */
+      constructor(map: Map, opts: MarkerClustererOptions);
+      /** 添加一个聚合的标记 */
+      addMarker(marker: Marker): void;
+      /** 添加要聚合的标记数组 */
+      addMarkers(markers: Marker[]): void;
+      /** 获取聚合的总数量 */
+      getClustersCount(): number;
+      /** 从地图上彻底清除所有的标记 */
+      clearMarkers(): number;
+      /** 获取网格大小 */
+      getGridSize(): number;
+      /** 获取所有的标记数组 */
+      getMarkers(): Marker[];
+      /** 获取聚合的最大缩放级别 */
+      getMaxZoom(): number;
+      /** 获取单个聚合的最小数量 */
+      getMinClusterSize(): number;
+      /** 获取聚合的样式风格集合 */
+      getStyles(): MarkerClustererStyle[];
+      /** 删除单个标记 */
+      removeMarker(marker: Marker): boolean;
+      /** 删除一组标记 */
+      removeMarkers(markers: Marker[]): boolean;
+      /** 设置网格大小 */
+      setGridSize(gridSize: number): void;
+      /** 设置聚合的最大缩放级别 */
+      setMaxZoom(maxZoom: number): void;
+      /** 设置聚合的样式风格集合 */
+      setStyles(styles: MarkerClustererStyle[]): void;
+    }
+
+    interface MarkerClustererOptions {
+      /** 要聚合的标注点数组 */
+      markers?: Marker[];
+      /** 聚合计算时网格的像素大小，默认60 */
+      girdSize?: number;
+      /** 最大的聚合级别，大于该级别就不进行聚合 */
+      maxZoom?: number;
+      /** 自定义聚合后的图标风格 */
+      styles?: MarkerClustererStyle[];
+    }
+
+    interface MarkerClustererEvents extends OverlayEvents<MarkerClusterer, LngLat, Marker> {
+      dragstart(e: Pick<MarkerClustererEvent, "type" | "target" | "layer">): void;
+      drag(e: Pick<MarkerClustererEvent, "type" | "target" | "lnglat" | "layer">): void;
+      dragend(e: Pick<MarkerClustererEvent, "type" | "target" | "lnglat" | "layer">): void;
+      clusterclick(e: MarkerClustererEvent): void;
+    }
+
+    type MarkerClustererEvent = OverlayEvent<MarkerClusterer, LngLat, Marker>;
+
+    /**
+     * ```
+     * [
+     *   {
+     *     url: "http://api.tianditu.gov.cn/img/map/cluster/heart30.png",
+     *     size: [30, 26], //图片大小
+     *     offset: new T.Point(-15, -13), //显示图片的偏移量
+     *     textColor: "#000000", //显示数字的颜色
+     *     textSize: 8, //显示文字的大小
+     *     range: [0, 50]
+     *   },
+     *   {
+     *     url: "http://api.tianditu.gov.cn/img/map/cluster/heart40.png",
+     *     size: [42, 36],
+     *     offset: new T.Point(-20, -17),
+     *     textColor: "#ff0000",
+     *     textSize: 10,
+     *     range: [50, 400]
+     *   },
+     *   {
+     *     url: "http://api.tianditu.gov.cn/img/map/cluster/heart50.png",
+     *     size: [52, 46],
+     *     soffset: new T.Point(-10, -22),
+     *     textColor: "white",
+     *     textSize: 12,
+     *     range: [400, 500]
+     *   }
+     * ];
+     * ```
+     */
+    interface MarkerClustererStyle {
+      /** 图片地址 */
+      url?: string;
+      /** 图片大小 */
+      size?: number[];
+      /** 显示图片的偏移量 */
+      offset?: Point;
+      /** 显示数字的颜色 */
+      textColor?: string;
+      /** 显示文字的大小 */
+      textSize?: number;
+      /** 显示图片的数字范围 */
+      range?: number[];
+    }
+  }
+}