From f1a8d6f4bd6ee4ec7a1b9c37455d5c3303a13cab Mon Sep 17 00:00:00 2001 From: woodyjang Date: Thu, 7 Sep 2017 11:10:26 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=87=E6=A1=A3=E5=AE=8C=E5=96=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- uidoc/base/button/button.md | 2 +- uidoc/base/button/text_button.md | 2 +- uidoc/base/editor/editor.md | 1 - uidoc/base/editor/formula_editor.md | 10 +++--- uidoc/base/editor/multifile_editor.md | 2 +- uidoc/base/label.md | 6 ++-- uidoc/case/button/multi_select_item.md | 2 +- uidoc/case/layer/pane_list.md | 2 +- uidoc/case/layer/panel.md | 4 +-- uidoc/case/segment.md | 24 ++++++------- uidoc/core/abstract/collection_view.md | 8 ++--- uidoc/core/abstract/custom_tree.md | 4 +-- uidoc/core/abstract/grid_view.md | 8 ++--- uidoc/core/abstract/virtual_list.md | 4 +-- uidoc/core/combination/bi.combo.md | 2 +- uidoc/core/combination/group_combo.md | 31 ++++++++++++++++ uidoc/core/combination/loader.md | 36 ++++++++++++++++++- uidoc/core/combination/navigation.md | 2 +- uidoc/core/combination/tab.md | 2 +- uidoc/core/layer/layer_popup.md | 4 +-- uidoc/core/layer/layer_searcher.md | 4 +-- uidoc/core/pane.md | 4 +-- uidoc/core/widget.md | 4 +-- uidoc/detailed/combo/single_tree_combo.md | 3 +- uidoc/detailed/date/custom_date_time.md | 4 +-- uidoc/detailed/date/date_combo.md | 6 ++-- uidoc/detailed/date/date_pane_widget.md | 6 ++-- uidoc/detailed/date/year_month_combo.md | 7 ++-- uidoc/detailed/date/year_quarter_combo.md | 5 +-- uidoc/detailed/dialog.md | 8 +++-- uidoc/detailed/down_list_combo.md | 7 ++-- uidoc/detailed/file_manager.md | 9 ++--- uidoc/detailed/month_combo.md | 4 ++- uidoc/detailed/multi_select_combo.md | 13 +++---- uidoc/detailed/numeric_interval.md | 7 ++-- uidoc/detailed/path/direction_path_chooser.md | 6 ++-- uidoc/detailed/path/path_chooser.md | 7 ++-- uidoc/detailed/quarter_combo.md | 7 ++-- uidoc/detailed/relation_view.md | 4 ++- uidoc/detailed/table/bi.excel_table.md | 2 +- uidoc/detailed/table/bi.preview_table.md | 2 +- uidoc/detailed/text_input/bi.clear_editor.md | 1 - uidoc/detailed/text_input/bi.search_editor.md | 1 - uidoc/detailed/text_input/bi.text_editor.md | 1 - uidoc/detailed/year_combo.md | 5 ++- 45 files changed, 183 insertions(+), 100 deletions(-) diff --git a/uidoc/base/button/button.md b/uidoc/base/button/button.md index 0f600054b..4323fb351 100644 --- a/uidoc/base/button/button.md +++ b/uidoc/base/button/button.md @@ -41,7 +41,7 @@ BI.createWidget({ | :------ |:------------- | :-----| :----|:---- | level |按钮类型 | string| common,success,warning,ignore | common | | minWidth | 最小宽度,如果block/clear中某一项为true,此项值为0,否则为90 | number | — | 90 | -| shadow | | boolean| true,false | | +| shadow | 是否显示阴影 | boolean| true,false | props.clear !== true | | isShadowShowingOnSelected|选中状态下是否显示阴影 | boolean| true,false | true | | readonly | 是否只读 | boolean | true,false | true | | iconClass | 图标类型 | string| — | " "| diff --git a/uidoc/base/button/text_button.md b/uidoc/base/button/text_button.md index 314f6f4fb..6686420a8 100644 --- a/uidoc/base/button/text_button.md +++ b/uidoc/base/button/text_button.md @@ -34,7 +34,7 @@ BI.createWidget({ ##### 高级属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| py | | string| | " " | +| py | 拼音 | string| | " " | | textAlign | 文字布局 | string | left,center,right | cneter | | whiteSpace | 元素内的空白处理方式 | string | normal,nowrap | nowrap| | forceCenter | 是否无论如何都要居中, 不考虑超出边界的情况, 在未知宽度和高度时有效 | boolean | true,false | false | diff --git a/uidoc/base/editor/editor.md b/uidoc/base/editor/editor.md index 841006a19..61be1f4d0 100644 --- a/uidoc/base/editor/editor.md +++ b/uidoc/base/editor/editor.md @@ -33,7 +33,6 @@ BI.createWidget({ | bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | | validationChecker | 输入较验函数 |function| — | — | | quitChecker | 是否允许退出编辑函数 | function | — | — | -| mouseOut | | boolean | true,false | false | | allowBlank | 是否允许空值 | boolean | true,false | false | | watermark | 文本框placeholder | string | — | " " | | errorText | 错误提示 | string/function | —| " "| diff --git a/uidoc/base/editor/formula_editor.md b/uidoc/base/editor/formula_editor.md index 8f6a83393..e44f77c32 100644 --- a/uidoc/base/editor/formula_editor.md +++ b/uidoc/base/editor/formula_editor.md @@ -28,8 +28,8 @@ BI.createWidget({ | :------ |:------------- | :-----| :----|:---- | value | 文本域的值 | string | — | " "| | watermark | 文本框placeholder| string | —| " " | -| fieldTextValueMap | | string| —| {}| -| showHint | | | —| 2 | +| fieldTextValueMap | 字段集合 | onject | —| {}| +| showHint | 是否显示提示信息 | boolean | true,false | true | | lineHeight | 行高 | number | —| 2| @@ -44,12 +44,12 @@ BI.createWidget({ | insertOperator | 插入操作符| op| | setFunction | 设置函数 | v| | insertString | 插入字符串 | str| -| getFormulaString | 获取公式 |— | +| getFormulaString | 获取公式框内容 |— | | getUsedFields | 获取可用字段 | — | -| getCheckString | | — | +| getCheckString | 获取校验内容 | — | | getValue | 获取文本框值|—| | setValue | 设置文本框值|value| -| setFieldTextValueMap | | fieldTextValueMap | +| setFieldTextValueMap | 设置字段集合 | fieldTextValueMap | | refresh | 刷新文本框 | —| diff --git a/uidoc/base/editor/multifile_editor.md b/uidoc/base/editor/multifile_editor.md index d2c41a474..bef06cf04 100644 --- a/uidoc/base/editor/multifile_editor.md +++ b/uidoc/base/editor/multifile_editor.md @@ -25,7 +25,7 @@ BI.createWidget({ | :------ |:------------- | :-----| :----|:---- | multiple | 是否支持多选 | boolean | true,false| false | | maxSize | 最大可选数量 | number |— | -1 | -| accept | | string | —| " "| +| accept | 允许上传的文件类型 | string | —| " "| | url | 文件路径 | string | —| " "| diff --git a/uidoc/base/label.md b/uidoc/base/label.md index 6aaeb9b1c..1cfa2b537 100644 --- a/uidoc/base/label.md +++ b/uidoc/base/label.md @@ -44,8 +44,8 @@ BI.createWidget({ | textAlign | 文本对齐方式 | string | left,center,right | center | | whiteSpace | 元素内空白处理方式 | string| normal,nowrap | nowrap| | forceCenter | 是否无论如何都要居中, 不考虑超出边界的情况, 在未知宽度和高度时有效 | boolean | true,false | true | -| py | | string | — | 空 | -| keyword | | string | —| 空 | +| py | 拼音 | string | — | 空 | +| keyword | 设置标红的关键词 | string | —| 空 | | disabled | 灰化 | boolean| true,false | 无 | | title | 提示title | string | — | 空 | | warningTitle | 错误提示title | string | — | 空 | @@ -61,7 +61,7 @@ BI.createWidget({ | getText| 获取文本值 | —| | setStyle | 设置文本样式 |需要设置的文本标签样式,例{"color":"#000"} | | setValue | 设置文本值 | 需要设置的文本值text | -| populate| | —| +| populate| 清空label | —| --- \ No newline at end of file diff --git a/uidoc/case/button/multi_select_item.md b/uidoc/case/button/multi_select_item.md index 82856d6e4..eb48696d3 100644 --- a/uidoc/case/button/multi_select_item.md +++ b/uidoc/case/button/multi_select_item.md @@ -30,7 +30,7 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- | height | 高度 | number | — | 30 -| logic | | object | | {dynamic:false} | +| logic | 布局逻辑 | object | — | {dynamic:false} | diff --git a/uidoc/case/layer/pane_list.md b/uidoc/case/layer/pane_list.md index cbbdc06d7..8b60035a6 100644 --- a/uidoc/case/layer/pane_list.md +++ b/uidoc/case/layer/pane_list.md @@ -29,7 +29,7 @@ BI.createWidget({ | hasNext | 是否有下一页 | function | —| — | onLoad | 正在加载 | function | —| — | el | 开启panel的元素 | object | —|{type: "bi.button_group" }| -| logic | | object |— | { dynamic:true} +| logic | 布局逻辑 | object |— | { dynamic:true} | hgap | 效果相当于容器左右padding值 | number | — | 0 | | vgap | 效果相当于容器上下padding值 | number | —| 0 | | lgap | 效果相当于容器left-padding值 | number | —| 0 | diff --git a/uidoc/case/layer/panel.md b/uidoc/case/layer/panel.md index f145b7617..4eb739284 100644 --- a/uidoc/case/layer/panel.md +++ b/uidoc/case/layer/panel.md @@ -33,9 +33,9 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- | title | 标题 | string | — | " " -| titleButton | | array | —| [ ] +| titleButton | 标题后的按钮组 | array | —| [ ] | el | 开启panel的元素 | object | —|{ }| -| logic | | object |— | { dynamic:false} +| logic | 布局逻辑 | object |— | { dynamic:false} diff --git a/uidoc/case/segment.md b/uidoc/case/segment.md index c70ee213d..0a8164faa 100644 --- a/uidoc/case/segment.md +++ b/uidoc/case/segment.md @@ -42,17 +42,17 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于文本框左右padding值 | number | | 10 | -| vgap | 效果相当于文本框上下padding值 | number | | 0 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | -| bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | -| width | 宽度 | number | | | -| height | 高度 | number | | | - - ---- --- +| hgap | 效果相当于文本框左右padding值 | number | — | 10 | +| vgap | 效果相当于文本框上下padding值 | number | — | 0 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | — | 0 | +| bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | +| items | 子控件数组 | array |— | [ ] | +| width | 宽度 | number | — | — | +| height | 高度 | number | — | — | + + +--- diff --git a/uidoc/core/abstract/collection_view.md b/uidoc/core/abstract/collection_view.md index a389e3ef3..1413549cd 100644 --- a/uidoc/core/abstract/collection_view.md +++ b/uidoc/core/abstract/collection_view.md @@ -37,10 +37,10 @@ BI.createWidget({ | items | 子组件数组 | array | — | [ ] | | overflowX | 是否显示横向滚动条| boolean | true,false | true | | overflowY | 是否显示纵向滚动条 | boolean | true,false | true | -| cellSizeAndPositionGetter |设置每个单元格的位置坐标和宽高 | function|— | — | -| horizontalOverscanSize | | number | — | 0 | -| verticalOverscanSize | | number | — | 0 | -| width | 行宽,必设 |number| —ßß | — | +| cellSizeAndPositionGetter | 设置每个单元格的位置坐标和宽高 | function|— | — | +| horizontalOverscanSize | 横向超出可视范围区域预加载的数量 | number | — | 0 | +| verticalOverscanSize | 纵向超出可视范围区域预加载的数量 | number | — | 0 | +| width | 行宽,必设 |number| — | — | | height | 列宽,必设 | number | —| — | | scrollLeft | 滚动条相对于左边的偏移 | number | — | 0 | | scrollTop | 滚动条相对于顶部的偏移 | number | — | 0 | diff --git a/uidoc/core/abstract/custom_tree.md b/uidoc/core/abstract/custom_tree.md index ccb5a5a7a..451cb8466 100644 --- a/uidoc/core/abstract/custom_tree.md +++ b/uidoc/core/abstract/custom_tree.md @@ -55,8 +55,8 @@ BI.createWidget({ | :------ |:------------- | :-----| :----|:---- | items | 子组件数组 | array | — | [ ] | | itemsCreator| 子组件构造器 | object | — | { } | -| expander | | object | | {el: {},popup: {type: "bi.custom_tree"}}| -| el | | object | | {type: "bi.button_tree",chooseType: 0,layouts: [{type: "bi.vertical"}]}| +| expander | popup组件 | object | — | {el: {},popup: {type: "bi.custom_tree"}}| +| el | 开启popup元素 | object | — | {type: "bi.button_tree",chooseType: 0,layouts: [{type: "bi.vertical"}]}| diff --git a/uidoc/core/abstract/grid_view.md b/uidoc/core/abstract/grid_view.md index 833ef7a64..4a32a949c 100644 --- a/uidoc/core/abstract/grid_view.md +++ b/uidoc/core/abstract/grid_view.md @@ -37,14 +37,14 @@ BI.createWidget({ | items | 子组件数组 | array | — | [ ] | | overflowX | 是否显示横向滚动条| boolean | true,false | true | | overflowY | 是否显示纵向滚动条 | boolean | true,false | true | -| overscanColumnCount| | number|— | 0 | -| overscanRowCount| | number | — | 0 | +| overscanColumnCount| 超出可视范围区域预加载多少列 | number|— | 0 | +| overscanRowCount| 超出可视范围区域预加载多少行 | number | — | 0 | | width | 行宽,必设 |number| — | — | | height | 列宽,必设 | number | —| — | | rowHeightGetter| 每格行宽 |number,function | —| function | | columnWidthGetter| 每格列宽 | number,function |— | function | -| estimatedColumnSize| 每格行宽,columnWidthGetter为function时必设 |number,function |— | function | -| estimatedRowSize | 每格列宽,rowHeightGetter为function时必设 | number,function | —| function | +| estimatedColumnSize| 预估行宽,columnWidthGetter为function时必设 |number,function |— | function | +| estimatedRowSize | 预估列宽,rowHeightGetter为function时必设 | number,function | —| function | | scrollLeft | 滚动条相对于左边的偏移 | number | — | 0 | | scrollTop | 滚动条相对于顶部的偏移 | number | —|0 | diff --git a/uidoc/core/abstract/virtual_list.md b/uidoc/core/abstract/virtual_list.md index 205483234..686d05c54 100644 --- a/uidoc/core/abstract/virtual_list.md +++ b/uidoc/core/abstract/virtual_list.md @@ -31,8 +31,8 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- | items | 子组件数组 | array | — | [ ] | -| blockSize | | number | — | 10 | -| overscanHeight | | number | — | 100 | +| blockSize | 滚动加载的个数 | number | — | 10 | +| overscanHeight | 超出可视范围区域的高度 | number | — | 100 | | scrollTop | 滚动条相对于顶部的偏移 | number | — | 0 | diff --git a/uidoc/core/combination/bi.combo.md b/uidoc/core/combination/bi.combo.md index 250ee1352..94c8b7824 100644 --- a/uidoc/core/combination/bi.combo.md +++ b/uidoc/core/combination/bi.combo.md @@ -43,7 +43,7 @@ BI.createWidget({ | stopPropagation | 阻止事件冒泡 | boolean | true,false | false | | adjustXOffset | 调整横向偏移 | number | — | 0 | | adjustYOffset |调整纵向偏移 | number | — | 0 | -| hideChecker | | function | — | —| +| hideChecker | 是否隐藏弹出层检测 | function | — | —| | offsetStyle | 弹出层显示位置 | string | left,right,center | "left,right,center"| | popup | 弹出层 | object | — | { }| | comboClass | combo类 | string | — | "bi-combo-popup" | diff --git a/uidoc/core/combination/group_combo.md b/uidoc/core/combination/group_combo.md index 41c39d5eb..d9dc8ab73 100644 --- a/uidoc/core/combination/group_combo.md +++ b/uidoc/core/combination/group_combo.md @@ -2,6 +2,37 @@ ## 基类[BI.Widget](/core/widget.md) +{% method %} +[source](https://jsfiddle.net/fineui/x32ue8xv/) + +{% common %} +```javascript + +BI.createWidget({ + element: "#wrapper", + type: "bi.combo_group", + el: { + type: "bi.icon_text_icon_item", + text: "2010年", + value: 2010, + height: 25, + iconCls: "close-ha-font" + }, + children: [{ + type: "bi.single_select_item", + height: 25, + text: "一月", + value: 11 + }] +}); + + + + +``` + +{% endmethod %} + ## API ##### 基础属性 diff --git a/uidoc/core/combination/loader.md b/uidoc/core/combination/loader.md index 41b6a444e..47a406105 100644 --- a/uidoc/core/combination/loader.md +++ b/uidoc/core/combination/loader.md @@ -2,6 +2,40 @@ ## 加载控件,[BI.Widget](/core/widget.md) +{% method %} +[source](https://jsfiddle.net/fineui/qgLtctnx/) + +{% common %} +```javascript + +BI.createWidget({ + element: "#wrapper", + type: "bi.loader", + itemsCreator: function(options, populate) { + populate(BI.map(BI.map(BI.makeArray(3, null), function(idx, value){ + return { + text: faker.name.findName(), + value: BI.UUID() + }; + }), function(i, v) { + return BI.extend(v, { + type: "bi.single_select_item", + height: 25 + }) + })) + }, + hasNext: function(option) { + return option.count < 10; + } +}); + + + + +``` + +{% endmethod %} + ## API ##### 基础属性 @@ -9,7 +43,7 @@ | :------ |:------------- | :-----| :----|:---- | direction | combo弹出层位置 | string | top,bottom,left,right,(top,left),(top,right),(bottom,left),(bottom,right) | "top"| | isDefaultInit | 是否默认初始化子数据 |boolean | true,false | true | -| logic | | object | —| {dynamic:true,scrolly:true} | +| logic | 布局逻辑 | object | —| {dynamic:true,scrolly:true} | | items| 子组件 | array | — | []| | itemsCreator | 子组件构造器 | function | — | — | | onLoaded | 加载中 | function | — | — | diff --git a/uidoc/core/combination/navigation.md b/uidoc/core/combination/navigation.md index 11a5a7813..ca3e11e2b 100644 --- a/uidoc/core/combination/navigation.md +++ b/uidoc/core/combination/navigation.md @@ -48,7 +48,7 @@ BI.createWidget({ | single | 是否为单页 | boolean | true,false | true | | defaultShowIndex | 是否默认显示 |boolean | true,false | true | | tab | tab页元素 | boolean | true,false | true | -| logic | | object | | {dynamic:true} | +| logic | 布局逻辑 | object | — | {dynamic:true} | | cardCreator | 面板构造器 | function | — | v | | afterCardCreated | 面板构造之后 | function | — | — | | afterCardShow | 面板显示之后 | function | —| — | diff --git a/uidoc/core/combination/tab.md b/uidoc/core/combination/tab.md index ae3fad9e2..9023bbf44 100644 --- a/uidoc/core/combination/tab.md +++ b/uidoc/core/combination/tab.md @@ -57,7 +57,7 @@ BI.createWidget({ | single | 是否为单页 | boolean | true,false | false | | defaultShowIndex | 是否默认显示tab页 | boolean | true,false | false | | tab | tab标签页 | object | — | { } | -| logic | | object | — | {dynamic:false} | +| logic | 布局逻辑 | object | — | {dynamic:false} | | cardCreator | 面板构造器| function | — | function (v) {return BI.createWidget();} | ## 对外方法 diff --git a/uidoc/core/layer/layer_popup.md b/uidoc/core/layer/layer_popup.md index 70a43a7a1..365009083 100644 --- a/uidoc/core/layer/layer_popup.md +++ b/uidoc/core/layer/layer_popup.md @@ -46,11 +46,11 @@ BI.createWidget({ | rgap | 效果相当于容器right-padding值 | number | —| 0 | | tgap | 效果相当于容器top-padding值 | number | —| 0 | | bgap | 效果相当于容器bottom-padding值 | number | — | 0 | -| direction| 工具栏的方向| const | | BI.Direction.Top | +| direction| 工具栏的方向| const | 参考button_group | BI.Direction.Top | | stopEvent | 是否停止mousedown、mouseup事件 | boolean | true,false | false | | stopPropagation | 是否停止mousedown、mouseup向上冒泡 | boolean | true,false | false | | tabs | 导航栏 | array | — | [] | -| logic | | object | — | {dynamic:true} | +| logic | 布局逻辑| object | — | {dynamic:true} | | tools | 自定义工具栏 |boolean | true,false | false | | buttons | toolbar栏 | array | — | [] | | el | 子组件 | object | — |{ type: "bi.button_group",items: [], chooseType: 0,behaviors: {},layouts: [{type: "bi.vertical"}]} | diff --git a/uidoc/core/layer/layer_searcher.md b/uidoc/core/layer/layer_searcher.md index 4eb4c00d2..64c0898b2 100644 --- a/uidoc/core/layer/layer_searcher.md +++ b/uidoc/core/layer/layer_searcher.md @@ -34,9 +34,9 @@ searcher.populate([{ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- | tipText | title文本 | string | — | BI.i18nText("BI-No_Select") | -| chooseType | 选择类型 | const | | BI.Selection.Single | +| chooseType | 选择类型 | const | 参考button_group | BI.Selection.Single | | matcher | 完全匹配的构造器 | object | — | {type: "bi.button_group",behaviors: { redmark: function () { return true;} },items: [], layouts: [{ type: "bi.vertical"}]} | -| searcher | | object| — | {type: "bi.button_group",behaviors: {redmark: function () {return true;}}, items: [], layouts: [{ type: "bi.vertical" }]}| +| searcher | 搜索到的元素 | object| — | {type: "bi.button_group",behaviors: {redmark: function () {return true;}}, items: [], layouts: [{ type: "bi.vertical" }]}| ## 对外方法 | 名称 | 说明 | 回调参数 diff --git a/uidoc/core/pane.md b/uidoc/core/pane.md index 6c87f8f16..93ea2f6e5 100644 --- a/uidoc/core/pane.md +++ b/uidoc/core/pane.md @@ -8,8 +8,8 @@ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- | tipText | title文本 | string | — | BI.i18nText("BI-No_Selected_Item") | -| overlap| | boolean | true,false | true | -| onLoaded | | function | — | — | +| overlap| 是否含有遮罩层 | boolean | true,false | true | +| onLoaded | 已经加载 | function | — | — | ## 对外方法 diff --git a/uidoc/core/widget.md b/uidoc/core/widget.md index b956f85c9..5cc99bcc7 100644 --- a/uidoc/core/widget.md +++ b/uidoc/core/widget.md @@ -50,7 +50,7 @@ | getWidgetByName | 根据组件名称获取组件| name | | removeWidget | 移除组件 | nameOrWidget | | hasWidget | 判断是否有该组件 | name | -| getName | 获取组件名称 | | +| getName | 获取组件名称 | —| | setTag | 设置tag | tag | | getTag | 获取tag | —| | attr | 设置组件属性 | key,value | @@ -66,7 +66,7 @@ |invalid | 设置组件无效 | —| | invisible | 设置组件不可见 | —| | visible | 设置组件可见 | —| -| isolate | | —| +| isolate | 组件不在页面展示,组件事件和内容都在 | —| | empty | 清空组件 | —| | destroy | 销毁组件| —| diff --git a/uidoc/detailed/combo/single_tree_combo.md b/uidoc/detailed/combo/single_tree_combo.md index 13b09ce39..e40484146 100644 --- a/uidoc/detailed/combo/single_tree_combo.md +++ b/uidoc/detailed/combo/single_tree_combo.md @@ -24,7 +24,7 @@ var tree = BI.createWidget({ | 参数 | 说明 | 类型 | 默认值 | | ------- | ---- | ------ | ---- | -| trigger | | object | {} | +| trigger | 下拉列表的弹出方式 | object | {} | | height | 高度 | number | 30 | | text | 文本框值 | string | '' | | items | 元素 | array | null | @@ -46,5 +46,6 @@ var tree = BI.createWidget({ |BI.SingleTreeCombo.EVENT_BEFORE_POPUPVIEW| 下拉框弹出前触发 | 其他事件详见[Input](../../base/editor/editor.md) + --- diff --git a/uidoc/detailed/date/custom_date_time.md b/uidoc/detailed/date/custom_date_time.md index 4e216cf32..cd2b1d456 100644 --- a/uidoc/detailed/date/custom_date_time.md +++ b/uidoc/detailed/date/custom_date_time.md @@ -18,8 +18,8 @@ BI.createWidget({ ##参数 | 参数 | 说明 | 类型 | 可选值 | 默认值 -| :------ |:------------- | :-----| :----|:----| ---- --- +| :------ |:------------- | :-----| :----|:---- + ##事件 | 事件 | 说明 | diff --git a/uidoc/detailed/date/date_combo.md b/uidoc/detailed/date/date_combo.md index 8ec2eef54..0db0306f3 100644 --- a/uidoc/detailed/date/date_combo.md +++ b/uidoc/detailed/date/date_combo.md @@ -19,5 +19,7 @@ BI.createWidget({ ##参数 | 参数 | 说明 | 类型 | 可选值 | 默认值 -| :------ |:------------- | :-----| :----|:----| ---- --- \ No newline at end of file +| :------ |:------------- | :-----| :----|:---- + + +--- \ No newline at end of file diff --git a/uidoc/detailed/date/date_pane_widget.md b/uidoc/detailed/date/date_pane_widget.md index 6eab4836e..57a017220 100644 --- a/uidoc/detailed/date/date_pane_widget.md +++ b/uidoc/detailed/date/date_pane_widget.md @@ -22,5 +22,7 @@ BI.createWidget({ | :------ |:------------- | :-----| :----|:----| | min | 限定可选日期的下限 | string | | '1900-01-01' | | max | 限定可选日期的上限 | string | | '2099-12-31' | -| selectedTime | 选中的初始年月 | obj({year: y, month: m}) | | | ---- --- \ No newline at end of file +| selectedTime | 选中的初始年月 | obj({year: y, month: m}) | — | — | + + +--- \ No newline at end of file diff --git a/uidoc/detailed/date/year_month_combo.md b/uidoc/detailed/date/year_month_combo.md index db6e015c4..f22537f98 100644 --- a/uidoc/detailed/date/year_month_combo.md +++ b/uidoc/detailed/date/year_month_combo.md @@ -19,9 +19,9 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:----| -| yearBehaviors |自定义年份选择的行为(详见[button_group](../../core/abstract/button_group.md)) | object| | | -| monthBehaviors |自定义年份选择的行为(详见[button_group](../../core/abstract/button_group.md)) | object| | | ---- --- +| yearBehaviors |自定义年份选择的行为(详见[button_group](../../core/abstract/button_group.md)) | object| —| { } | +| monthBehaviors |自定义年份选择的行为(详见[button_group](../../core/abstract/button_group.md)) | object|— | { }| + ##事件 | 事件 | 说明 | @@ -29,4 +29,5 @@ BI.createWidget({ | BI.YearMonthCombo.EVENT_BEFORE_POPUPVIEW | 弹出框弹出前触发 | | BI.YearMonthCombo.EVENT_CONFIRM| 点击确认触发 | + --- \ No newline at end of file diff --git a/uidoc/detailed/date/year_quarter_combo.md b/uidoc/detailed/date/year_quarter_combo.md index 1f567ab3d..6389cf304 100644 --- a/uidoc/detailed/date/year_quarter_combo.md +++ b/uidoc/detailed/date/year_quarter_combo.md @@ -20,8 +20,8 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:----| | yearBehaviors |自定义年份选择的行为(详见[button_group](../../core/abstract/button_group.md)) | object| | | -| monthBehaviors |自定义年份选择的行为(详见[button_group](../../core/abstract/button_group.md)) | object| | | ---- --- +| monthBehaviors |自定义年份选择的行为(详见[button_group](../../core/abstract/button_group.md)) | object| —|{ } | + ##事件 @@ -30,4 +30,5 @@ BI.createWidget({ | BI.YearQuarterCombo.EVENT_BEFORE_POPUPVIEW | 弹出框弹出前触发 | | BI.YearQuarterCombo.EVENT_CONFIRM| 点击确认触发 | + --- \ No newline at end of file diff --git a/uidoc/detailed/dialog.md b/uidoc/detailed/dialog.md index a9da35a30..51e5b7776 100644 --- a/uidoc/detailed/dialog.md +++ b/uidoc/detailed/dialog.md @@ -16,7 +16,9 @@ BI.Msg.alert(title, content) | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:----| -| title | 对话框标题 | string | | | -| content | 对话框内容 | string | | | +| title | 对话框标题 | string | — | " " | +| content | 对话框内容 | string | — | " " | ---- --- \ No newline at end of file + + +--- \ No newline at end of file diff --git a/uidoc/detailed/down_list_combo.md b/uidoc/detailed/down_list_combo.md index 3fecd531c..5766bd532 100644 --- a/uidoc/detailed/down_list_combo.md +++ b/uidoc/detailed/down_list_combo.md @@ -65,7 +65,6 @@ BI.createWidget({ | direction | 弹出列表和trigger的位置关系 | string | top | bottom | left | right | top,left | top,right | bottom,left | bottom,right | bottom | | adjustLength | 弹出列表和trigger的距离 | number | | 0 | ---- --- ##事件 | 事件 | 说明 | @@ -74,4 +73,8 @@ BI.createWidget({ |BI.DownListCombo.EVENT_SON_VALUE_CHANGE| 点击二级节点触发 | |BI.DownListCombo.EVENT_BEFORE_POPUPVIEW| 下拉列表弹出前触发 | -##具体配置方法见[Combo](../core/combination/bi.combo.md) \ No newline at end of file +##具体配置方法见[Combo](../core/combination/bi.combo.md) + + + +--- \ No newline at end of file diff --git a/uidoc/detailed/file_manager.md b/uidoc/detailed/file_manager.md index e00fdfc28..dbad35967 100644 --- a/uidoc/detailed/file_manager.md +++ b/uidoc/detailed/file_manager.md @@ -29,12 +29,7 @@ BI.createWidget({ {% endmethod %} -##参数 -| 参数 | 说明 | 类型 | 可选值 | 默认值 -| :------ |:------------- | :-----| :----|:----| - ---- --- ##方法 @@ -42,4 +37,6 @@ BI.createWidget({ | :------ |:------------- | | getSelectedValue() | 获取当前选中项的value值 | | getSelectedId | 获取当前选中项的id属性 | ---- --- \ No newline at end of file + + +--- \ No newline at end of file diff --git a/uidoc/detailed/month_combo.md b/uidoc/detailed/month_combo.md index 761c466d6..ea87ce4bc 100644 --- a/uidoc/detailed/month_combo.md +++ b/uidoc/detailed/month_combo.md @@ -22,7 +22,7 @@ BI.createWidget({ | :------ |:------------- | :-----| :----|:----| | behaviors | 自定义下拉列表中item项的行为,如高亮,标红等(详见[button_group](../core/abstract/button_group.md)) | object | | {} | ---- --- + ##事件 | 事件 | 说明 | @@ -30,3 +30,5 @@ BI.createWidget({ |BI.MonthCombo.EVENT_CONFIRM| 选中日期或者退出编辑状态触发 | |BI.MonthCombo.EVENT_BEFORE_POPUPVIEW| 选中日期或者退出编辑状态触发 | + +--- \ No newline at end of file diff --git a/uidoc/detailed/multi_select_combo.md b/uidoc/detailed/multi_select_combo.md index dd98755f4..f0b44627d 100644 --- a/uidoc/detailed/multi_select_combo.md +++ b/uidoc/detailed/multi_select_combo.md @@ -22,15 +22,10 @@ BI.createWidget({ {% endmethod %} -##参数 - -| 参数 | 说明 | 类型 | 可选值 | 默认值 -| :------ |:------------- | :-----| :----|:----| - -## 方法 -| 方法 | 说明 | 用法 | -| ---------------------------- | ---------------- | ------------------------------------ | | | 事件 | 说明 | | :------ |:------------- | -|BI.MultiSelectCombo.EVENT_CONFIRM| 点击确定触发 | \ No newline at end of file +|BI.MultiSelectCombo.EVENT_CONFIRM| 点击确定触发 | + + +--- \ No newline at end of file diff --git a/uidoc/detailed/numeric_interval.md b/uidoc/detailed/numeric_interval.md index 5ef454eda..374a520d6 100644 --- a/uidoc/detailed/numeric_interval.md +++ b/uidoc/detailed/numeric_interval.md @@ -33,10 +33,13 @@ BI.createWidget({ | setCloseMinEnable(boolean) | 设置左区间开闭combo的disable状态 | | | setMaxEnable(boolean) | 设置右区间输入框disable状态 | | | setCloseMaxEnable(boolean) | 设置右区间开闭combo的disable状态 | | -| setNumTip(string) | 设置数值区间的tip提示 | | +| setNumTip(string) | 设置数值区间的tip提示 | — | ##事件 | 事件 | 说明 | | :------ |:------------- | |BI.NumericalInterval.EVENT_VALID| 区间合法的状态事件 | -|BI.NumericalInterval.EVENT_ERROR| 区间不合法的状态事件 | \ No newline at end of file +|BI.NumericalInterval.EVENT_ERROR| 区间不合法的状态事件 | + + +--- \ No newline at end of file diff --git a/uidoc/detailed/path/direction_path_chooser.md b/uidoc/detailed/path/direction_path_chooser.md index f1336587e..e22203d23 100644 --- a/uidoc/detailed/path/direction_path_chooser.md +++ b/uidoc/detailed/path/direction_path_chooser.md @@ -34,5 +34,7 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:----| -| items |二维数组,每个元素代表一条路径,相较于[path_chooser](path_chooser.md)多一个属性direction来指定方向 | array| | | ---- --- \ No newline at end of file +| items |二维数组,每个元素代表一条路径,相较于[path_chooser](path_chooser.md)多一个属性direction来指定方向 | array| — | [ ]| + + +--- \ No newline at end of file diff --git a/uidoc/detailed/path/path_chooser.md b/uidoc/detailed/path/path_chooser.md index 21977202c..097ecb060 100644 --- a/uidoc/detailed/path/path_chooser.md +++ b/uidoc/detailed/path/path_chooser.md @@ -35,5 +35,8 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:----| -| items |二维数组,每个元素代表一条路径 | array| | | ---- --- \ No newline at end of file +| items |二维数组,每个元素代表一条路径 | array| — | [ ] | + + + +--- \ No newline at end of file diff --git a/uidoc/detailed/quarter_combo.md b/uidoc/detailed/quarter_combo.md index 6ebae4aa1..e15d26d54 100644 --- a/uidoc/detailed/quarter_combo.md +++ b/uidoc/detailed/quarter_combo.md @@ -22,10 +22,13 @@ BI.createWidget({ | :------ |:------------- | :-----| :----|:----| | behaviors | 自定义下拉列表中item项的行为,如高亮,标红等(详见[button_group](../core/abstract/button_group.md)) | object | | {} | ---- --- + ##事件 | 事件 | 说明 | | :------ |:------------- | |BI.QuarterCombo.EVENT_CONFIRM| 选中日期或者退出编辑状态触发 | -|BI.QuarterCombo.EVENT_BEFORE_POPUPVIEW| 选中日期或者退出编辑状态触发 | \ No newline at end of file +|BI.QuarterCombo.EVENT_BEFORE_POPUPVIEW| 选中日期或者退出编辑状态触发 | + + +--- \ No newline at end of file diff --git a/uidoc/detailed/relation_view.md b/uidoc/detailed/relation_view.md index e6073f9f0..d2997620d 100644 --- a/uidoc/detailed/relation_view.md +++ b/uidoc/detailed/relation_view.md @@ -30,4 +30,6 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:----| ---- --- \ No newline at end of file + + +--- \ No newline at end of file diff --git a/uidoc/detailed/table/bi.excel_table.md b/uidoc/detailed/table/bi.excel_table.md index 92fcb2099..4ab567cc9 100644 --- a/uidoc/detailed/table/bi.excel_table.md +++ b/uidoc/detailed/table/bi.excel_table.md @@ -79,6 +79,6 @@ BI.createWidget({ | populate | 增加行 | rows | | destroy | 摧毁表 | — | ------- +--- diff --git a/uidoc/detailed/table/bi.preview_table.md b/uidoc/detailed/table/bi.preview_table.md index 413a0da99..e8d99a07b 100644 --- a/uidoc/detailed/table/bi.preview_table.md +++ b/uidoc/detailed/table/bi.preview_table.md @@ -71,5 +71,5 @@ BI.createWidget({ | populate | 替换为新的内容 | rows | | destroy | 摧毁表 | — | ------- +--- diff --git a/uidoc/detailed/text_input/bi.clear_editor.md b/uidoc/detailed/text_input/bi.clear_editor.md index 68aa3c1f7..925055297 100644 --- a/uidoc/detailed/text_input/bi.clear_editor.md +++ b/uidoc/detailed/text_input/bi.clear_editor.md @@ -30,7 +30,6 @@ BI.createWidget({ | bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | | validationChecker | 输入较验函数 | function | — | — | | quitChecker | 是否允许退出编辑函数 | function | — | — | -| mouseOut | | boolean | true,false | false | | allowBlank | 是否允许空值 | boolean | true,false | false | | watermark | 文本框placeholder | string | — | null | | value | 文本框默认值 | string | — | " " | diff --git a/uidoc/detailed/text_input/bi.search_editor.md b/uidoc/detailed/text_input/bi.search_editor.md index 6d9ec5492..d42283a0d 100644 --- a/uidoc/detailed/text_input/bi.search_editor.md +++ b/uidoc/detailed/text_input/bi.search_editor.md @@ -29,7 +29,6 @@ BI.createWidget({ | bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | | validationChecker | 输入较验函数 |function| — | — | | quitChecker | 是否允许退出编辑函数 | function | — | — | -| mouseOut | | boolean | true,false | false | | allowBlank | 是否允许空值 | boolean | true,false | false | | watermark | 文本框placeholder | string | — | null | | value | 文本框默认值 | string | — | " " | diff --git a/uidoc/detailed/text_input/bi.text_editor.md b/uidoc/detailed/text_input/bi.text_editor.md index b7e02ec3a..32e27748e 100644 --- a/uidoc/detailed/text_input/bi.text_editor.md +++ b/uidoc/detailed/text_input/bi.text_editor.md @@ -31,7 +31,6 @@ BI.createWidget({ | bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | | validationChecker | 输入较验函数 |function| — | — | | quitChecker | 是否允许退出编辑函数 | function | — | — | -| mouseOut | | boolean | true,false | false | | allowBlank | 是否允许空值 | boolean | true,false | false | | watermark | 文本框placeholder | string | — | null | | value | 文本框默认值 | string | — | " " | diff --git a/uidoc/detailed/year_combo.md b/uidoc/detailed/year_combo.md index bfb22129a..7cd74f0bc 100644 --- a/uidoc/detailed/year_combo.md +++ b/uidoc/detailed/year_combo.md @@ -24,7 +24,7 @@ BI.createWidget({ | min | 限定可选日期的下限 | string | | '1900-01-01' | | max | 限定可选日期的上限 | string | | '2099-12-31' | ---- --- + ##事件 | 事件 | 说明 | @@ -32,3 +32,6 @@ BI.createWidget({ |BI.YearCombo.EVENT_CONFIRM| 选中日期或者退出编辑状态触发 | |BI.YearCombo.EVENT_BEFORE_POPUPVIEW| 选中日期或者退出编辑状态触发 | + + +--- \ No newline at end of file