版本
版本 | 功能变动 |
---|---|
11.0 | 和 10.0 区别: 无变动,10.0 也支持 |
getWidgetByName
方法 | getWidgetByName(name) | 通过控件名称获取填报单元格中的控件 |
---|---|---|
参数 | name: string | 控件名称,字符串 注:单元格中控件,默认无名称,可以在「控件名称」处为其添加。 |
返回值 | object | 控件对象,需要结合控件的属性/方法使用,当单元格扩展时,返回找到的控件数组中的第一个控件 |
示例 | 示例:普通报表中,获取单元格中的下拉框控件 comboBox0
| |
应用示例 | 填报时,成绩只允许输入一次,成绩控件输入值后将其设置为不可用: 点击可下载模板:控件输入值后设置为不可用.cpt | |
移动端 | 支持移动端 |
getWidgetByCell
方法 | getWidgetByCell(cell) | 通过单元格地址获取填报单元格中的控件 |
---|---|---|
参数 | cell:string | 单元格地址、字符串 |
返回值 | object | 控件对象,需要结合控件的属性/方法使用,当单元格扩展时,只返回一个控件,cell 对应的是扩展后单元格的编号 |
示例 | 示例1:填报报表中,获取 A1 单元格中的控件
示例2:填报报表中,通过行列来获取单元格中的控件,如下获取第 1 行第 1 列即 A1 单元格中的控件。columnRow2CellStr 接口是将行列索引转成单元格地址,相关介绍可查看对应文档。
| |
应用示例 | 填报时,成绩只允许输入一次,获取 B4 单元格中的控件输入值后将其设置为不可用: 点击可下载模板:控件输入值后设置为不可用(单元格地址方式获取).cpt | |
移动端 | 支持移动端 |
getWidgetsByName
方法 | getWidgetsByName(name) | 通过控件名称获取填报单元格具有同一名字的控件 |
---|---|---|
参数 | name: string | 控件名称,字符串 注:单元格中控件,默认无名称,可以在「控件名称」处为其添加。 |
返回值 | [object ] | 控件对象数组,需要结合控件的属性/方法使用;当单元格扩展时,返回的是控件对象数组 |
示例 | 示例:普通报表中,获取单元格中名称为 comboBox0 的所有下拉框控件
| |
应用示例 | 填报时,点击按钮,获取单选按钮组控件扩展的所有值: 详细实现方法可参考:JS获取扩展控件的所有值 | |
移动端 | 支持移动端 |
appendReportRC
方法 | appendReportRC(num,cell) | 在特定的位置插入行,指定的单元格需要设置扩展属性 |
---|---|---|
参数 | num:number cell:string | num:插入的行数,数字 cell:插入位置的单元格编号,如果无此参数,则插入位置为鼠标焦点所在行 |
返回值 | void | |
示例 | 示例:填报报表中,在报表 A1 单元格行后插入 3 行
| |
应用示例 | 填报时,点击按钮,插入自定义行数: 点击可下载模板:在特定的位置插入行.cpt | |
移动端 | 不支持移动端 |
appendReportRow
方法 | _g().appendReportRow(cell,sheetindex,num) | 插入行,需要配合「插入行按钮」实现 注:使用 num 参数时,尽量将插入行按钮的行数调整为 0,否则会相互影响,出现混乱 |
---|---|---|
参数 | cell:string sheetindex:number num:number | cell:「插入行按钮」所在单元格的编号,字符串 sheetindex:sheet 编号,数字,从 0 开始 num:插入的行数,数字 |
返回值 | void | |
示例 | 示例1: 填报报表中,插入行按钮在“sheet1”的“F1”单元格。 使用该 JS 可调用 F1 单元格的插入行按钮插入 3 行
示例2:通过 this.options.location, this.options.reportIndex 获取插入行按钮、sheet 编号后,插入 3 行
示例3:填报报表中,通过 this.options.location, this.options.reportIndex 获取插入行按钮、sheet 编号后,插入 3 行
| |
应用示例 | 填报时,点击按钮,插入自定义行数: 详细实现方法可参考:JS实现插入自定义行数 | |
移动端 | 支持移动端 |
deleteReportRC
方法 | deleteReportRC(cell) | 删除行 |
---|---|---|
参数 | cell:string | cell:删除位置的单元格编号。如果无此参数,则删除位置为鼠标焦点所在行 |
返回值 | void | |
示例 | 示例1:填报报表中,删除 A1 单元格所在的行 _g().deleteReportRC("A1"); 示例2:填报报表中,删除鼠标所在单元格位置的行
| |
应用示例 | 填报时,点击按钮,删除鼠标所在的单元格行: 详细实现方法可参考:JS自定义插入和删除行按钮 | |
移动端 | 不支持移动端 |
deleteRows
方法 | deleteRows([cell]) | 删除行 |
---|---|---|
参数 | cell:string | cell:删除位置的单元格编号数组 |
返回值 | void | |
示例 | 示例:填报报表中,删除 A1 、A2 单元格所在的行
| |
应用示例 | 填报报表中,实现根据选项选批量删除: 详细实现方法可参考:JS实现复选按钮控件全选和批量操作 | |
移动端 | 不支持移动端 |
refreshAllSheets
方法 | refreshAllSheets() | 重新查询,刷新所有 sheet,刷新后会停留在上次查看的 sheet |
---|---|---|
参数 | - | - |
返回值 | void | |
示例 | 示例:填报报表中,刷新所有的 sheet
| |
应用示例 | 点击按钮刷新所有 sheet ,刷新后依旧停留在当前所在的 sheet3: 点击可下载模板:刷新后停留在当前的sheet.cpt | |
移动端 | 支持移动端 |
loadSheetByIndex
方法 | loadSheetByIndex(index) | 切换到指定 sheet,参数为 sheet 序号 |
---|---|---|
参数 | index:number | index:sheet 序号( 从 0 开始 ) |
返回值 | void | |
示例 | 示例:填报报表中,切换到第 2 个 sheet
| |
应用示例 | 如果报表中有多个 sheet 页,预览时,默认展示第 2 个 sheet 页: 点击可下载模板:默认展示特定sheet.cpt | |
移动端 | 不支持移动端 |
loadSheetByName
方法 | loadSheetByName(name) | 切换到指定 sheet,参数为 sheet 名称 |
---|---|---|
参数 | name:string | name:sheet 名称 |
返回值 | void | |
示例 | 示例:填报报表中,切换到名称为“商品”的 sheet
| |
应用示例 | 如果报表中有多个 sheet 页,预览时,默认展示名称为“sheet2”的 sheet 页: 点击可下载模板:默认展示特定sheet.cpt | |
移动端 | 不支持移动端 |
writeReport
方法 | writeReport(sheetindex) | 强制提交,不校验 |
---|---|---|
参数 | sheetindex:number | 提交第几个 sheet,数字,从 0 开始,参数为空代表提交所有 sheet |
返回值 | void | |
示例 | 示例:填报报表中,提交第 2 个 sheet
| |
应用示例 | 自定义一个「提交」按钮,实现点击按钮时提交填报内容: 点击可下载模板:强制提交不校验.cpt | |
移动端 | 支持移动端 |
verifyAndWriteReport
方法 | verifyAndWriteReport(isallsheet) | 校验并提交报表 |
---|---|---|
参数 | isallsheet:boolean | isallsheet:是否提交所有的 sheet
|
返回值 | void | |
示例 | 示例:填报报表中,提交所有 sheet
| |
应用示例 | 自定义一个「提交」按钮,实现点击按钮时校验提交填报内容: 点击可下载模板:校验提交.cpt | |
移动端 | 支持移动端 |
verifyReport
方法 | verifyReport() | 数据校验 |
---|---|---|
参数 | - | - |
返回值 | void | |
示例 | 示例:填报报表中,提交校验
| |
应用示例 | 自定义一个「校验」按钮,实现点击按钮时提交校验: 点击可下载模板:自定义校验按钮.cpt | |
移动端 | 支持移动端 |
importExcel
方法 | importExcel(importStyle) | 导入 Excel |
---|---|---|
参数 | importStyle: | 导入方式,字符串,
|
返回值 | void | |
示例 | 示例1:填报报表中,调出导入 Excel 功能弹窗,以普通导入的方式导入 Excel _g().importExcel(); 示例2:填报报表中,调出导入 Excel 功能弹窗,以自定义导入的方式导入 Excel
| |
应用示例 | 自定义一个 「导入Excel」按钮,点击实现导入 Excel: 点击可下载模板:自定义导入的方式导入 Excel.cpt | |
移动端 | 不支持移动端 |
importExcel_Clean
方法 | importExcel_Clean() | 「清空导入」的方式导入 Excel |
---|---|---|
参数 | - | - |
返回值 | void | |
示例 | 示例:填报报表中,调出导入 Excel 功能弹窗,以「清空导入」的方式导入 Excel
| |
应用示例 | 自定义一个 「导入Excel」 按钮,点击以「清空导入」的方式导入 Excel : 点击可下载模板:多次导入Excel.cpt | |
移动端 | 不支持移动端 |
importExcel_Append
方法 | importExcel_Append() | 「增量导入」的方式导入 Excel |
---|---|---|
参数 | - | - |
返回值 | void | |
示例 | 示例:填报报表中,调出导入 Excel 功能弹窗,以增量导入的方式导入 Excel
| |
应用示例 | 自定义一个「导入Excel」按钮,点击以增量导入的方式导入 Excel: 点击可下载模板:多次导入Excel.cpt | |
移动端 | 不支持移动端 |
importExcel_Cover
方法 | importExcel_Cover() | 覆盖导入的方式导入 Excel: |
---|---|---|
参数 | - | - |
返回值 | void | |
示例 | 示例:填报报表中,调出导入 Excel:功能弹窗,以覆盖导入的方式导入 Excel
| |
应用示例 | 自定义一个「导入Excel」按钮,点击以覆盖导入的方式导入 Excel: 点击可下载模板:多次导入Excel.cpt | |
移动端 | 不支持移动端 |
isDirtyPage
方法 | isDirtyPage() | 判断页面是否被编辑过 |
---|---|---|
参数 | - | - |
返回值 | boolean | 页面是否被编辑过,布尔型
|
示例 | 示例:填报报表中,判断页面是否被编辑过
| |
应用示例 | 点击按钮,判断页面是否被编辑过: 点击可下载模板:查看页面编辑状态.cpt | |
移动端 | 不支持移动端 |
isAutoStash
方法 | isAutoStash() | 判断是否开启自动暂存,自动暂存可参考:填报暂存 |
---|---|---|
参数 | - | - |
返回值 | boolean | 是否开启自动暂存,布尔型
|
示例 | 示例:填报报表中,判断是否开启自动暂存
| |
应用示例 | - | |
移动端 | 不支持移动端 |
stash
方法 | stash(undefined,true) | 暂存 |
---|---|---|
参数 | undefined,true | 固定格式,作用为弹出暂存成功的提示,如果不需要提示,直接不写即可 |
返回值 | void | |
示例 | 示例1:填报报表中,暂存并弹出暂存成功的提示 _g().stash(undefined,true);示例2:填报报表中,暂存但不弹出暂存成功的提示
| |
应用示例 | - | |
移动端 | 不支持移动端 |
clear
方法 | clear() | 清空暂存 |
---|---|---|
参数 | - | 无,如果不需要清空确认提醒以及清空成功的提示,则可以写 undefined,false |
返回值 | void | |
示例 | 示例1:填报报表中,清空暂存并弹出清空暂存成功的提示 _g().clear(); 示例2:填报报表中,清空暂存但不弹出清空确认提醒以及清空成功的提示
| |
应用示例 | - | |
移动端 | 不支持移动端 |