一、属性

listOption

object

列表配置项。

---

size

控件大小。

默认值: 'small'

可选值: 'large'、'default'、'samll'

---

height

number | height

组件高度。

---

editType

string

编辑类型，用于区分当前操作。

默认值: 'default'

可选值: 'default'、'add'、'update'

---

app

string

标记当前组件是在哪个功能组件中使用的。

默认值: 'AppList'

---

selectedTreeNode

object

选中树节点的数据。

提示

当需要与 AppTree 关联时使用。

二、插槽

listTop

查询条件上方。

listCenter

查询条件下方&列表上方。

listTbarLeft

tbar 左侧。

listRow

{ row }

列表行。

参数说明：

• row: object: 列表行数据对象

header

列表头部。

footer

列表尾部。

三、方法

getList()

获取列表实例对象。

调用此方法后，可使用的属性:

• name: 列表名称 mainGrid.name
• listRef: 列表实例对象
• editType: 编辑类型 mainGrid.editType
• selectedRow: 选中行
• lastSelectedRow: 上一次的选中行
• searchType: 查询类型,default：默认 btn：搜索按钮 page：分页查询 enter：回车查询 reload:重载按钮 moreFind:更多（下拉）查询 sort:排序查询 filter:高级查询

调用此方法后，可使用的方法:

• setLoading(loading): 设置加载状态
• toggleCheckboxRow(row): 切换行的选中状态
• toggleAllCheckboxRow(row): 切换所有行的选中状态
• remove(rows): 删除行记录
• removeCheckboxRow(): 删除选中行
• getCheckedData(): 获取选中数据
• lInsert(row, insertRow): 插入数据
• setInitial(key, val): 设置插入数据的默认值
• valueChangedValidate(newValObj, oldValObj): 值变化验证方法，修 改行编辑状态
• getListData(params): 请求列表数据(当前⻚)
• reloadList(params): 请求列表数据(第一⻚)
• clearList(): 清空列表
• updateRows(rows): 更新行记录
• getFindFormData(): 获取查询条件表单数据
• buildSaveData(): 构建存储数据
• lOpenModal(): 打开弹窗 不建议使用

四、事件

lFindBefore

({ that, listRef, back }) => void

查询前事件。

参数说明:

• obj
  • that: object: 当前组件的实例对象 不建议使用
  • listRef: object: 列表对象 推荐
  • back: (continueExec) => void: 是否需要拦截后续代码时调用，默认继续执行。back(false) 即可拦截。

提示

该方法可直接挂载至 listOption 下。

listOption: {
  // ...
  lFindBefore: ({ that, listRef, back }) => {}
}

lFindAfter

({ that, listRef, res, processRes, url, params, initComplete }) => void) => void

查询前事件。

参数说明:

• obj
  • that: object: 当前组件的实例对象 不建议使用
  • listRef: object: 列表对象 推荐
  • res: object: 接口响应数据
  • processRes: (res) => void: 处理响应数据
  • url: string: 请求地址
  • params: object: 请求参数
  • initComplete: boolean: 是否初始化完成。可以根据此属性，判断是否为第一次请求。

提示

该方法可直接挂载至 listOption 下。

listOption: {
  // ...
  lFindAfter: ({ that, listRef, res, processRes, url, params, initComplete }) => void) => {}
}

lRetrieveEnd

({ that, listRef, listData, res, url, params, initComplete }) => void) => void

查询前事件。

参数说明:

• obj
  • that: object: 当前组件的实例对象 不建议使用
  • listRef: object: 列表对象 推荐
  • listData: boolean: 列表数据
  • res: object: 接口响应数据
  • url: string: 请求地址
  • params: object: 请求参数
  • initComplete: boolean: 是否初始化完成。可以根据此属性，判断是否为第一次请求。

提示

该方法可直接挂载至 listOption 下。

listOption: {
  // ...
  lFindAfter: ({ that, listRef, listData, res, url, params, initComplete }) => void) => {}
}

lAfterConstructor

({ that, listRef }) => void

初始化完成之后执行。

参数说明:

• obj
  • that: object: 当前组件的实例对象 不建议使用
  • listRef: object: 列表对象 推荐

提示

该方法可直接挂载至 listOption 下。

listOption: {
  // ...
  lAfterConstructor: ({ that, listRef }) => void) => {}
}

lSaveBefore

({ that, listRef, back, modalOption?, modalRefs?, data?, proData? }) => void

保存前执行。

参数说明:

• obj
  • that: object: 当前组件的实例对象 不建议使用
  • listRef: object: 列表对象 推荐
  • back: (continueExec) => void: 是否需要拦截后续代码时调用，默认继续执行。back(false) 即可拦截。
  • modalOption: object: 增加/编辑弹窗配置项
  • modalRefs: object: 弹窗中内的组件实例对象
  • data: object: 弹窗的数据，不一定是待保存数据
  • proData: (data) => void: 当弹窗数据不是保存数据时，对弹窗数据做处理

提示

该方法可直接挂载至 listOption 下。

listOption: {
  // ...
  lSaveBefore: ({ that, listRef, back, modalOption?, modalRefs?, data?, proData? }) => void) => {}
}

lSaveAfter

({ that, grid, records, res }) => void

保存后执行。

参数说明:

• obj
  • that: object: 当前组件的实例对象 不建议使用
  • listRef: object: 列表对象 推荐
  • res: object: 接口响应数据
  • records: array: 接口返回的数据集res.data

提示

该方法可直接挂载至 listOption 下。

listOption: {
  // ...
  lSaveAfter: ({ that, grid, records, res }) => void) => {}
}

lDeleteBefore

({ that, grid, records, back }) => void

删除前执行。

参数说明:

• obj
  • that: object: 当前组件的实例对象 不建议使用
  • listRef: object: 列表对象 推荐
  • records: array: 待删除的行记录
  • back: (continueExec) => void: 是否需要拦截后续代码时调用，默认继续执行。back(false) 即可拦截。

提示

该方法可直接挂载至 listOption 下。

listOption: {
  // ...
  lDeleteBefore: ({ that, grid, records, back }) => void) => {}
}

lDeleteAfter

({ that, grid, row, res? }) => void

删除后执行。

参数说明:

• obj
  • that: object: 当前组件的实例对象 不建议使用
  • listRef: object: 列表对象 推荐
  • row: object: 删除的行记录。
  • res: object: 接口响应数据。

提示

该方法可直接挂载至 listOption 下。

listOption: {
  // ...
  lDeleteAfter: ({ that, grid, row, res }) => void) => {}
}

lInsertBefore

({ that, listRef, back }) => void

插入前执行。

参数说明:

• obj
  • that: object: 当前组件的实例对象 不建议使用
  • listRef: object: 列表对象 推荐
  • back: (continueExec) => void: 是否需要拦截后续代码时调用，默认继续执行。back(false) 即可拦截。

提示

该方法可直接挂载至 listOption 下。

listOption: {
  // ...
  lInsertBefore: ({ that, listRef, back }) => void) => {}
}

lInsertAfter

({ that, listRef, newRow }) => void

插入前执行。

参数说明:

• obj
  • that: object: 当前组件的实例对象 不建议使用
  • listRef: object: 列表对象 推荐
  • newRow: object: 插入的行记录

提示

该方法可直接挂载至 listOption 下。

listOption: {
  // ...
  lInsertAfter: ({ that, listRef, newRow }) => void) => {}
}