types: 为 Widgets 添加 Hook 暴露方法的注释

src/components/Map/Widgets/AffixFilter/src/types.ts

@@ -21,5 +21,10 @@ export interface AffixFilterProps extends BasicWidgetProps {
 }
 
 export interface AffixFilterInstance extends BasicWidgetInstance<AffixFilterProps> {
+    /**
+     * 设置选项
+     * @param key 选项标识
+     * @param item 选项可选 options
+     */
     setOptionItem: (key: string, item: OptionItem) => void
 }

src/components/Map/Widgets/BottomBar/src/types.ts

@@ -16,6 +16,13 @@ export interface BottomBarProps extends BasicWidgetProps {
 }
 
 export interface BottomBarInstance extends BasicWidgetInstance<BottomBarProps> {
+    /**
+     * 响应式组件当前高度，单位 rpx
+     */
     height: ComputedRef<string>
+    /**
+     * 切换展开状态
+     * @param expand 是否展开
+     */
     toggleExpand: (expand?: boolean) => void
 }

src/components/Map/Widgets/Legend/src/types.ts

@@ -32,7 +32,19 @@ export interface LegendProps extends BasicWidgetProps {
 }
 
 export interface LegendInstance extends BasicWidgetInstance<LegendProps> {
+    /**
+     * 设置标题
+     * @param title 标题
+     */
     setTitle: (title: string) => void
+    /**
+     * 设置选项
+     * @param option 选项
+     */
     setOption: (option: Option) => void
+    /**
+     * 切换展开状态
+     * @param expand 是否展开
+     */
     toggleExpand: (expand?: boolean) => void
 }

src/components/Map/Widgets/Switch/src/types.ts

@@ -10,8 +10,12 @@ export interface SwitchControlProps extends BasicWidgetProps {
 }
 
 export interface SwitchControlInstance extends BasicWidgetInstance<SwitchControlProps> {
-    // 暴露方法，允许手动调用上一个
+    /**
+     * 手动调用上一个
+     */
     prev: () => void
-    // 暴露方法，允许手动调用下一个
+    /**
+     * 手动调用下一个
+     */
     next: () => void
 }

src/components/Map/Widgets/TimeBar/src/types.ts

@@ -57,9 +57,29 @@ export interface TimeBarProps extends BasicWidgetProps {
 }
 
 export interface TimeBarInstance extends BasicWidgetInstance<TimeBarProps> {
+    /**
+     * 获取时间
+     * @returns 时间
+     */
     getTime: () => Dayjs[]
+    /**
+     * 设置时间
+     * @param time 时间
+     */
     setTime: (time: Dayjs[]) => void
+    /**
+     * 获取选中的选项
+     * @returns 选中的选项
+     */
     getCheckedOption: () => TimeBarLabel['options'][0]
+    /**
+     * 设置选中的选项
+     * @param index 选项索引
+     */
     setCheckedOption: (index: number) => void
+    /**
+     * 获取时间栏的值
+     * @returns 时间栏的值
+     */
     getTimeBarValue: () => TimeBarChangeEvent
 }

src/components/Map/Widgets/ToolBox/src/types.ts

@@ -65,5 +65,9 @@ export interface ToolBoxProps extends BasicWidgetProps {
 }
 
 export interface ToolBoxInstance extends BasicWidgetInstance<ToolBoxProps> {
+    /**
+     * 展开或收起工具箱
+     * @param expand 是否展开
+     */
     toggleExpand: (expand?: boolean) => void
 }