From 5e8a2eca63a2fa113892797cc9553bf99e80595e Mon Sep 17 00:00:00 2001 From: WoodyJang Date: Thu, 31 Aug 2017 20:44:16 +0800 Subject: [PATCH] =?UTF-8?q?=E5=9F=BA=E7=A1=80=E6=8E=A7=E4=BB=B6=EF=BC=8C?= =?UTF-8?q?=E6=8A=BD=E8=B1=A1=E6=8E=A7=E4=BB=B6fineUI=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E7=9A=84=E7=BC=96=E5=86=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- uidoc/base/button/button.md | 72 +++++++++++++++++++++++- uidoc/base/button/icon_button.md | 39 ++++++++++++- uidoc/base/button/image_button.md | 49 ++++++++++++++++- uidoc/base/button/text_button.md | 58 +++++++++++++++++++- uidoc/base/canvas.md | 79 ++++++++++++++++++++++++++- uidoc/base/editor/code_editor.md | 53 +++++++++++++++++- uidoc/base/editor/editor.md | 71 +++++++++++++++++++++++- uidoc/base/editor/formula_editor.md | 57 ++++++++++++++++++- uidoc/base/editor/multifile_editor.md | 46 +++++++++++++++- uidoc/base/editor/textarea_editor.md | 45 ++++++++++++++- uidoc/base/pager.md | 66 +++++++++++++++++++++- uidoc/base/svg.md | 71 +++++++++++++++++++++++- uidoc/core/basic_button.md | 47 +++++++++++++++- uidoc/core/single.md | 39 ++++++++++++- uidoc/core/widget.md | 76 +++++++++++++++++++++++++- uidoc/detailed/bi.button/general.md | 56 +------------------ 16 files changed, 854 insertions(+), 70 deletions(-) diff --git a/uidoc/base/button/button.md b/uidoc/base/button/button.md index c0fb6e5b3..9a3211fcc 100644 --- a/uidoc/base/button/button.md +++ b/uidoc/base/button/button.md @@ -1,2 +1,72 @@ -# button +# bi.button + +## 文字类型的按钮,基类[BI.BasicButton](/core/basicButton.md) + +{% method %} +[source](https://jsfiddle.net/fineui/txqwwzLm/) + +{% common %} +```javascript + +BI.createWidget({ + type: 'bi.button', + element: "#wrapper", + text: '一般按钮', + level: 'common', + height: 30 +}); + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| hgap | 效果相当于文本框左右padding值，如果clear属性为true,该属性值置0 | 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 | | | | + + +##### 高级属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| level |按钮类型 | string| common,success,warning,ignore | common | +| text|按钮文本内容 | string| | | +| disabled|灰化 | boolean| true,false | | +| minWidth | 最小宽度，如果block/clear中某一项为true，此项值为0，否则为90 | number | | 90 | +| shadow | | boolean| true,false | | +| isShadowShowingOnSelected|选中状态下是否显示阴影 | boolean| true,false | true | +| readonly | 是否只读 | boolean | true,false | true | +| iconClass | 图标类型 | string| | " "| +| block| 是否块状显示，即不显示边框，没有最小宽度的限制 | boolean| true,false | false | +| clear| 是否去掉边框和背景 |boolean| true,false | false | +| textAlign | 文字布局 | string | left,center,right | cneter | +| whiteSpace | 元素内的空白处理方式 | string | normal,nowrap | nowrap| +| forceCenter | 是否无论如何都要居中, 不考虑超出边界的情况, 在未知宽度和高度时有效 | boolean | true,false | false | +| textWidth| 按钮文本宽度 | number| | null | +| textHeight | 按钮文本高度 | number| | null | + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| doRedMark | 文本标红 | — | +| unRedMark | 取消文本标红| —| +| doHighLight | 文本高亮 | —| +| unHighLight | 取消文本高亮 | —| +| setText| 设置文本值 | 需要设置的文本值text| +| doClick | 点击事件 | —| +| destroy | 销毁事件 |— | +| setValue | 设置文本值 | 需要设置的文本值text | + +--- + diff --git a/uidoc/base/button/icon_button.md b/uidoc/base/button/icon_button.md index 32039f0ed..e7e343e87 100644 --- a/uidoc/base/button/icon_button.md +++ b/uidoc/base/button/icon_button.md @@ -1,2 +1,39 @@ -# icon_button +# bi.icon_button + +## 图标button,基类[BI.BasicButton](/core/basicButton.md) + +{% method %} +[source](https://jsfiddle.net/fineui/g52u14ay/) + +{% common %} +```javascript + +BI.createWidget({ + type: 'bi.icon_button', + cls: "close-ha-font", + width: 20, + height: 20 +}); + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| iconWidth | 图标宽度 | number| | null | +| iconHeight | 图标高度 | number| | null | + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| doClick | 点击事件 | —| + + +--- + diff --git a/uidoc/base/button/image_button.md b/uidoc/base/button/image_button.md index a674282c6..7c7f3b97f 100644 --- a/uidoc/base/button/image_button.md +++ b/uidoc/base/button/image_button.md @@ -1,2 +1,49 @@ -# image_button +# bi.image_button + +## 图片的button,基类[BI.BasicButton](/core/basicButton.md) + +{% method %} +[source](https://jsfiddle.net/fineui/yc0g9gLw/) + +{% common %} +```javascript + +BI.createWidget({ + type: 'bi.image_button', + src: "http://www.easyicon.net/api/resizeApi.php?id=1206741&size=128", + width: 100, + height: 100 +}); + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| src |图片路径 |string | |" " | +| iconWidth | 图标宽度 | number/string| | "100%" | +| iconHeight | 图标高度 | number/string | | "100%"| + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| doClick | 点击事件 | —| +| setWidth | 设置按钮宽度| 宽度width | +| setHeight | 设置按钮高度 | 高度height| +| setImageWidth | 设置图片宽度| 宽度width | +| setImageHeight| 设置图片高度| 高度height| +| getImageWidth | 获取图片宽度| —| +| getImageHeight | 获取图片高度| —| +| setSrc| 设置图片路径| src | +| getSrc |获取图片路径| — | + + + +--- + diff --git a/uidoc/base/button/text_button.md b/uidoc/base/button/text_button.md index a3ab533c9..e0225c1c5 100644 --- a/uidoc/base/button/text_button.md +++ b/uidoc/base/button/text_button.md @@ -1,2 +1,58 @@ -# text_button +# bi.text_button + +## 可以点击的一行文字,基类[BI.BasicButton](/core/basicButton.md) + +{% method %} +[source](https://jsfiddle.net/fineui/5p99L39q/) + +{% common %} +```javascript + +BI.createWidget({ + type: 'bi.text_button', + text: '文字按钮', + height: 30 +}); + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| hgap | 效果相当于文本框左右padding值，如果clear属性为true,该属性值置0 | number | | 10 | +| lgap | 效果相当于文本框left-padding值 | number | | 0 | +| rgap | 效果相当于文本框right-padding值 | number | | 0 | +| text|按钮文本内容 | string| | | +| textWidth| 按钮文本宽度 | number| | null | +| textHeight | 按钮文本高度 | number| | null | + + +##### 高级属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| py | | string| | " " | +| textAlign | 文字布局 | string | left,center,right | cneter | +| whiteSpace | 元素内的空白处理方式 | string | normal,nowrap | nowrap| +| forceCenter | 是否无论如何都要居中, 不考虑超出边界的情况, 在未知宽度和高度时有效 | boolean | true,false | false | + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| doRedMark | 文本标红 | — | +| unRedMark | 取消文本标红| —| +| doHighLight | 文本高亮 | —| +| unHighLight | 取消文本高亮 | —| +| setText| 设置文本值 | 需要设置的文本值text| +| doClick | 点击事件 | —| +| setValue | 设置文本值 | 需要设置的文本值text | +| setStyle | 设置文本样式 |需要设置的文本标签样式,例{"color":"#000"} | + + +--- + diff --git a/uidoc/base/canvas.md b/uidoc/base/canvas.md index 42f801f6d..13d462c3c 100644 --- a/uidoc/base/canvas.md +++ b/uidoc/base/canvas.md @@ -1,2 +1,79 @@ -# canvas +# bi.canvas + +## canvas绘图,基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/txqwwzLm/) + +{% common %} +```javascript + +var canvas = BI.createWidget({ + type: "bi.complex_canvas", + width: 500, + height: 600 + }); +canvas.branch(55, 100, 10, 10, 100, 10, 200, 10, { + offset: 20, + strokeStyle: "red", + lineWidth: 2 + }); + + canvas.branch(220, 155, 120, 110, 150, 200, { + offset: 40 + }); + + canvas.stroke(); + + BI.createWidget({ + type: "bi.absolute", + element: this, + items: [{ + el: canvas, + left: 100, + top: 50 + }] + }) + + +``` + +{% endmethod %} + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| add | 添加对象到json数组 | json | +| path | 绘制路径 | pathString | +| image | 绘制图片 | (src,x,y,w,h)分别表示图片路径，绘制的原点横、纵坐标，宽、高 | +| rect | 绘制矩形 | (x,y,w,h,r)分别表示左上角的横坐标、纵坐标，矩形宽、高、以及矩形的圆角border-radius大小| +| circle | 绘制圆形 | (x,y,r)分别表示原点的横坐标，纵坐标，以及半径 | +| ellipse | 绘制椭圆 |(x,y,rx,ry)分别表示原点的横、纵坐标，以及水平半径和垂直半径| +| text | 绘制文本 | (x,y,text)分别表示绘制的原点横、纵坐标以及要绘制的文本内容| +| print | 根据制定参数打印出路径 | (x, y, string, font, size, origin, letter_spacing, line_spacing) | +| setStart | 开始绘制 | | +| setFinish | 结束绘制 | | +| setSize | 设置画布尺寸 | (width,height)分别表示画布宽高| +| setViewBox | 设置画布可视区域 | (x,y,width,height,fit)分别表示可视区域原点坐标以及可视区域宽高，以及是否根据可视区域进行调整 | +| getById | 根据id返回元素 | id | +| getElementByPoint | 获根据给定的点坐标返回元素 | (x,y)| +| getElementsByPoint | 获根据给定的点坐标返回元素 | (x,y) | +| getFont | 通过给定的参数在已注册的字体中找到字体对象 | (family, weight, style, stretch) | +| set | 绘制形状的集合 | | +| remove | 设置总页数 | pages | +| clear | 判断是否有上一页 | v | + + + | line | 绘制线段| (x0, y0, x1, y1) | + | rect | 绘制矩形 | (x,y,w,h,color)分别表示左上角的横坐标、纵坐标，矩形宽、高、以及绘制的颜色| + | circle | 绘制圆形 | (x, y, radius, color)分别表示原点的横坐标，纵坐标，半径以及颜色 | +| hollow | 填充中空的路径 | | +| solid | 填充实心的路径 | | +| gradient | 绘制渐变色 | (x0, y0, x1, y1, start, end) | +| reset | 重置画布 | —| +| stroke | 绘制 | callback | + +--- + diff --git a/uidoc/base/editor/code_editor.md b/uidoc/base/editor/code_editor.md index a403ba9a9..970d2b92b 100644 --- a/uidoc/base/editor/code_editor.md +++ b/uidoc/base/editor/code_editor.md @@ -1,2 +1,53 @@ -# code_editor +# bi.code_editor + +## 文本框,基类[BI.Single](/core/single.md) + +{% method %} +[source](https://jsfiddle.net/fineui/txqwwzLm/) + +{% common %} +```javascript + +BI.createWidget({ + type: "bi.code_editor", + cls: "mvc-border", + width: 600, + height: 400 +}); + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| watermark | 文本框placeholder | string | | " " | +| readOnly | 是否只读 | boolean | true,false | false| +| lineHeight | 行高 | number|— | 2| +| value | 文本框值| string| | " "| +| paramFormatter| 参数显示值构造函数 | function| | value | + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| insertParam | 插入参数 | param | +| insertString | 插入字符串 | str| +| getValue | 获取文本框值|—| +| setValue | 设置文本框值|value| +| focus | 文本框获取焦点| — | +| blur | 文本框失焦|—| +| setStyle | 设置文本样式 |需要设置的文本标签样式style,例{"color":"#000"} | +| getStyle | 获取文本样式 |— | +| refresh | 刷新文本框 | —| + + + + +--- + diff --git a/uidoc/base/editor/editor.md b/uidoc/base/editor/editor.md index dd049c3e7..dc577dcd0 100644 --- a/uidoc/base/editor/editor.md +++ b/uidoc/base/editor/editor.md @@ -1,2 +1,71 @@ -# editor +# bi.editor + +## 文本框,基类[BI.Single](/core/single.md) + +{% method %} +[source](https://jsfiddle.net/fineui/txqwwzLm/) + +{% common %} +```javascript + +BI.createWidget({ + type: "bi.editor", + element: "#wrapper", + errorText: "字段不可重名!", + width: 200, + height: 30 +}); + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| hgap | 效果相当于文本框左右padding值 | number | | 4 | +| vgap | 效果相当于文本框上下padding值 | number | | 2 | +| lgap | 效果相当于文本框left-padding值 | number | | 0 | +| rgap | 效果相当于文本框right-padding值 | number | | 0 | +| tgap |效果相当于文本框top-padding值 | number | | 0 | +| 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 | | " "| +| tipType| 提示类型 | string |success,warning | "warning"| +| inputType| 输入框类型| string| | "text"| + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| setErrorText | 设置错误文本 | text | +| getErrorText | 获取错误文本 | —| +| setErrorVisible | 设置错误文本可见|b | +| disableError | 设置error不可用|— | +| enableError| 设置error可用| —| +| disableWaterMark | 设置文本框placeholder不可用| —| +| enableWaterMark | 恢复文本框placeholder可用| — | +| focus | 文本框获取焦点| — | +| blur | 文本框失焦|—| +| selectAll | 选中文本框文本| —| +| onKeyDown |按键事件|key| +| setValue | 设置文本框值|value| +| getLastValidValue | 获取文本框最后一次输入的有效值| —| +| resetLastValidValue| 重置文本框最后一次输入的有效值|value| +| getValue | 获取文本框值|—| +| isEditing | 文本框是否处于编辑状态|—| +| isValid | 文本框值是否有效|—| + + + + +--- + diff --git a/uidoc/base/editor/formula_editor.md b/uidoc/base/editor/formula_editor.md index 2b2797eab..5d0526031 100644 --- a/uidoc/base/editor/formula_editor.md +++ b/uidoc/base/editor/formula_editor.md @@ -1,2 +1,57 @@ -# formula_editor +# bi.formula_editor + +## 公式编辑控件,基类[BI.Single](/core/single.md) + +{% method %} +[source](https://jsfiddle.net/fineui/txqwwzLm/) + +{% common %} +```javascript + +BI.createWidget({ + type : 'bi.formula_editor', + width : 300, + height : 200, + value : 'SUM(C5, 16, 26)' +}); + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| value | 文本域的值 | string | | " "| +| watermark | 文本框placeholder| string | | " " | +| fieldTextValueMap | | string| | {}| +| showHint | | | | 2 | +| lineHeight | 行高 | number | | 2| + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| disableWaterMark | 设置文本框placeholder不可用 | — | +| focus | 文本框获取焦点| — | +| insertField | 添加字段 | field | +| insertFunction | | fn | +| insertOperator | | op| +| setFunction | | v| +| insertString | 插入字符串 | str| +| getFormulaString | |— | +| getUsedFields | | — | +| getCheckString | | — | +| getValue | 获取文本框值|—| +| setValue | 设置文本框值|value| +| setFieldTextValueMap | | fieldTextValueMap | +| refresh | 刷新文本框 | —| + + + +--- + diff --git a/uidoc/base/editor/multifile_editor.md b/uidoc/base/editor/multifile_editor.md index 8b0b69101..bb49f39ed 100644 --- a/uidoc/base/editor/multifile_editor.md +++ b/uidoc/base/editor/multifile_editor.md @@ -1,2 +1,46 @@ -# multifile_editor +# bi.multifile_editor + +## 多文件,基类[BI.Single](/core/single.md) + +{% method %} +[source](https://jsfiddle.net/fineui/txqwwzLm/) + +{% common %} +```javascript + +BI.createWidget({ + type: "bi.multifile_editor", + width: 400, + height: 300 +}); + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| multiple | 是否支持多选 | boolean | true,false| false | +| maxSize | 最大可选数量 | number | | -1 | +| accept | | string | | " "| +| url | 文件路径 | string | | " "| + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| select | 选择文件 | —| +| getValue | 获取文件名称 | —| +| upload | 文件上传| —| +| reset | 重置| —| + + + + +--- + diff --git a/uidoc/base/editor/textarea_editor.md b/uidoc/base/editor/textarea_editor.md index 084605944..579748e30 100644 --- a/uidoc/base/editor/textarea_editor.md +++ b/uidoc/base/editor/textarea_editor.md @@ -1,2 +1,45 @@ -# textarea_editor +# bi.textarea_editor + +## 文本域,基类[BI.Single](/core/single.md) + +{% method %} +[source](https://jsfiddle.net/fineui/txqwwzLm/) + +{% common %} +```javascript + +BI.createWidget({ + type: "bi.textarea_editor", + width: 400, + height: 300 +}); + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| value | 文本域的值 | string | | " "| + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| getValue | 获取文本域值|—| +| setValue | 设置文本域值|value| +| setStyle | 设置文本域样式 |需要设置的文本域样式style,例{"color":"#000"} | +| getStyle | 获取文本域样式 |— | +| focus | 文本域获取焦点| — | +| blur | 文本域失焦|—| + + + + +--- + diff --git a/uidoc/base/pager.md b/uidoc/base/pager.md index 1103321e3..f8b64ca46 100644 --- a/uidoc/base/pager.md +++ b/uidoc/base/pager.md @@ -1,2 +1,66 @@ -# pager +# bi.pager + +## 分页控件,基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/txqwwzLm/) + +{% common %} +```javascript + +BI.createWidget({ + type: "bi.pager", + height: 50, + pages: 18, + groups: 5, + curr: 6, + first: "首页", + last: "尾页" +}); + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| behaviors | | object| | {}| +| layouts | 布局| array | | {type:"bi.horizontal",hgap:10,vgap:0} | +| dynamicShow | 是否动态显示上一页、下一页、首页、尾页， 若为false，则指对其设置使能状态 | boolean| true,false | true| +| dynamicShowFirstLast | 是否动态显示首页、尾页,dynamicShow为false时生效| boolean| true,false | false | +| dynamicShowPrevNext | 是否动态显示上一页、下一页,dynamicShow为false时生效 | boolean| true,false | false| +| pages | 是否显示总页数 | boolean| true,false|false| +| curr | 初始化当前页 | function | | function(){return 1;}| +| groups | 连续显示分页数 | number | | 0 | +| jump | 页数跳转| function | | | +| first | 是否显示首页 | boolean | true,false| false| +| last | 是否显示尾页 | boolean | true,false| false| +| prev | 上一页 | string,object | |"上一页" | +| next | 下一页 | sting,object| | "下一页" | +| firstPage | 第一页 | number| | 1 | +| lastPage | 最后一页,在万不得已时才会调用这个函数获取最后一页的页码, 主要作用于setValue方法 | function | | function(){ return 1;}| +| hasPrev | 判断是否有上一页,pages不可用时有效 | function | | — | +| hasNext | 判断是否有下一页,pages不可用时有效 | function | | — | + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| getCurrentPage | 获取当前页码 | —| +| setAllPages | 设置总页数 | pages | +| hasPrev | 判断是否有上一页 | v | +| hasNext | 判断是否有下一页 | v | +| setValue | 设置当前页码 | v | +| getValue | 获取当前页码 | | +| attr | 设置属性 | key,value | +| populate | | —| + + + + +--- + diff --git a/uidoc/base/svg.md b/uidoc/base/svg.md index fe1d29b6b..8100bf5b2 100644 --- a/uidoc/base/svg.md +++ b/uidoc/base/svg.md @@ -1,2 +1,71 @@ -# svg +# bi.svg + +## svg绘图,基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/txqwwzLm/) + +{% common %} +```javascript + +var svg = BI.createWidget({ + type: "bi.svg", + width: 500, + height: 600 + }); + +var circle = svg.circle(100, 100, 10); +circle.animate({fill: "#223fa3", stroke: "#000", "stroke-width": 80, "stroke-opacity": 0.5}, 2000); + +var el = svg.rect(10, 200, 300, 200); +el.transform("t100,100r45t-100,0"); + +svg.path("M10,10L50,50M50,10L10,50") + .attr({stroke: "red"}); + +BI.createWidget({ + type: "bi.absolute", + element: this, + items: [{ + el: svg, + left: 100, + top: 50 + }] +}) + + +``` + +{% endmethod %} + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| add | 添加对象到json数组 | json | +| path | 绘制路径 | pathString | +| image | 绘制图片 | (src,x,y,w,h)分别表示图片路径，绘制的原点横、纵坐标，宽、高 | +| rect | 绘制矩形 | (x,y,w,h,r)分别表示左上角的横坐标、纵坐标，矩形宽、高、以及矩形的圆角border-radius大小| +| circle | 绘制圆形 | (x,y,r)分别表示原点的横坐标，纵坐标，以及半径 | +| ellipse | 绘制椭圆 |(x,y,rx,ry)分别表示原点的横、纵坐标，以及水平半径和垂直半径| +| text | 绘制文本 | (x,y,text)分别表示绘制的原点横、纵坐标以及要绘制的文本内容| +| print | 根据制定参数打印出路径 | (x, y, string, font, size, origin, letter_spacing, line_spacing) | +| setStart | 开始绘制 | | +| setFinish | 结束绘制 | | +| setSize | 设置画布尺寸 | (width,height)分别表示画布宽高| +| setViewBox | 设置画布可视区域 | (x,y,width,height,fit)分别表示可视区域原点坐标以及可视区域宽高，以及是否根据可视区域进行调整 | +| getById | 根据id返回元素 | id | +| getElementByPoint | 获根据给定的点坐标返回元素 | (x,y)| +| getElementsByPoint | 获根据给定的点坐标返回元素 | (x,y) | +| getFont | 通过给定的参数在已注册的字体中找到字体对象 | (family, weight, style, stretch) | +| set | 绘制形状的集合 | | +| remove | 设置总页数 | pages | +| clear | 判断是否有上一页 | v | + + + + + +--- + diff --git a/uidoc/core/basic_button.md b/uidoc/core/basic_button.md index e47eb4e49..131362d37 100644 --- a/uidoc/core/basic_button.md +++ b/uidoc/core/basic_button.md @@ -1,2 +1,47 @@ -# basic_button +# bi.basci_button + +## 一般的button父级,基类[BI.Single](/core/single.md) + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| value | 组件value值 | string | | null| +| text | 文本内容 | string | | " " | +| stopEvent | 阻止冒泡 |boolean | true,false | false | +| stopPropagation | 阻止冒泡 | boolean | true,false| false | +| selected | 选中文本值 | boolean | true,false |false | +| once | 点击一次选中有效,再点无效 | boolean | true,false | false| +| forceSelected | 点击即选中, 选中了就不会被取消,与once的区别是forceSelected不影响事件的触发| boolean | true,false| false| +| forceNotSelected | 无论怎么点击都不会被选中 | boolean| true,false | false| +| disableSelected | 使能选中| boolean | true,false| false| +| shadow | 是否显示阴影 | boolean| true,false| false| +| isShadowShowingOnSelected| 选中状态下是否显示阴影|boolean| true,false | false| +| trigger | 被选元素要触发的事件 | | | null| +| handler | | | | | + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| bindEvent | 绑定事件| —| +| beforeClick | 点击事件之前 | —| +| doClick | 点击事件 | — | +| handle | 返回该对象 | —| +| hover | hover事件| —| +| dishover | 取消hover事件| —| +|setSelected | 设置选中的文本| b| +| isSelected | 是否被选中| —| +| isOnce | 是否只允许点击一次| —| +| isForceSelected| 判断是否点击即选中| —| +| isForceNotSelected| 判断是否怎么点击都不会被选中|—| +| isDisableSelected| 判断是否让选中|—| +| setText| 设置文本值|—| +| getText| 获取文本值|—| +| empty| 清空组件|—| +| destroy| 销毁组件|—| + + +--- + diff --git a/uidoc/core/single.md b/uidoc/core/single.md index 8c4f16ad3..296b9932b 100644 --- a/uidoc/core/single.md +++ b/uidoc/core/single.md @@ -1,2 +1,39 @@ -# single +# bi.single + +## 这仅仅只是一个超类, 所有简单控件的基类,类的控制,title的控制,文字超过边界显示3个点,cursor默认pointor,基类[BI.Widget](/core/widget.md) + + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| readonly | 是否只读 | boolean | true,false| false | +| title | title | string | | null | +| warningTitle | 错误title | string | | null| +| tipType | title类型 | string | success,warning | null | +| value | 组件value值 | string | | null | + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| enableHover | 恢复hover可用| opt | +| disabledHover | 取消hover事件 | —| +| populate | | —| +| setTitle | 设置title| title,opt | +| setWarningTitle | 设置错误title | title,opt| +| getTipType | 获取tipType|—| +| isReadOnly | 是否只读| —| +| getTitle | 获取title|—| +| getWarningTitle | 获取warningtitle| —| +| setValue | 设置value值| value| +|getValue| 获取value值| —| + + + + + +--- + diff --git a/uidoc/core/widget.md b/uidoc/core/widget.md index 3e982fa23..d630ed4b1 100644 --- a/uidoc/core/widget.md +++ b/uidoc/core/widget.md @@ -1,2 +1,76 @@ -# widget +# bi.widget + +## Widget超类 + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| root | | boolean | true,false | false | +| tagName | | string| | "div" | +| attributes | | | | null | +| data | | | | null | +| disabled | 是否可用 | boolean |true,false | false | +| invisible | | boolean | true,false | false| +| invalid | 是否有效 | boolean | true,false |false | +| baseCls | 基础class类 | string | | " "| +| extraCls | 扩展class类 | string| | " "| +| cls | class类名 | string | | " "| + +## 生命周期函数 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| beforeCreate | 组件实例刚被创建 |— | +| created | 组件实例创建完成 | —| +| render | 渲染组件 | — | +| beforeMounted | 组件挂载之前| —| +| mounted | 组件挂载 |—| +| update | 组件更新 | —| +| beforeDestroyed | 组件销毁前调用| —| +| destroyed | 组件销毁后调用 | —| + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| isMounted | 判断组件是否挂载| — | +| setWidth | 设置组件宽度 | width | +| setHeight | 设置组件高度 | height | +| setEnable | 设置组件是否可用 | enable | +| setVisible | 设置组件是否可见 | visible | +| setValid | 设置组件是否有效 | valid| +| doBehavior | | —| +| getWidth | 获取组件宽度 | —| +| getHeight| 获取组件高度| —| +| isValid | 判断是否有效 | —| +| addWidget | 添加组件 | name,widget| +| getWidgetByName | 根据组件名称获取组件| name | +| removeWidget | 移除组件 | nameOrWidget | +| hasWidget | 判断是否有该组件 | name | +| getName | 获取组件名称 | | +| setTag | 设置tag | tag | +| getTag | 获取tag | —| +| attr | 设置组件属性 | key,value | +| getText | 获取text值 | —| +| setText | 设置text值 | text| +| getValue | 获取value值 | —| +|setValue| 设置value值| value| +| isEnabled | 是否可用 | —| +| isVisible | 是否可见 | —| +| disable | 设置组件不可用 | —| +| enable | 设置组件可用| —| +| valid | 设置组件有效| —| +|invalid | 设置组件无效 | —| +| invisible | 设置组件不可见 | —| +| visible | 设置组件可见 | —| +| isolate | | —| +| empty | 清空组件 | —| +| destroy | 销毁组件| —| + + + + + +--- + diff --git a/uidoc/detailed/bi.button/general.md b/uidoc/detailed/bi.button/general.md index ad90e1e8e..76159e264 100644 --- a/uidoc/detailed/bi.button/general.md +++ b/uidoc/detailed/bi.button/general.md @@ -1,60 +1,6 @@ # bi.button -##通用按钮 - -{% method %} -[source](https://jsfiddle.net/fineui/txqwwzLm/) - -{% common %} -```javascript - -BI.createWidget({ - type: 'demo.buttons', - element: "#wrapper", - text: '一般按钮', - level: 'common', - height: 30 -}); - - -``` - -{% endmethod %} - -## API -##### 基础属性 -| 参数 | 说明 | 类型 | 可选值 | 默认值 -| :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于文本框左右padding值，如果clear属性为true,该属性值置0 | 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 | | | - - -##### 高级属性 -| 参数 | 说明 | 类型 | 可选值 | 默认值 -| :------ |:------------- | :-----| :----|:---- -| level |按钮类型 | string| common,success,warning,ignore | common | -| text|按钮文本内容 | string| | | -| disabled|灰化 | boolean| true,false | | -| minWidth | 最小宽度，如果block/clear中某一项为true，此项值为0，否则为90 | number | | 90 | -| shadow | | boolean| true,false | | -| isShadowShowingOnSelected| | boolean| true,false | true | -| readonly | 是否只读 | boolean | true,false | true | -| iconClass | 图标类型 | string| | " "| -| block| 是否块状显示，即不显示边框，没有最小宽度的限制 | boolean| true,false | false | -| clear| 是否去掉边框和背景 |boolean| true,false | false | -| textAlign | 文字布局 | string | left,center,right | cneter | -| whiteSpace | 元素内的空白处理方式 | string | normal,nowrap | nowrap| -| forceCenter | 是否无论如何都要居中, 不考虑超出边界的情况, 在未知宽度和高度时有效 | boolean | true,false | false | -| textWidth| 按钮文本宽度 | number| | null | -| textHeight | 按钮文本高度 | number| | null | - +## 通用按钮,详情见[BI.button](/base/button/button.md) ---