UI
场景基础界面要素控制接口类。
来源于@ksj/bw
| 接口 | 说明 |
|---|---|
| addToolBarButton | 添加工具栏按钮。 |
| clearToolBarButton | 清除所有的工具栏按钮。 |
| resetToolBarButton | 重置所有的工具栏按钮。 |
| hasToolBarButton | 是否存在工具栏按钮。 |
| addNavigationToolsButton | 添加导航栏按钮。 |
| clearNavigationToolsButton | 清除所有的导航栏按钮。 |
| resetNavigationToolsButton | 重置所有的导航栏按钮。 |
| hasNavigationToolButton | 是否存在导航栏按钮。 |
| addWidget | 添加信息栏。 |
| removeWidget | 移除一个信息栏。 |
| addStatusItem | 添加状态栏要素。 |
| clearStatusItems | 清除所有的状态栏要素。 |
| update | 更新所有界面要素。 |
| isStatusBarShow | 当前状态栏是否显示。 |
| showStatusBar | 显示状态栏。 |
| hideStatusBar | 隐藏状态栏是。 |
# 列表
# 1. addToolBarButton
向工具栏添加一个要素。
static addToolBarButton( button:any, dir:string = "Horizontal" )
参数：
button： 要添加的要素。具体请参考相关示例。
dir: 添加的位置。
Horizontal 表示要添加到水平方向，及界面左上方；
Vertical 表示添加多垂直方向，及界面左侧。
返回： 无。
示例：
Ui.addToolBarButton( ToolbarHelper.createToolbarItemFromItemDef(5, CoreTools.measureToolGroup), "Horizontal" )
# 2. clearToolBarButton
删除工具栏所有的要素。
static clearToolBarButton()
参数： 无。
返回： 无。
# 3. resetToolBarButton
重置工具栏要素。
resetToolBarButton( horizontalButtons:any, verticalButtons:any )
参数：
horizontalButtons： 水平向的要素的数组。
verticalButtons： 垂直向的要素的数组。
返回： 无。
# 4. hasToolBarButton
返回当前工具栏是否存在要素。
static hasToolBarButton():boolean
参数： 无。
返回：
true 表示当前工具栏有定义的要素。
false 表示当前工具栏无定义的要素。
# 5. addNavigationToolsButton
向导航栏添加一个要素。
static addNavigationToolsButton( button:any, dir:string = "Horizontal" )
参数：
button： 要添加的要素。具体请参考相关示例。
dir: 添加的位置。
Horizontal 表示要添加到水平方向，及界面右上方；
Vertical 表示添加多垂直方向，及界面右侧。
返回： 无。
示例：
Ui.addNavigationToolsButton( ToolbarHelper.createToolbarItemFromItemDef(5, CoreTools.measureToolGroup), "Horizontal" )
# 6. clearNavigationToolsButton
清除导航栏的所有要素。
static clearNavigationToolsButton()
参数： 无。
返回： 无。
# 7. resetNavigationToolsButton
重置导航栏所有的要素。
static resetNavigationToolsButton( horizontalButtons:any, verticalButtons:any )
参数：
horizontalButtons： 水平向的要素的数组。
verticalButtons： 垂直向的要素的数组。
返回： 无。
# 8. hasNavigationToolButton
重置导航栏所有的要素。
static hasNavigationToolButton():boolean
参数： 无。
返回：
true 表示当前导航栏有定义的要素。
false 表示当前导航栏无定义的要素。
# 9. addWidget
添加信息框到场景界面。
static addWidget( id: string, label: string, icon:string, getWidgetContent:any )
参数：
id： 信息框的唯一标识。
label: 标签显示的信息。
icon: 图标。
getWidgetContent: 信息框主体。
返回： 无。
# 10. removeWidget
移除一个信息框。
static removeWidget( id:string )
参数：
id：信息框的唯一标识。
返回： 无。
# 11. addStatusItem
添加状态栏要素。
static addStatusItem( item:any )
参数：
item： 状态栏要素。
返回： 无。
示例：
const DisplayStyle = withStatusFieldProps(DisplayStyleField);
Ui.addStatusItem( StatusBarItemUtilities.createStatusBarItem("DisplayStyle", StatusBarSection.Left, 20, ));
# 12. clearStatusItems
清除状态栏要素。
static clearStatusItems()
参数： 无。
返回： 无。
# 13. update
刷新界面中状态栏，工具栏，导航栏和信息框。当相关要素发生改变的时候，调用该接口刷新界面。
static async update(stageIds:any)
参数：
id：信息框的唯一标识。
返回： 无。
# 14. isStatusBarShow
状态栏是否显示，与状态栏是否存在要素无关。
static isStatusBarShow():boolean
参数： 无。
返回：
true 表示当前状态栏显示。
false 表示当前状态栏隐藏。
# 15. showStatusBar
显示状态栏，与状态栏是否存在要素无关。
static showStatusBar()
参数： 无。
返回： 无。
# 16. hideStatusBar
隐藏状态栏，与状态栏是否存在要素无关。
static hideStatusBar()
参数： 无。
返回： 无。