Merge pull request #34091 from breeze9527/master

[amap-js-api-indoor-map] Added js-doc

types/amap-js-api-indoor-map/index.d.ts

@@ -17,17 +17,45 @@ declare namespace AMap {
             mouseout: MouseEvent<'mouseout'>;
         }
         type MouseEvent<N extends string> = Event<N, {
+            /**
+             * 店铺所属楼宇信息
+             */
             building_id: string;
+            /**
+             * 经纬度
+             */
             lnglat: LngLat;
+            /**
+             * 楼层
+             */
             floor: number;
+            /**
+             * 商店
+             */
             shop: Shop;
         }>;
         interface Options extends Layer.Options {
+            /**
+             * 图层叠加的顺序值
+             */
             zIndex?: number;
+            /**
+             * 图层的透明度
+             */
             opacity?: number;
+            /**
+             * 鼠标悬停到店铺面时的鼠标样式
+             */
             cursor?: string;
+            /**
+             * 是否隐藏楼层切换控件
+             */
             hideFloorBar?: boolean;
+            /**
+             * 是否持续显示
+             */
             alaysShow?: boolean;
+
             // internal
             visible?: boolean;
             featurezIndex?: number;
@@ -38,32 +66,80 @@ declare namespace AMap {
             autoLoadBuildingsInTile?: boolean;
         }
         interface FloorDetails {
+            /**
+             * 各楼层索引
+             */
             floor_indexs: number[];
+            /**
+             * 各楼层英文
+             */
             floor_nonas: string[];
+            /**
+             * 各楼层名字
+             */
             floor_names: string[];
         }
         type ShopCategory = 'public' | 'connection' | 'shop';
         interface Shop {
+            /**
+             * 店铺的id
+             */
             id: string;
+            /**
+             * 兴趣点ID
+             */
             poiId: string;
+            /**
+             * 店铺所属楼宇ID
+             */
             building_id: string;
+            /**
+             * 店铺名称
+             */
             name: string;
+            /**
+             * 店铺的经纬度
+             */
             lnglat: LngLat;
+            /**
+             * 分类
+             */
             category: ShopCategory;
         }
         interface Building {
+            /**
+             * 所属楼宇ID
+             */
             id: string;
+            /**
+             * 楼层名称
+             */
             name: string;
+            /**
+             * 楼层的经纬度
+             */
             lnglat: LngLat;
+            /**
+             * 所在楼层
+             */
             floor: number;
             floor_details: FloorDetails;
         }
         interface SearchSuccessResult {
+            /**
+             * 楼层的id
+             */
             id: string;
             status: 0;
+            /**
+             * 建筑信息
+             */
             building: Building;
         }
         interface SearchErrorResult {
+            /**
+             * 楼宇id
+             */
             id: string;
             status: 1;
             error: Error;
@@ -72,22 +148,52 @@ declare namespace AMap {
     }
 
     class IndoorMap extends Layer {
+        /**
+         * 室内地图
+         * @param options 选项
+         */
         constructor(options?: IndoorMap.Options);
+        /**
+         * 显示指定室内地图信息
+         * @param indoorId 建筑物ID
+         * @param callback 回调
+         */
         showIndoorMap(
             indoorId: string,
             callback?: (error: null | Error, result: IndoorMap.SearchResult) => void
         ): void;
+        /**
+         * 显示指定室内地图信息
+         * @param indoorId 建筑物ID
+         * @param floor 楼层
+         * @param callback 回调
+         */
         showIndoorMap(
             indoorId: string,
             floor?: number,
             callback?: (error: null | Error, result: IndoorMap.SearchResult) => void
         ): void;
+        /**
+         * 显示指定室内地图信息
+         * @param indoorId 建筑物ID
+         * @param floor 楼层
+         * @param shopId 商铺ID
+         * @param callback 回调
+         */
         showIndoorMap(
             indoorId: string,
             floor?: number,
             shopId?: string,
             callback?: (error: null | Error, result: IndoorMap.SearchResult) => void
         ): void;
+        /**
+         * 显示指定室内地图信息
+         * @param indoorId 建筑物ID
+         * @param floor 楼层
+         * @param shopId 商铺ID
+         * @param noMove 阻止移动
+         * @param callback 回调
+         */
         showIndoorMap(
             indoorId: string,
             floor?: number,
@@ -95,12 +201,35 @@ declare namespace AMap {
             noMove?: boolean,
             callback?: (error: null | Error, result: IndoorMap.SearchResult) => void
         ): void;
+        /**
+         * 显示指定的楼层
+         * @param floor 楼层
+         * @param noMove 禁止移动
+         */
         showFloor(floor: number, noMove?: boolean): false | undefined;
+        /**
+         * 显示楼层切换控件
+         */
         showFloorBar(): void;
+        /**
+         * 隐藏楼层切换控件
+         */
         hideFloorBar(): void;
+        /**
+         * 显示室内地图标注
+         */
         showLabels(): void;
+        /**
+         * 隐藏室内地图标注
+         */
         hideLabels(): void;
+        /**
+         * 获取处于被选中状态的室内地图的ID
+         */
         getSelectedBuildingId(): string | null;
+        /**
+         * 获取处于被选中状态的室内地图的一些基本信息
+         */
         getSelectedBuilding(): IndoorMap.Building | null;
 
         // internal