From 9c02ba5d0d7184605a645310cea7e6a817aa9f37 Mon Sep 17 00:00:00 2001 From: iapyang Date: Tue, 5 Sep 2017 16:32:27 +0800 Subject: [PATCH] finish first wave --- .../combo/multilayer_select_tree_combo.md | 1 + .../combo/multilayer_single_tree_combo.md | 4 +- uidoc/detailed/combo/select_tree_combo.md | 1 + uidoc/detailed/combo/single_tree_combo.md | 2 +- uidoc/detailed/table/bi.excel_table.md | 61 +++++++------ uidoc/detailed/table/bi.page_table.md | 3 +- uidoc/detailed/table/bi.preview_table.md | 81 ++++++++--------- uidoc/detailed/table/bi.responsive_table.md | 87 ++++++++++--------- uidoc/detailed/tree/bi.multi_tree_combo.md | 8 +- uidoc/detailed/tree/bi.switch_tree.md | 18 ++-- 10 files changed, 138 insertions(+), 128 deletions(-) diff --git a/uidoc/detailed/combo/multilayer_select_tree_combo.md b/uidoc/detailed/combo/multilayer_select_tree_combo.md index ad832c4a8..f5934c7a6 100644 --- a/uidoc/detailed/combo/multilayer_select_tree_combo.md +++ b/uidoc/detailed/combo/multilayer_select_tree_combo.md @@ -38,3 +38,4 @@ var tree = BI.createWidget({ | setValue | 设置值 | setValue | | getValue | 获取值 | getValue | +------ \ No newline at end of file diff --git a/uidoc/detailed/combo/multilayer_single_tree_combo.md b/uidoc/detailed/combo/multilayer_single_tree_combo.md index d9ff91c2c..de905edce 100644 --- a/uidoc/detailed/combo/multilayer_single_tree_combo.md +++ b/uidoc/detailed/combo/multilayer_single_tree_combo.md @@ -37,4 +37,6 @@ var tree = BI.createWidget({ | -------- | ---- | ----------- | | populate | 刷新内容 | items: 子项数组 | | setValue | 设置值 | setValue | -| getValue | 获取值 | getValue | \ No newline at end of file +| getValue | 获取值 | getValue | + +------ \ No newline at end of file diff --git a/uidoc/detailed/combo/select_tree_combo.md b/uidoc/detailed/combo/select_tree_combo.md index 8037fb883..30d7679c0 100644 --- a/uidoc/detailed/combo/select_tree_combo.md +++ b/uidoc/detailed/combo/select_tree_combo.md @@ -38,3 +38,4 @@ var tree = BI.createWidget({ | setValue | 设置值 | setValue | | getValue | 获取值 | getValue | +------ \ No newline at end of file diff --git a/uidoc/detailed/combo/single_tree_combo.md b/uidoc/detailed/combo/single_tree_combo.md index fa5cc5c17..13b09ce39 100644 --- a/uidoc/detailed/combo/single_tree_combo.md +++ b/uidoc/detailed/combo/single_tree_combo.md @@ -33,7 +33,7 @@ var tree = BI.createWidget({ ### 方法 -| 方法名 | 说明 | 回调参数 | +| 方法名 | 说明 | 参数 | | -------- | ---- | ----------- | | populate | 刷新内容 | items: 子项数组 | | setValue | 设置值 | setValue | diff --git a/uidoc/detailed/table/bi.excel_table.md b/uidoc/detailed/table/bi.excel_table.md index a2b5405b5..92fcb2099 100644 --- a/uidoc/detailed/table/bi.excel_table.md +++ b/uidoc/detailed/table/bi.excel_table.md @@ -39,9 +39,9 @@ BI.createWidget({ ## 参数设置 | 参数 | 说明 | 类型 | 默认值 | | ---------------- | ------------- | -------------------- | ----------------- | -| isNeedResize | 是否需要调整大小 | boolean | false | -| isResizeAdapt | 是否调整时自适应 | boolean | true | -| isNeedMerge | 是否需要合并单元格 | boolean | false | +| isNeedResize | 是否需要调整大小 | boolean | false | +| isResizeAdapt | 是否调整时自适应 | boolean | true | +| isNeedMerge | 是否需要合并单元格 | boolean | false | | mergeCols | 合并的单元格列号 | array | [] | | mergeRule | 合并规则, 默认相等时合并 | function(row1, row2) | 默认row1 = row2 时合并 | | columnSize | 单元格宽度集合 | array | [] | @@ -52,34 +52,33 @@ BI.createWidget({ | items | 子组件 | array | [] | ## 方法 -| 方法名 | 说明 | 用法 | -| ---------------------------- | ---------------- | ------------------------------------ | -| resize | 调整表格 | resize() | -| setColumnSize | 设置列宽 | setColumnSize(columnSize) | -| getColumnSize | 得到列宽 | getColumnSize() | -| getCalculateColumnSize | 获得计算后的列宽 | getCalculateColumnSize() | -| setHeaderColumnSize | 设置表头的列宽 | setHeaderColumnSize(columnSize) | -| setRegionColumnSize | 设置列项之间的间隙 | setRegionColumnSize(columnSize) | -| getRegionColumnSize | 获得列项之间的间隙 | getRegionColumnSize() | -| getCalculateRegionColumnSize | 获取计算后的列项之间的间隙 | getCalculateRegionColumnSize() | -| getCalculateRegionRowSize | 获取计算后的列项上下之间的间隙 | getCalculateRegionRowSize() | -| getClientRegionColumnSize | 获取浏览器中显示的列项之间的间隙 | getClientRegionColumnSize() | -| getScrollRegionColumnSize | 获取横向滚动条宽度 | getScrollRegionColumnSize() | -| getScrollRegionRowSize | 获取纵向滚动条宽度 | getScrollRegionRowSize() | -| hasVerticalScroll | 是否含有数值滚动条 | hasVerticalScroll() | -| setVerticalScroll | 设置纵向滚动距离 | setVerticalScroll(scrollTop) | -| setLeftHorizontalScroll | 设置左到右横向滚动距离 | setLeftHorizontalScroll(scrollLeft) | -| setRightHorizontalScroll | 设置右往左横向滚动距离 | setRightHorizontalScroll(scrollLeft) | -| getVerticalScroll | 获取纵向滚动距离 | getVerticalScroll() | -| getLeftHorizontalScroll | 获取左到右横向滚动距离 | getLeftHorizontalScroll() | -| getRightHorizontalScroll | 获取右往左横向滚动距离 | getRightHorizontalScroll() | -| getColumns | 获取列项 | getColumns() | -| resizeHeader | 调整表头 | resizeHeader() | -| attr | 设置属性 | attr(key, value) | -| populate | 增加行 | populate(rows) | -| destroy | 摧毁表 | destroy() | - - +| 方法名 | 说明 | 参数 | +| ---------------------------- | ---------------- | ------------- | +| resize | 调整表格 | — | +| setColumnSize | 设置列宽 | columnSize | +| getColumnSize | 得到列宽 | — | +| getCalculateColumnSize | 获得计算后的列宽 | — | +| setHeaderColumnSize | 设置表头的列宽 | columnSize | +| setRegionColumnSize | 设置列项之间的间隙 | columnSize | +| getRegionColumnSize | 获得列项之间的间隙 | — | +| getCalculateRegionColumnSize | 获取计算后的列项之间的间隙 | — | +| getCalculateRegionRowSize | 获取计算后的列项上下之间的间隙 | — | +| getClientRegionColumnSize | 获取浏览器中显示的列项之间的间隙 | — | +| getScrollRegionColumnSize | 获取横向滚动条宽度 | — | +| getScrollRegionRowSize | 获取纵向滚动条宽度 | — | +| hasVerticalScroll | 是否含有数值滚动条 | — | +| setVerticalScroll | 设置纵向滚动距离 | scrollTop | +| setLeftHorizontalScroll | 设置左到右横向滚动距离 | scrollLeft | +| setRightHorizontalScroll | 设置右往左横向滚动距离 | scrollLeft | +| getVerticalScroll | 获取纵向滚动距离 | — | +| getLeftHorizontalScroll | 获取左到右横向滚动距离 | — | +| getRightHorizontalScroll | 获取右往左横向滚动距离 | — | +| getColumns | 获取列项 | — | +| resizeHeader | 调整表头 | — | +| attr | 设置属性 | key：键，value：值 | +| populate | 增加行 | rows | +| destroy | 摧毁表 | — | +------ diff --git a/uidoc/detailed/table/bi.page_table.md b/uidoc/detailed/table/bi.page_table.md index 8f48055e5..1dc78f881 100644 --- a/uidoc/detailed/table/bi.page_table.md +++ b/uidoc/detailed/table/bi.page_table.md @@ -56,7 +56,7 @@ BI.createWidget({ ## 方法 -| 方法名 | 说明 | 回调参数 | +| 方法名 | 说明 | 参数 | | ------------------------ | ----------- | ------------------ | | setHPage | 设置水平页数 | v: 页码 | | setVpage | 设置纵向页数 | v: 页码 | @@ -78,3 +78,4 @@ BI.createWidget({ | populate | 增加 | — | | destroy | 摧毁表 | — | +------ \ No newline at end of file diff --git a/uidoc/detailed/table/bi.preview_table.md b/uidoc/detailed/table/bi.preview_table.md index c13d915b3..413a0da99 100644 --- a/uidoc/detailed/table/bi.preview_table.md +++ b/uidoc/detailed/table/bi.preview_table.md @@ -11,21 +11,21 @@ BI.createWidget({ type: "bi.preview_table", header: [[{ - text: "表头1" - }, { - text: "表头2" - }, { - text: "表头3" - }]], + text: "表头1" + }, { + text: "表头2" + }, { + text: "表头3" + }]], element: 'body', columnSize: [100, "", 50], items: [[{ - text: "第一行第一列" - }, { - text: "第一行第二列" - }, { - text: "第一行第三列" - }]] + text: "第一行第一列" + }, { + text: "第一行第二列" + }, { + text: "第一行第三列" + }]] }); ``` @@ -35,7 +35,7 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 默认值 | | ------------- | ---- | ------------ | ----- | -| isNeedFreeze | 是否冻结 | boolean | false | +| isNeedFreeze | 是否冻结 | boolean | false | | freezeCols | 冻结的列 | array | [] | | rowSize | 行高 | array/number | null | | columnSize | 列宽 | array | [] | @@ -44,29 +44,32 @@ BI.createWidget({ | items | 子组件 | array | [] | ## 方法 -| 方法名 | 说明 | 用法 | -| ---------------------------- | ---------------- | ------------------------------------ | -| resize | 调整表格 | resize() | -| setColumnSize | 设置列宽 | setColumnSize(columnSize) | -| getColumnSize | 得到列宽 | getColumnSize() | -| getCalculateColumnSize | 获得计算后的列宽 | getCalculateColumnSize() | -| setHeaderColumnSize | 设置表头的列宽 | setHeaderColumnSize(columnSize) | -| setRegionColumnSize | 设置列项之间的间隙 | setRegionColumnSize(columnSize) | -| getRegionColumnSize | 获得列项之间的间隙 | getRegionColumnSize() | -| getCalculateRegionColumnSize | 获取计算后的列项之间的间隙 | getCalculateRegionColumnSize() | -| getCalculateRegionRowSize | 获取计算后的列项上下之间的间隙 | getCalculateRegionRowSize() | -| getClientRegionColumnSize | 获取浏览器中显示的列项之间的间隙 | getClientRegionColumnSize() | -| getScrollRegionColumnSize | 获取横向滚动条宽度 | getScrollRegionColumnSize() | -| getScrollRegionRowSize | 获取纵向滚动条宽度 | getScrollRegionRowSize() | -| hasVerticalScroll | 是否含有数值滚动条 | hasVerticalScroll() | -| setVerticalScroll | 设置纵向滚动距离 | setVerticalScroll(scrollTop) | -| setLeftHorizontalScroll | 设置左到右横向滚动距离 | setLeftHorizontalScroll(scrollLeft) | -| setRightHorizontalScroll | 设置右往左横向滚动距离 | setRightHorizontalScroll(scrollLeft) | -| getVerticalScroll | 获取纵向滚动距离 | getVerticalScroll() | -| getLeftHorizontalScroll | 获取左到右横向滚动距离 | getLeftHorizontalScroll() | -| getRightHorizontalScroll | 获取右往左横向滚动距离 | getRightHorizontalScroll() | -| getColumns | 获取列项 | getColumns() | -| resizeHeader | 调整表头 | resizeHeader() | -| attr | 设置属性 | attr(key, value) | -| populate | 增加行 | populate(rows) | -| destroy | 摧毁表 | destroy() | \ No newline at end of file +| 方法名 | 说明 | 参数 | +| ---------------------------- | ---------------- | ------------- | +| resize | 调整表格 | — | +| setColumnSize | 设置列宽 | columnSize | +| getColumnSize | 得到列宽 | — | +| getCalculateColumnSize | 获得计算后的列宽 | — | +| setHeaderColumnSize | 设置表头的列宽 | columnSize | +| setRegionColumnSize | 设置列项之间的间隙 | columnSize | +| getRegionColumnSize | 获得列项之间的间隙 | — | +| getCalculateRegionColumnSize | 获取计算后的列项之间的间隙 | — | +| getCalculateRegionRowSize | 获取计算后的列项上下之间的间隙 | — | +| getClientRegionColumnSize | 获取浏览器中显示的列项之间的间隙 | — | +| getScrollRegionColumnSize | 获取横向滚动条宽度 | — | +| getScrollRegionRowSize | 获取纵向滚动条宽度 | — | +| hasVerticalScroll | 是否含有数值滚动条 | — | +| setVerticalScroll | 设置纵向滚动距离 | scrollTop | +| setLeftHorizontalScroll | 设置左到右横向滚动距离 | scrollLeft | +| setRightHorizontalScroll | 设置右往左横向滚动距离 | scrollLeft | +| getVerticalScroll | 获取纵向滚动距离 | — | +| getLeftHorizontalScroll | 获取左到右横向滚动距离 | — | +| getRightHorizontalScroll | 获取右往左横向滚动距离 | — | +| getColumns | 获取列项 | — | +| resizeHeader | 调整表头 | — | +| attr | 设置属性 | key：键，value：值 | +| populate | 替换为新的内容 | rows | +| destroy | 摧毁表 | — | + +------ + diff --git a/uidoc/detailed/table/bi.responsive_table.md b/uidoc/detailed/table/bi.responsive_table.md index c9857cbf4..de0f5e2fa 100644 --- a/uidoc/detailed/table/bi.responsive_table.md +++ b/uidoc/detailed/table/bi.responsive_table.md @@ -15,19 +15,19 @@ BI.createWidget({ mergeCols: [0, 1], columnSize: ["", "", ""], items: [[{ - text: "第一行第一列" - }, { - text: "第一行第二列" - }, { - text: "第一行第三列" - }]], + text: "第一行第一列" + }, { + text: "第一行第二列" + }, { + text: "第一行第三列" + }]], header: [[{ - text: "表头1" - }, { - text: "表头2" - }, { - text: "表头3" - }]], + text: "表头1" + }, { + text: "表头2" + }, { + text: "表头3" + }]], element: 'body' }); ``` @@ -38,46 +38,49 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 默认值 | | ---------------- | ------------------------------------ | -------- | -------- | -| isNeedFreeze | 是否需要冻结单元格 | boolean | false | +| isNeedFreeze | 是否需要冻结单元格 | boolean | false | | freezeCols | 冻结的列号,从0开始,isNeedFreeze为true时生效 | array | [] | -| isNeedMerge | 是否需要合并单元格 | boolean | false | +| isNeedMerge | 是否需要合并单元格 | boolean | false | | mergeRule | function (row1, row2) 合并规则, 默认相等时合并 | function | function | | columnSize | 列宽 | array | [] | | headerRowSize | 表头行高 | number | 25 | | footerRowSize | 表尾行高 | number | 25 | | rowSize | 行高 | number | 25 | | columnSize | 列宽 | array | [] | -| regionColumnSize | | boolean | false | +| regionColumnSize | | boolean | false | | header | 表头内容 | array | [] | -| footer | 是否需要表尾 | boolean | false | +| footer | 是否需要表尾 | boolean | false | | items | 子组件二维数组 | array | [] | | crossHeader | 交叉表头 | array | [] | | crossItems | 交叉表内容二维数组 | array | [] | ## 方法 -| 方法名 | 说明 | 用法 | -| ---------------------------- | ---------------- | ------------------------------------ | -| resize | 调整表格 | resize() | -| setColumnSize | 设置列宽 | setColumnSize(columnSize) | -| getColumnSize | 得到列宽 | getColumnSize() | -| getCalculateColumnSize | 获得计算后的列宽 | getCalculateColumnSize() | -| setHeaderColumnSize | 设置表头的列宽 | setHeaderColumnSize(columnSize) | -| setRegionColumnSize | 设置列项之间的间隙 | setRegionColumnSize(columnSize) | -| getRegionColumnSize | 获得列项之间的间隙 | getRegionColumnSize() | -| getCalculateRegionColumnSize | 获取计算后的列项之间的间隙 | getCalculateRegionColumnSize() | -| getCalculateRegionRowSize | 获取计算后的列项上下之间的间隙 | getCalculateRegionRowSize() | -| getClientRegionColumnSize | 获取浏览器中显示的列项之间的间隙 | getClientRegionColumnSize() | -| getScrollRegionColumnSize | 获取横向滚动条宽度 | getScrollRegionColumnSize() | -| getScrollRegionRowSize | 获取纵向滚动条宽度 | getScrollRegionRowSize() | -| hasVerticalScroll | 是否含有数值滚动条 | hasVerticalScroll() | -| setVerticalScroll | 设置纵向滚动距离 | setVerticalScroll(scrollTop) | -| setLeftHorizontalScroll | 设置左到右横向滚动距离 | setLeftHorizontalScroll(scrollLeft) | -| setRightHorizontalScroll | 设置右往左横向滚动距离 | setRightHorizontalScroll(scrollLeft) | -| getVerticalScroll | 获取纵向滚动距离 | getVerticalScroll() | -| getLeftHorizontalScroll | 获取左到右横向滚动距离 | getLeftHorizontalScroll() | -| getRightHorizontalScroll | 获取右往左横向滚动距离 | getRightHorizontalScroll() | -| getColumns | 获取列项 | getColumns() | -| resizeHeader | 调整表头 | resizeHeader() | -| attr | 设置属性 | attr(key, value) | -| populate | 增加行 | populate(rows) | -| destroy | 摧毁表 | destroy() | \ No newline at end of file +| 方法名 | 说明 | 参数 | +| ---------------------------- | ---------------- | ------------- | +| resize | 调整表格 | — | +| setColumnSize | 设置列宽 | columnSize | +| getColumnSize | 得到列宽 | — | +| getCalculateColumnSize | 获得计算后的列宽 | — | +| setHeaderColumnSize | 设置表头的列宽 | columnSize | +| setRegionColumnSize | 设置列项之间的间隙 | columnSize | +| getRegionColumnSize | 获得列项之间的间隙 | — | +| getCalculateRegionColumnSize | 获取计算后的列项之间的间隙 | — | +| getCalculateRegionRowSize | 获取计算后的列项上下之间的间隙 | — | +| getClientRegionColumnSize | 获取浏览器中显示的列项之间的间隙 | — | +| getScrollRegionColumnSize | 获取横向滚动条宽度 | — | +| getScrollRegionRowSize | 获取纵向滚动条宽度 | — | +| hasVerticalScroll | 是否含有数值滚动条 | — | +| setVerticalScroll | 设置纵向滚动距离 | scrollTop | +| setLeftHorizontalScroll | 设置左到右横向滚动距离 | scrollLeft | +| setRightHorizontalScroll | 设置右往左横向滚动距离 | scrollLeft | +| getVerticalScroll | 获取纵向滚动距离 | — | +| getLeftHorizontalScroll | 获取左到右横向滚动距离 | — | +| getRightHorizontalScroll | 获取右往左横向滚动距离 | — | +| getColumns | 获取列项 | — | +| resizeHeader | 调整表头 | — | +| attr | 设置属性 | key：键，value：值 | +| populate | 替换为新内容 | rows | +| destroy | 摧毁表 | — | + +------ + diff --git a/uidoc/detailed/tree/bi.multi_tree_combo.md b/uidoc/detailed/tree/bi.multi_tree_combo.md index 864c80c4d..dca879fad 100644 --- a/uidoc/detailed/tree/bi.multi_tree_combo.md +++ b/uidoc/detailed/tree/bi.multi_tree_combo.md @@ -46,11 +46,11 @@ BI.createWidget({ | itemsCreator | 子项创建函数 | function | function() {} | ## 方法 -| 方法名 | 说明 | 用法 | +| 方法名 | 说明 | 参数 | | -------- | ------- | --------------- | -| setValue | 设置文本框值 | setValue(v) | -| getValue | 获取文本框值 | getValue() | -| populate | 更改树结构内容 | populate(items) | +| setValue | 设置文本框值 | v | +| getValue | 获取文本框值 | — | +| populate | 更改树结构内容 | items | ## 事件 | 事件 | 说明 | diff --git a/uidoc/detailed/tree/bi.switch_tree.md b/uidoc/detailed/tree/bi.switch_tree.md index 6df36d1da..b1e330207 100644 --- a/uidoc/detailed/tree/bi.switch_tree.md +++ b/uidoc/detailed/tree/bi.switch_tree.md @@ -38,16 +38,16 @@ var tree = BI.createWidget({ | items | 子项，pId代表父节点ID | array | [] | ## 方法 -| 方法名 | 说明 | 用法 | +| 方法名 | 说明 | 参数 | | ------------ | --------- | ------------ | -| switchSelect | 切换树结构 | switchSelect | -| setSelect | 设置选中项 | setSelect(v) | -| getSelect | 获取选中项 | getSelect() | -| setValue | 设置当前选中项内容 | setValue(v) | -| getValue | 获取当前选中项内容 | getValue(v) | -| populate | 更新内容 | populate(items) | - - +| switchSelect | 切换树结构 | — | +| setSelect | 设置选中项 | v | +| getSelect | 获取选中项 | — | +| setValue | 设置当前选中项内容 | v | +| getValue | 获取当前选中项内容 | v | +| populate | 更改树结构内容 | items | + +------