@tianditu/core 0.1.0

package/types/service/index.d.ts

@@ -0,0 +1,9 @@
+import "./administrativeDivision";
+import "./busLineSearch";
+import "./dataSources";
+import "./drivingRoute";
+import "./geocoder";
+import "./geolocation";
+import "./localCity";
+import "./localSearch";
+import "./transitRoute";

package/types/service/localCity.d.ts

@@ -0,0 +1,24 @@
+export {};
+
+declare global {
+  namespace T {
+    /** 此类用于获取用户所在的城市位置信息（根据用户 IP 自动定位到城市） */
+    class LocalCity {
+      /** 创建一个获取本地城市位置的实例 */
+      constructor();
+
+      /** 获取城市信息后调用回调，参数为 LocalCityResult */
+      location(callback: (result: LocalCityResult) => void): void;
+    }
+
+    /** LocalCity 的定位结果 */
+    interface LocalCityResult {
+      /** 城市所在中心点 */
+      lnglat: LngLat;
+      /** 展示当前城市的最佳地图级别（提供 map 实例时按地图大小调整） */
+      level: number;
+      /** 城市名称 */
+      cityName: string;
+    }
+  }
+}

package/types/service/localSearch.d.ts

@@ -0,0 +1,178 @@
+export {};
+
+declare global {
+  namespace T {
+    /**
+     * 检索类型："1" 普通搜索（含地铁公交）、"2" 不换乘公交、
+     * "3" 普通搜索、"4" 地铁检索、"7" 地址检索。
+     */
+    type QueryType = string;
+
+    class LocalSearch {
+      /** 创建一个搜索类实例用于位置检索、周边检索和范围检索 */
+      constructor(map: Map, opts: LocalSearchOptions);
+
+      /** 根据检索词发起检索 */
+      search(keyword: string, type: QueryType): void;
+      /** 根据范围和检索词发起范围检索 */
+      searchInBounds(keyword: string, bounds: LngLatBounds): void;
+      /** 根据中心点、半径与检索词发起周边检索 */
+      searchNearby(keyword: string, center: LngLat, radius: number): void;
+      /** 返回最近一次检索的结果 */
+      getResults(): LocalSearchResult;
+      /** 清除最近一次检索的结果 */
+      clearResults(): void;
+      /** 检索特定页面的结果 */
+      gotoPage(page: number): void;
+      /**
+       * 设置检索范围
+       * @param code 行政区的国标码
+       */
+      setSpecifyAdminCode(code: number): void;
+      /** 设置搜索类型 */
+      setQueryType(type: LocalSearchResult["resultType"]): void;
+      /** 返回搜索类型 */
+      getQueryType(): LocalSearchResult["resultType"];
+      /** 设置每页容量 */
+      setPageCapacity(count: number): void;
+      /** 返回每页容量 */
+      getPageCapacity(): number;
+      /** 设置检索结束后的回调函数 */
+      setSearchCompleteCallback(fn: LocalSearchOptions["onSearchComplete"]): void;
+      /** 检索第一页 */
+      firstPage(): void;
+      /** 检索下一页 */
+      nextPage(): void;
+      /** 检索上一页 */
+      prevPage(): void;
+      /** 检索上一页 */
+      lastPage(): void;
+      /** 返回总记录数 */
+      getCountNumber(): number;
+      /** 返回总记录数 */
+      getCountPage(): number;
+      /** 返回当前页 */
+      getPageIndex(): number;
+    }
+
+    interface LocalSearchOptions {
+      /** 每页容量 */
+      pageCapacity?: number;
+      /** 检索结束后的回调函数 */
+      onSearchComplete?: (result: LocalSearchResult) => void;
+    }
+
+    interface LocalSearchResult {
+      /** 搜索类型。1表示普通搜索;2表示视野内搜索;4表示普通建议词搜索;5表示公交规划建议词搜索;7表示纯地名搜索(不搜公交线);10表示拉框搜索 */
+      resultType: number | string;
+      count: number | string;
+      KeyWord: string;
+      pois: LocalSearchPoi[] | false;
+      statistics: LocalSearchStatistics | false;
+      area: LocalSearchArea | false;
+      suggests: LocalSearchSuggest[] | false;
+      prompt: LocalSearchPrompt[] | false;
+      lineData: LocalSearchLineData[] | false;
+      /** 返回搜索类型 */
+      getResultType(): QueryType;
+      /** 返回检索总条数 */
+      getCount(): number;
+      /** 返回检索关键词 */
+      getKeyword(): number;
+      /** 返回点信息，当getResultType值为1时返回 */
+      getPois(): LocalSearchPoi[];
+      /** 返回统计信息，当getResultType值为2时返回 */
+      getStatistics(): LocalSearchStatistics;
+      /** 返回行政区省信息，当getResultType值为3时返回 */
+      getArea(): LocalSearchArea;
+      /** 返回建议词信息，当getResultType值为4时返回 */
+      getSuggests(): LocalSearchSuggest[];
+      /** 返回提示信息 */
+      getPrompt(): LocalSearchPrompt;
+      /** 返回线路信息，当getResultType值为5时返回 */
+      getLineData(): LocalSearchLineData[];
+    }
+
+    /** 点信息 */
+    interface LocalSearchPoi {
+      /** 电话 */
+      phone: string;
+      /** 坐标 */
+      lonlat: string;
+      /** 地址 */
+      address: string;
+      /** Poi点名称 */
+      name: string;
+      /** poi类型（102表示公交站，普通poi该参数可以不返回） */
+      poiType: string;
+    }
+
+    /** 统计信息 */
+    interface LocalSearchStatistics {
+      /** 推荐显示城市 */
+      priorityCitys: LocalSearchAdmin[];
+      /** 搜索的关键字 */
+      keyword: string;
+      /** 搜索的国家数量 */
+      countryCount: number;
+      /** 搜索的城市数量 */
+      citysCount: number;
+      /** 搜索的省份数量 */
+      provinceCount: number;
+      allAdmins: (LocalSearchAdmin & { childAdmins: LocalSearchAdmin[] })[];
+    }
+
+    /** 行政区省信息 */
+    interface LocalSearchArea {
+      /** 显示级别 */
+      level: string;
+      /** 定位中心点坐标 */
+      lonlat: string;
+      /** 名称 */
+      name: string;
+      /** 行政区边界坐标 */
+      points: { region: string }[];
+      /** 1表示正常区域，2表示特殊区域 */
+      type: string;
+    }
+
+    /** 建议词信息 */
+    interface LocalSearchSuggest {
+      /** 地址 */
+      address: string;
+      /** 名称 */
+      name: string;
+      /** 国标码 */
+      gbCode: string;
+    }
+
+    /** 提示信息 */
+    interface LocalSearchPrompt {
+      /** 关键字 */
+      keyword: string;
+      admins: LocalSearchAdmin[];
+      type: number;
+    }
+
+    /** 线路信息 */
+    interface LocalSearchLineData {
+      /** poi点的poi类型（poiType =102表示公交站，其它值表示普通poi） */
+      poiType: string;
+      /** 站数 */
+      stationNum: string;
+      /** 线路名称 */
+      name: string;
+      /** 线路的id */
+      uuid: string;
+    }
+
+    interface LocalSearchAdmin {
+      /** 统计数量 */
+      count: string;
+      /** 城市名称 */
+      name: string;
+      /** 城市国标码 */
+      adminCode: number;
+    }
+  }
+}

package/types/service/transitRoute.d.ts

@@ -0,0 +1,132 @@
+export {};
+
+declare global {
+  namespace T {
+    class TransitRoute {
+      /** 创建一个公交导航实例，用于获取公交路线规划方案*/
+      constructor(map: Map, opts: TransitRouteOptions);
+
+      /** 发起检索 */
+      search(start: LngLat, end: LngLat): void;
+      /** 返回最近一次检索的结果 */
+      getResults(): TransitRouteResult;
+      /** 清除最近一次检索的结果 */
+      clearResults(): void;
+      /** 设置路线规划策略，参数为策略常量 */
+      setPolicy(policy: TransitRouteOptions["policy"]): void;
+      /** 设置检索结束后的回调函数 */
+      setSearchCompleteCallback(fun: Function): void;
+      /** 返回状态码 */
+      getStatus(): TransitRouteResult["resultCode"];
+    }
+
+    interface TransitRouteOptions {
+      /**
+       * 公交导航的策略参数。
+       * TMAP_TRANSIT_POLICY_LEAST_TIME = 1表示最少时间
+       * TMAP_TRANSIT_POLICY_LEAST_TRANSFER = 2表示最少换乘
+       * TMAP_TRANSIT_POLICY_LEAST_WALKING = 4表示最少步行
+       * TMAP_TRANSIT_POLICY_AVOID_SUBWAYS = 8表示不乘地铁
+       */
+      policy: number;
+      /** 检索结束后的回调函数 */
+      onSearchComplete?: (result: TransitRouteResult) => void;
+    }
+
+    interface TransitRouteResult {
+      /** 是否包含地铁 */
+      hasSubway: boolean;
+      /**
+       * 返回状态码。状态码如下：
+       * 0表示正常返回线路；
+       * 1表示找不到起点；
+       * 2表示找不到终点；
+       * 3表示规划不出线路；
+       * 4表示起终点距离200米以内，不返回线路；
+       * 5表示起终点距离500米内，返回线路；
+       * 6表示输入参数错误
+       */
+      resultCode: number;
+      results: {
+        lineType: TransitRouteOptions["policy"];
+        lines: {
+          /** 方案线路名称 */
+          lineName: string;
+          segments: {
+            segmentType: number;
+            segmentLine: SegmentLine;
+            stationStart: Station;
+            stationEnd: Station;
+          }[];
+        }[];
+      };
+      /** 返回方案个数 */
+      getNumPlans(): number;
+      /** 返回索引指定的方案。索引0表示第一条方案 */
+      getPlan(i: number): TransitRoutePlan;
+    }
+
+    interface TransitRoutePlan {
+      Distance: number;
+      Duration: number;
+      LineName: string;
+      LineType: number;
+      NumSegments: number;
+      /** 返回单个方案的详细信息段数 */
+      getNumSegments(): number;
+      /** 返回索引指定的详细信息。索引0表示第一条方案 */
+      getDetails(i: number): TransitRouteLine;
+      /** 返回方案描述文本 */
+      getLineName(): string[];
+      /** 返回方案总距离 */
+      getDistance(): number;
+      /** 返回方案总时间 */
+      getDuration(): number;
+      /** 返回公交导航的策略参数 */
+      getLineType(): number;
+    }
+
+    interface TransitRouteLine {
+      /**
+       * 返回线路类型
+       * 1表示步行；
+       * 2表示公交；
+       * 3表示地铁；
+       * 4表示地铁站内换乘
+       */
+      getSegmentType(): number;
+      /** 返回起站点信息 */
+      getStationStart(): Station;
+      /** 返回终站点信息 */
+      getStationEnd(): Station;
+      /** 返回线路内容 */
+      getSegmentLine(): SegmentLine;
+    }
+
+    interface Station {
+      /** 起终站点坐标 "lng,lat" */
+      lonlat: string;
+      /** 起终站点名称 */
+      name: string;
+      /** 起终站点id */
+      uuid: string;
+    }
+
+    type SegmentLine = {
+      /** 此段线路需要经过的站点数 */
+      segmentStationCount: number;
+      /** 此段线路需要的时间 */
+      segmentTime: number;
+      /** 此段线路的距离 */
+      segmentDistance: number;
+      /** 此段线路的完整线路名 */
+      direction: string;
+      /** 此段线路的坐标 "lng,lat;lng,lat;lng,lat" */
+      linePoint: string;
+      /** 线路名称 */
+      lineName: string;
+      /** 此段线路id */
+      byuuid: string;
+    }[];
+  }
+}