更新记录

1.0（2023-09-27）

v1.0 2023/09/26

• v1.0版本

平台兼容性

原生插件通用使用流程：

1. 购买插件，选择该插件绑定的项目。
2. 在HBuilderX里找到项目，在manifest的app原生插件配置中勾选模块，如需要填写参数则参考插件作者的文档添加。
3. 根据插件作者的提供的文档开发代码，在代码中引用插件，调用插件功能。
4. 打包自定义基座，选择插件，得到自定义基座，然后运行时选择自定义基座，进行log输出测试。
5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项：使用HBuilderX2.7.14以下版本，如果同一插件且同一appid下购买并绑定了多个包名，提交云打包界面提示包名绑定不一致时，需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择

淏阳Excel插件文档

示例均为伪代码，可能无法正确运行，请按照文档适当调整。

如有不清楚的地方可以导入示例项目。

有任何问题请加QQ：419830883 沟通解决。

使用方法

const excelPlugin = uni.requireNativePlugin("Haoyang-ExcelPlugin");
excelPlugin.readExcelAsync({
    path: "",
    xlsx: true
},res=>{
    console.log(res);
})

基础响应对象：ResultModel

所有的方法返回对象均为此结构，具体数据从data属性获取

插件方法

1. 读取数据

• 方法名：readExcelAsync

• 说明

  sheet配置会影响数据的读取，startCol和startRow指定数据的起始列和行（包括表头），headerRowNum指定表头有几行。

• 参数：ReadOption

读取数据参数：ReadOption

读取数据Sheet配置：ReadSheetOption

• 结果：ExcelModel

Excel表数据：ExcelModel

Excel表Sheet数据：SheetModel

Excel表行数据：RowModel

Excel表行内单元格数据：CellModel

2. 分批读取

• 方法名：batchReadExcelAsync

• 说明：表格较多时一次性读取会比较慢，且容易出错，建议进行分批读取；分批读取时会持续接收数据直至读取完毕，但只支持读取指定的sheet页

• 参数：BatchReadOption

BatchReadOption

• 结果：BatchReadResultModel

BatchReadResultModel

• 示例

let totalRows = [];
excelPlugin.batchReadExcelAsync(option, data => {
        const { total, rows, complete } = data;
        totalRows = totalRows.concat(rows);
        if (complete === true) {
            console.log(`已完成，共${total}行`);
        } else {
            console.log(`读取中，共${total}行，已读取${allData.length}行`);
        }
});

3. 写入数据

• 方法名：writeExcelAsync

• 说明：一次性写入全部数据

• 参数：WriteOption

WriteOption

WriteSheetModel

WriteCellMergeModel

FreezeModel

冻结至首行：freezeRow：1，freezeColumn：0；冻结首行首列：freezeRow：1，freezeColumn：1；

WriteRowModel

WriteCellModel

WriteCellStyle

具体样式说明看后面

InsertImageModel

• 结果

{
    code: 200,
    message: "",
    success: true,
    data: null
}

5. 追加数据

• 方法名：appendExcelAsync

• 说明：数据较多时，一次性写入会很慢，而且容易导致内存不足报错，所以建议分批追加写入数据。

• 参数：AppendModel

AppendModel

• 结果

{
    code: 200,
    message: "",
    success: true,
    data: null
}

7. 插入图片

• 方法名：insertImageAsync

• 说明：在表格指定位置插入图片

• 参数：InsertImageOption

InsertImageOption

InsertImageSheetModel

• 结果

{
    code: 200,
    message: "",
    success: true,
    data: null
}

关于列宽设置的算法说明

• 列宽不要超过255个字符，即不要超过255*256

• 实际列宽可能由于字体大小不同导致和预期设置的列宽有一点偏差

• 由于POI内部列宽算法是将每个字符宽度都除以了256，所以在设置宽度时需要乘上256

• 由于安卓上缺少必要的库文件，所以暂不支持自适应列宽。有需求的话可以通过算法自己实现 示例：

  const columnWidth = {
  0: 18 * 256, // 第一列列宽18个字符
  2: 25 * 256 // 第3列25个字符
  }

  关于单元格样式的说明

• 关于颜色，所有需要设置颜色，均从下面列表中选取即可，注意参数应为英文字符串。

• 关于边框，边框可选值，图片中的英文单词即为对应的值（对应参数borderTop,borderLeft,borderRight,borderBottom）

• 关于填充模式，填充模式用来控制背景色的填充方式

• 关于对齐方式枚举

1. 水平对齐方式（对应参数align)

2. 垂直对齐方式（对应参数verticalAlign）