@ray-js/robot-map-sdk 0.0.14-beta.3 → 0.0.14-beta.5

package/dist/index.d.ts

@@ -1416,327 +1416,345 @@ export declare type MapApplicationInstance = {
 }
 
 /**
- * 地图事件回调接口
- *
- * 定义了地图组件的所有事件回调函数，用于处理地图的各种交互和状态变化。
- * 开发者可以通过传入这些回调函数来响应地图的各种事件。
- *
+ * @description.zh 地图事件回调接口
+ * @description.en Map event callbacks interface
+ * @description.zh 定义了地图组件的所有事件回调函数，用于处理地图的各种交互和状态变化。
+ * @description.en Defines all event callback functions for the map component to handle various interactions and state changes.
  */
 export declare interface MapCallbacks {
     /**
-     * 地图首次绘制完成回调
-     *
-     * 当地图首次加载并绘制完成后触发，通常用于移除Loading状态。
-     * 与 onMapDrawed 不同，此回调只在首次绘制时触发一次。
-     *
-     * @param mapState - 地图状态信息，包含地图ID、原点、尺寸等信息
+     * @description.zh 地图首次绘制完成回调
+     * @description.en Callback when the map is first drawn
+     * @description.zh 当地图首次加载并绘制完成后触发，通常用于移除Loading状态。与 onMapDrawed 不同，此回调只在首次绘制时触发一次。
+     * @description.en Triggered when the map is first loaded and drawn, usually used to remove the loading state. Unlike onMapDrawed, this callback is only triggered once on the first draw.
+     * @param.zh mapState - 地图状态信息，包含地图ID、原点、尺寸等信息
+     * @param.en mapState - Map state information including map ID, origin, dimensions, etc.
      */
     onMapFirstDrawed?: (mapState: MapState) => void;
     /**
-     * 地图绘制完成回调
-     *
-     * 当地图数据解析并绘制完成后触发。
-     *
-     * @param mapState - 地图状态信息，包含地图ID、原点、尺寸等信息
-     *
+     * @description.zh 地图绘制完成回调
+     * @description.en Callback when the map is drawn
+     * @description.zh 当地图数据解析并绘制完成后触发。
+     * @description.en Triggered when map data is parsed and drawn.
+     * @param.zh mapState - 地图状态信息，包含地图ID、原点、尺寸等信息
+     * @param.en mapState - Map state information including map ID, origin, dimensions, etc.
      */
     onMapDrawed?: (mapState: MapState) => void;
     /**
-     * 路径绘制完成回调
-     *
-     * 当机器人路径数据绘制完成后触发。
-     *
-     * @param pathState - 路径状态信息，包含路径ID、类型、机器人位置等
-     *
+     * @description.zh 路径绘制完成回调
+     * @description.en Callback when the path is drawn
+     * @description.zh 当机器人路径数据绘制完成后触发。
+     * @description.en Triggered when robot path data is drawn.
+     * @param.zh pathState - 路径状态信息，包含路径ID、类型、机器人位置等
+     * @param.en pathState - Path state information including path ID, type, robot position, etc.
      */
     onPathDrawed?: (pathState: PathState) => void;
     /**
-     * 房间信息绘制完成回调
-     *
-     * 当房间属性信息绘制完成后触发。
-     *
-     * @param rooms - 房间属性信息数组
-     *
+     * @description.zh 房间信息绘制完成回调
+     * @description.en Callback when room properties are drawn
+     * @description.zh 当房间属性信息绘制完成后触发。
+     * @description.en Triggered when room property information is drawn.
+     * @param.zh rooms - 房间属性信息数组
+     * @param.en rooms - Array of room property information
      */
     onRoomPropertiesDrawed?: (rooms: RoomProperty[]) => void;
     /**
-     * 点击房间回调
-     *
-     * 当用户点击地图上的房间区域时触发。
-     *
-     * @param room - 被点击的房间信息
-     *
+     * @description.zh 点击房间回调
+     * @description.en Callback when clicking on a room
+     * @description.zh 当用户点击地图上的房间区域时触发。
+     * @description.en Triggered when user clicks on a room area on the map.
+     * @param.zh room - 被点击的房间信息
+     * @param.en room - Clicked room information
      */
     onClickRoom?: (room: RoomData) => void;
     /**
-     * 点击房间信息回调
-     *
-     * 当用户点击房间的属性信息图标时触发。
-     *
-     * @param room - 被点击的房间信息
-     *
+     * @description.zh 点击房间信息回调
+     * @description.en Callback when clicking on room properties
+     * @description.zh 当用户点击房间的属性信息图标时触发。
+     * @description.en Triggered when user clicks on the room property information icon.
+     * @param.zh room - 被点击的房间信息
+     * @param.en room - Clicked room information
      */
     onClickRoomProperties?: (room: RoomData) => void;
     /**
-     * 点击禁扫区域删除按钮的回调
-     *
-     * 当用户点击禁扫区域删除按钮时触发。
-     *
-     * @param id - 被删除的禁扫区域ID
-     *
+     * @description.zh 点击禁扫区域删除按钮的回调
+     * @description.en Callback when clicking the delete button of forbidden sweep zone
+     * @description.zh 当用户点击禁扫区域删除按钮时触发。
+     * @description.en Triggered when user clicks the delete button of forbidden sweep zone.
+     * @param.zh id - 被删除的禁扫区域ID
+     * @param.en id - ID of the deleted forbidden sweep zone
      */
     onRemoveForbiddenSweepZone?: (id: string) => void;
     /**
-     * 点击禁拖区域删除按钮的回调
-     *
-     * 当用户点击禁拖区域删除按钮时触发。
-     *
-     * @param id - 被删除的禁拖区域ID
-     *
+     * @description.zh 点击禁拖区域删除按钮的回调
+     * @description.en Callback when clicking the delete button of forbidden mop zone
+     * @description.zh 当用户点击禁拖区域删除按钮时触发。
+     * @description.en Triggered when user clicks the delete button of forbidden mop zone.
+     * @param.zh id - 被删除的禁拖区域ID
+     * @param.en id - ID of the deleted forbidden mop zone
      */
     onRemoveForbiddenMopZone?: (id: string) => void;
     /**
-     * 点击清扫区域删除按钮的回调
-     *
-     * 当用户点击清扫区域删除按钮时触发。
-     *
-     * @param id - 被删除的清扫区域ID
-     *
+     * @description.zh 点击清扫区域删除按钮的回调
+     * @description.en Callback when clicking the delete button of clean zone
+     * @description.zh 当用户点击清扫区域删除按钮时触发。
+     * @description.en Triggered when user clicks the delete button of clean zone.
+     * @param.zh id - 被删除的清扫区域ID
+     * @param.en id - ID of the deleted clean zone
      */
     onRemoveCleanZone?: (id: string) => void;
     /**
-     * 点击虚拟墙删除按钮的回调
-     *
-     * 当用户点击虚拟墙删除按钮时触发。
-     *
-     * @param id - 被删除的虚拟墙ID
-     *
+     * @description.zh 点击虚拟墙删除按钮的回调
+     * @description.en Callback when clicking the delete button of virtual wall
+     * @description.zh 当用户点击虚拟墙删除按钮时触发。
+     * @description.en Triggered when user clicks the delete button of virtual wall.
+     * @param.zh id - 被删除的虚拟墙ID
+     * @param.en id - ID of the deleted virtual wall
      */
     onRemoveVirtualWall?: (id: string) => void;
     /**
-     * 更新禁扫区域的回调
-     *
-     * 当用户操作禁扫区域（如拖拽、缩放）后触发。
-     *
-     * @param zone - 更新后的禁扫区域数据
-     *
+     * @description.zh 更新禁扫区域的回调
+     * @description.en Callback when updating forbidden sweep zone
+     * @description.zh 当用户操作禁扫区域（如拖拽、缩放）后触发。
+     * @description.en Triggered when user operates forbidden sweep zone (such as dragging, scaling).
+     * @param.zh zone - 更新后的禁扫区域数据
+     * @param.en zone - Updated forbidden sweep zone data
      */
     onUpdateForbiddenSweepZone?: (zone: ZoneParam) => void;
     /**
-     * 更新禁拖区域的回调
-     *
-     * 当用户操作禁拖区域（如拖拽、缩放）后触发。
-     *
-     * @param zone - 更新后的禁拖区域数据
-     *
+     * @description.zh 更新禁拖区域的回调
+     * @description.en Callback when updating forbidden mop zone
+     * @description.zh 当用户操作禁拖区域（如拖拽、缩放）后触发。
+     * @description.en Triggered when user operates forbidden mop zone (such as dragging, scaling).
+     * @param.zh zone - 更新后的禁拖区域数据
+     * @param.en zone - Updated forbidden mop zone data
      */
     onUpdateForbiddenMopZone?: (zone: ZoneParam) => void;
     /**
-     * 更新清扫区域的回调
-     *
-     * 当用户操作清扫区域（如拖拽、缩放）后触发。
-     *
-     * @param zone - 更新后的清扫区域数据
-     *
+     * @description.zh 更新清扫区域的回调
+     * @description.en Callback when updating clean zone
+     * @description.zh 当用户操作清扫区域（如拖拽、缩放）后触发。
+     * @description.en Triggered when user operates clean zone (such as dragging, scaling).
+     * @param.zh zone - 更新后的清扫区域数据
+     * @param.en zone - Updated clean zone data
      */
     onUpdateCleanZone?: (zone: ZoneParam) => void;
     /**
-     * 更新虚拟墙的回调
-     *
-     * 当用户操作虚拟墙（如拖拽、旋转）后触发。
-     *
-     * @param wall - 更新后的虚拟墙数据
-     *
+     * @description.zh 更新虚拟墙的回调
+     * @description.en Callback when updating virtual wall
+     * @description.zh 当用户操作虚拟墙（如拖拽、旋转）后触发。
+     * @description.en Triggered when user operates virtual wall (such as dragging, rotating).
+     * @param.zh wall - 更新后的虚拟墙数据
+     * @param.en wall - Updated virtual wall data
      */
     onUpdateVirtualWall?: (wall: VirtualWallParam) => void;
     /**
-     * 更新定点清扫的回调
-     *
-     * 当用户操作定点清扫位置后触发。
-     *
-     * @param spot - 更新后的定点清扫数据
-     *
+     * @description.zh 更新定点清扫的回调
+     * @description.en Callback when updating spot clean
+     * @description.zh 当用户操作定点清扫位置后触发。
+     * @description.en Triggered when user operates spot clean position.
+     * @param.zh spot - 更新后的定点清扫数据
+     * @param.en spot - Updated spot clean data
      */
     onUpdateSpot?: (spot: SpotParam) => void;
     /**
-     * 更新途径点的回调
-     *
-     * 当用户操作途径点位置后触发。
-     *
-     * @param wayPoint - 更新后的途径点数据
-     *
+     * @description.zh 更新途经点的回调
+     * @description.en Callback when updating way point
+     * @description.zh 当用户操作途经点后触发。
+     * @description.en Triggered when user operates way point.
+     * @param.zh wayPoint - 更新后的途经点数据
+     * @param.en wayPoint - Updated way point data
      */
     onUpdateWayPoint?: (wayPoint: WayPointParam) => void;
     /**
-     * 点击途径点的回调
-     *
-     * 当用户点击途径点时触发。
-     *
-     * @param wayPoint - 被点击的途径点数据
-     *
+     * @description.zh 点击途经点回调
+     * @description.en Callback when clicking way point
+     * @description.zh 当用户点击途经点时触发。
+     * @description.en Triggered when user clicks way point.
+     * @param.zh wayPoint - 被点击的途经点数据
+     * @param.en wayPoint - Clicked way point data
      */
     onClickWayPoint?: (wayPoint: WayPointParam) => void;
     /**
-     * 点击禁扫区域回调
-     *
-     * 当用户点击禁扫区域时触发。
-     *
-     * @param zone - 被点击的禁扫区域数据
-     *
+     * @description.zh 点击禁扫区域回调
+     * @description.en Callback when clicking forbidden sweep zone
+     * @description.zh 当用户点击禁扫区域时触发。
+     * @description.en Triggered when user clicks forbidden sweep zone.
+     * @param.zh zone - 被点击的禁扫区域数据
+     * @param.en zone - Clicked forbidden sweep zone data
      */
     onClickForbiddenSweepZone?: (zone: ZoneParam) => void;
     /**
-     * 点击禁拖区域回调
-     *
-     * 当用户点击禁拖区域时触发。
-     *
-     * @param zone - 被点击的禁拖区域数据
-     *
+     * @description.zh 点击禁拖区域回调
+     * @description.en Callback when clicking forbidden mop zone
+     * @description.zh 当用户点击禁拖区域时触发。
+     * @description.en Triggered when user clicks forbidden mop zone.
+     * @param.zh zone - 被点击的禁拖区域数据
+     * @param.en zone - Clicked forbidden mop zone data
      */
     onClickForbiddenMopZone?: (zone: ZoneParam) => void;
     /**
-     * 点击清扫区域回调
-     *
-     * 当用户点击清扫区域时触发。
-     *
-     * @param zone - 被点击的清扫区域数据
-     *
+     * @description.zh 点击清扫区域回调
+     * @description.en Callback when clicking clean zone
+     * @description.zh 当用户点击清扫区域时触发。
+     * @description.en Triggered when user clicks clean zone.
+     * @param.zh zone - 被点击的清扫区域数据
+     * @param.en zone - Clicked clean zone data
      */
     onClickCleanZone?: (zone: ZoneParam) => void;
     /**
-     * 点击虚拟墙回调
-     *
-     * 当用户点击虚拟墙时触发。
-     *
-     * @param wall - 被点击的虚拟墙数据
-     *
+     * @description.zh 点击虚拟墙回调
+     * @description.en Callback when clicking virtual wall
+     * @description.zh 当用户点击虚拟墙时触发。
+     * @description.en Triggered when user clicks virtual wall.
+     * @param.zh wall - 被点击的虚拟墙数据
+     * @param.en wall - Clicked virtual wall data
      */
     onClickVirtualWall?: (wall: VirtualWallParam) => void;
     /**
-     * 点击定点清扫回调
-     *
-     * 当用户点击定点清扫点时触发。
-     *
-     * @param spot - 被点击的定点清扫数据
-     *
+     * @description.zh 点击定点清扫回调
+     * @description.en Callback when clicking spot clean
+     * @description.zh 当用户点击定点清扫点时触发。
+     * @description.en Triggered when user clicks spot clean point.
+     * @param.zh spot - 被点击的定点清扫数据
+     * @param.en spot - Clicked spot clean data
      */
     onClickSpot?: (spot: SpotParam) => void;
     /**
-     * 点击检测物体回调
-     *
-     * 当用户点击地图上的检测物体时触发。
-     *
-     * @param object - 被点击的检测物体数据
-     *
+     * @description.zh 点击检测物体回调
+     * @description.en Callback when clicking detected object
+     * @description.zh 当用户点击地图上的检测物体时触发。
+     * @description.en Triggered when user clicks detected object on the map.
+     * @param.zh object - 被点击的检测物体数据
+     * @param.en object - Clicked detected object data
      */
     onClickDetectedObject?: (object: DetectedObjectParam) => void;
     /**
-     * 点击自定义元素回调
-     *
-     * 当用户点击自定义元素时触发。
-     *
-     * @param element - 被点击的自定义元素数据
-     *
+     * @description.zh 点击自定义元素回调
+     * @description.en Callback when clicking custom element
+     * @description.zh 当用户点击自定义元素时触发。
+     * @description.en Triggered when user clicks custom element.
+     * @param.zh element - 被点击的自定义元素数据
+     * @param.en element - Clicked custom element data
      */
     onClickCustomElement?: (element: CustomElementParam) => void;
     /**
-     * 更新分割线回调
-     *
-     * 当用户操作分割线（如拖拽端点、移动整条线）后触发。
-     *
-     * @param divider - 更新后的分割线数据
-     *
+     * @description.zh 更新分割线回调
+     * @description.en Callback when updating divider
+     * @description.zh 当用户操作分割线（如拖拽端点、移动整条线）后触发。
+     * @description.en Triggered when user operates divider (such as dragging endpoints, moving the entire line).
+     * @param.zh divider - 更新后的分割线数据
+     * @param.en divider - Updated divider data
      */
     onUpdateDivider?: (divider: Point[]) => void;
     /**
-     * 地图点击回调
-     *
-     * 当启用地图点击捕获（enableMapClickCapture）后，用户点击地图时触发。
-     * 返回点击位置的地图坐标（基于机器坐标系）。
-     *
-     * @param point - 点击位置的地图坐标
-     *
+     * @description.zh 点击地图回调
+     * @description.en Callback when clicking map
+     * @description.zh 当启用地图点击捕获（enableMapClickCapture）后，用户点击地图时触发。返回点击位置的地图坐标（基于机器坐标系）。
+     * @description.en Triggered when map click capture is enabled (enableMapClickCapture) and user clicks the map. Returns map coordinates of the click position (based on machine coordinate system).
+     * @param.zh point - 点击位置的地图坐标
+     * @param.en point - Map coordinates of the click position
      */
     onClickMap?: (point: Point) => void;
     /**
-     * 点击地毯回调
-     *
-     * 当用户点击地毯区域时触发（需要启用 carpet.enableEdit）。
-     *
-     * @param carpet - 被点击的地毯信息，包含索引和数据
-     *
+     * @description.zh 点击地毯回调
+     * @description.en Callback when clicking carpet
+     * @description.zh 当用户点击地毯区域时触发（需要启用 carpet.enableEdit）。
+     * @description.en Triggered when user clicks carpet area (requires carpet.enableEdit to be enabled).
+     * @param.zh carpet - 被点击的地毯信息
+     * @param.en carpet - Clicked carpet information
      */
     onClickCarpet?: (carpet: {
         id: string;
     }) => void;
     /**
-     * 删除地图地毯回调
-     *
-     * 当用户删除地图中的地毯时触发。
-     *
-     * @param carpet - 被删除的地毯信息
-     *
+     * @description.zh 删除地图地毯回调
+     * @description.en Callback when deleting map carpet
+     * @description.zh 当用户删除地图中的地毯时触发。
+     * @description.en Triggered when user deletes a carpet from the map.
+     * @param.zh carpet - 被删除的地毯信息
+     * @param.en carpet - Deleted carpet information
      */
     onDeleteCarpet?: (carpet: {
         id: string;
     }) => void;
     /**
-     * 删除自定义地毯回调
-     *
-     * 当用户删除自定义地毯时触发。
-     *
-     * @param carpet - 被删除的自定义地毯信息
-     *
+     * @description.zh 删除自定义地毯回调
+     * @description.en Callback when deleting custom carpet
+     * @description.zh 当用户删除自定义地毯时触发。
+     * @description.en Triggered when user deletes a custom carpet.
+     * @param.zh carpet - 被删除的自定义地毯信息
+     * @param.en carpet - Deleted custom carpet information
      */
     onDeleteCustomCarpet?: (carpet: {
         id: string;
     }) => void;
     /**
-     * 更新自定义地毯回调
-     *
-     * 当用户编辑自定义地毯（移动、旋转、缩放）后触发。
-     *
-     * @param carpet - 更新后的自定义地毯数据
-     *
+     * @description.zh 更新自定义地毯回调
+     * @description.en Callback when updating custom carpet
+     * @description.zh 当用户编辑自定义地毯（移动、旋转、缩放）后触发。
+     * @description.en Triggered when user edits custom carpet (move, rotate, scale).
+     * @param.zh carpet - 更新后的自定义地毯数据
+     * @param.en carpet - Updated custom carpet data
      */
     onUpdateCustomCarpet?: (carpet: CustomCarpetParam) => void;
     /**
-     * 点击家具删除按钮的回调
-     *
-     * @param id - 被删除的家具ID
+     * @description.zh 删除家具回调
+     * @description.en Callback when removing furniture
+     * @description.zh 当用户点击家具删除按钮时触发。
+     * @description.en Triggered when user clicks the delete button of furniture.
+     * @param.zh id - 被删除的家具ID
+     * @param.en id - ID of the removed furniture
      */
     onRemoveFurniture?: (id: string) => void;
     /**
-     * 更新家具的回调
-     *
-     * 当用户操作家具（如拖拽、缩放、旋转）后触发。
-     *
-     * @param furniture - 更新后的家具数据
+     * @description.zh 更新家具回调
+     * @description.en Callback when updating furniture
+     * @description.zh 当用户操作家具（如拖拽、缩放、旋转）后触发。
+     * @description.en Triggered when user operates furniture (such as dragging, scaling, rotating).
+     * @param.zh furniture - 更新后的家具数据
+     * @param.en furniture - Updated furniture data
      */
     onUpdateFurniture?: (furniture: FurnitureParam) => void;
     /**
-     * 点击家具回调
-     *
-     * @param furniture - 被点击的家具数据
+     * @description.zh 点击家具回调
+     * @description.en Callback when clicking furniture
+     * @description.zh 当用户点击家具时触发。
+     * @description.en Triggered when user clicks furniture.
+     * @param.zh furniture - 被点击的家具数据
+     * @param.en furniture - Clicked furniture data
      */
     onClickFurniture?: (furniture: FurnitureParam) => void;
+    /**
+     * @description.zh 手势开始回调
+     * @description.en Callback when gesture starts
+     * @description.zh 当用户开始与地图上的控制元素（如禁区、虚拟墙等）进行手势交互时触发。通常用于在小程序层动态切换组件显隐，避免 Native 组件干扰手势。
+     * @description.en Triggered when user starts gesture interaction with control elements on the map (such as forbidden zones, virtual walls, etc.). Usually used to dynamically toggle component visibility in the mini program layer to avoid native component interference with gestures.
+     */
     onGestureStart?: () => void;
     /**
-     * 手势交互结束回调
-     *
-     * 当用户结束手势交互时触发。
+     * @description.zh 手势结束回调
+     * @description.en Callback when gesture ends
+     * @description.zh 当用户结束手势交互时触发。
+     * @description.en Triggered when user ends gesture interaction.
      */
     onGestureEnd?: () => void;
     /**
-     * 点击机器人回调
-     *
-     * @param point - 机器人当前位置和朝向
+     * @description.zh 点击机器人回调
+     * @description.en Callback when clicking robot
+     * @description.zh 当用户点击机器人时触发。
+     * @description.en Triggered when user clicks robot.
+     * @param.zh point - 机器人当前位置和朝向
+     * @param.en point - Robot current position and orientation
      */
     onClickRobot?: (point: IconPoint) => void;
     /**
-     * 点击充电桩回调
-     *
-     * @param point - 充电桩当前位置和朝向
+     * @description.zh 点击充电桩回调
+     * @description.en Callback when clicking charging station
+     * @description.zh 当用户点击充电桩时触发。
+     * @description.en Triggered when user clicks charging station.
+     * @param.zh point - 充电桩当前位置和朝向
+     * @param.en point - Charging station current position and orientation
      */
     onClickChargingStation?: (point: IconPoint) => void;
 }