# 窗体操作说明文档
## api列表
- [vdk.win.redirectTo](#vdkwinredirecttoobject-object)
- [vdk.win.getParam](#vdkwingetparamstring-key)
- [vdk.page.redirectToElement](#vdkwinredirectToElementobject-object)
---
## vdk.win.redirectTo(Object object)
关闭当前页面，跳转到指定的某个页面。
### 参数
Object object
|属性|类型|默认值|必填|说明|
|-------|--------|-------|-------|-------|
|componentCode  |string     |   |是 |构件编号                   |
|windowCode     |string     |   |是 |窗体编号                   |
|context        |Object     |   |否 |当前vue组件对象      |
|params         |Object     |   |否 |窗体入参                   |
|success        |function   |   |否 |窗体跳转成功后的回调函数     |
|fail           |function   |   |否 |窗体跳转失败后的回调函数      |
#### object.params说明
params为Object对象，其中key为入参编号，值为入参值。
#### object.success说明
窗体跳转成功后执行该函数，无参数值。
#### object.fail说明
webapi调用失败后执行该函数，其参数值为Object对象。
#### object.context说明
当前vue组件对象
### 返回：void
### 示例代码
```js
import vdk from 'v3-vdk';
vdk.win.redirectTo({
    componentCode : "componentCode1",
    windowCode : "windowCode1",
    context:this,
    params : {
        param1 : "test",
        param2 : 2,
        param3 : true
    },
    success : function(){
        //do something
    },
    fail : function(){
        // do something
    }
});
```
---
### vdk.page.getParam(Object object)
获取窗体入参信息，key对应为窗体跳转时参数Object.object的key值。如果key不存在，将返回null。
#### 参数
Object object
|属性|类型|默认值|必填|说明|
|--------|-----------|---|---|---------|
|context |Object     |   |是 |上下文（vue实例）           |
|key     |Object     |   |是 |入参编码  |
##### object.context说明
context为vue实例对象，如在vue单文件组件中使用该接口，传递this即可
##### object.key说明
key对应为窗体入参编码
#### 返回：Any
#### 示例代码
```js
import vdk from 'v3-vdk';
let rs = vdk.page.getParam({
    context: this,
    key:"param1"
});//rs = 2
```
---
### vdk.page.redirectToElement(Object object)
打开窗体到指定Dom元素里
#### 参数
Object object
|属性|类型|默认值|必填|说明|
|--------|-----------|---|---|---------|
|componentCode  |string         |   |是 |构件编号                   |
|windowCode     |string         |   |是 |窗体编号                   |
|el             |string/object  |   |是 |Dom元素对象或者id值                   |
|context        |Object         |   |否 |当前vue组件对象      |
|params         |Object         |   |否 |窗体入参                   |
|fail           |function       |   |否 |窗体打开失败后的回调函数      |
#### object.params说明
params为Object对象，其中key为入参编号，值为入参值。
#### object.fail说明
‘；
窗体打开失败后执行该函数。/1
#### object.context说明
当前vue组件对象
#### 返回：void
#### 示例代码
```js
import vdk from 'v3-vdk';
vdk.page.redirectToElement({
    componentCode : "componentCode1",
    windowCode : "windowCode1",
    context:this,
    el:'domId',
    params : {
        param1 : "test",
        param2 : 2,
        param3 : true
    },
    fail : function(){
        // do something
    }
});
```
---
### vdk.page.renderFromPortalMenu(Object object)
渲染门户菜单
#### 参数
Object object
|属性|类型|默认值|必填|说明|
|--------|-----------|---|---|---------|
|type           |string         |   |是 |打开方式可选值：1、homeTab（首页，默认值），2、modal（模态）                  |
|menuCode       |string         |   |是 |菜单编码                   |
|scope          |string         |   |否 |可选值：1、current（当前，默认值），2、parent（父级）                   |
|error          |function       |   |否 |打开失败方法      |
#### object.type说明
打开方式可选值：1、homeTab（首页，默认值），2、modal（模态）
#### object.menuCode说明
菜单编码 
#### object.scope
可选值：1、current（当前，默认值），2、parent（父级）
#### object.error说明
窗体打开失败后执行该函数。
#### 返回：void
#### 示例代码
```js
import vdk from 'v3-vdk';
vdk.page.renderFromPortalMenu({
    type : "homeTab",
    menuCode : "menuCode",
    scope:"parent",
    error : function(){
        // do something
    }
});
```