exportExcel

createWorkbook

createSheet

setColumnSize

setRowSize

writeString

writeInt

writeDouble

writeFormula

writeImage

closeWorkbook

论坛示例

为帮助用户更好更快的使用插件，论坛维护了一个示例，示例中包含示例代码供您参考。

概述

exportExcel封装了生成Excel文件的接口逻辑。

固件要求

Android：4.4及以上 iOS：9.0及以上

插件接口

createWorkbook

创建workbook

createWorkbook({params})

params

fileName：

  • 类型：字符串
  • 描述：（必填项）保存excel文件名称

##ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

示例代码

var demo = api.require('exportExcel');
var filename = 'fs://'+new Date().getTime()+'.xlsx';
var ret = demo.createWorkbook({fileName : filename});

可用性

Android、iOS系统

可提供的1.0.0及更高版本

createSheet

创建sheet

createSheet({params})

params

sheetName：

  • 类型：字符串
  • 描述：（可选项）sheet名称
  • 默认值：Sheet1

##ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
    msg : ''
}

示例代码

var demo = api.require('exportExcel');
demo.createSheet();

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setColumnSize

设置列宽

setColumnSize({params})

params

col：

  • 类型：数字型
  • 描述：（可选项）需要设置宽度的列
  • 默认值：0

width：

  • 类型：数字型
  • 描述：（可选项）列宽度值
  • 默认值：10

##ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
    msg : ''
}

示例代码

var demo = api.require('exportExcel');
demo.setColumnSize({
    col: 0,
    width: 20,
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setRowSize

设置行高

setRowSize({params})

params

row：

  • 类型：数字型
  • 描述：（可选项）需要设置宽度的行
  • 默认值：0

width：

  • 类型：数字型
  • 描述：（可选项）行高度值
  • 默认值：10

##ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
    msg: '',
}

示例代码

var obj = api.require('exportExcel');
obj.setRowSize({
    row : 1,
    height: 20,
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

writeString

写入String

writeString({params})

params

row：

  • 类型：数字型
  • 描述：（可选项）行
  • 默认值：0

col：

  • 类型：数字型
  • 描述：（可选项）列
  • 默认值：0

data：

  • 类型：字符串型
  • 描述：（可选项）需要写入的内容

style：

  • 类型：JSON型
  • 描述：（可选项）单元格样式
{
    textColor : -1,//文字颜色 0:WHITE 1:BLUE 2:BROWN 3:GRAY 4:GREEN 5:LIME 6:ORANGE 7:PINK 8:PURPLE 9:RED 10:BLACK 11:YELLOW
    fontSize : 12,//文字大小
    alignHorizontal : 0,//0:水平居左 1:水平居中 2:水平居右
    alignVertical : 0,//0:垂直居顶 1:垂直居中 2:垂直居底
    borderArray : [{//线条样式
        pointer: 1,//0:left 1:right 2:top 3:bottom 4:all
        lineStyle : 0,//1:THIN 2:MEDIUM 3:DOUBLE 4:HAIR 5:MEDIUM_DASHED 6:DASH_DOT 7:MEDIUM_DASH_DOT 8:DASH_DOT_DOT 9:MEDIUM_DASH_DOT_DOT 10:SLANT_DASH_DOT
    }],
    background : -1,//单元格背景色 0:WHITE 1:BLUE 2:BROWN 3:GRAY 4:GREEN 5:LIME 6:ORANGE 7:PINK 8:PURPLE 9:RED 10:BLACK 11:YELLOW
    numFormat : '',//￥#,##0.00
}

merge：

  • 类型：JSON型
  • 描述：（可选项）单元格合并
{
    row ： 0,//从单元格起，向下合并到row行
    col ： 0,//从单元格起，向左合并到col列
}

示例代码

var demo = api.require('exportExcel');
demo.writeString({
    row: 0,
    col: 0,
    data: '合并标题测试',
    style: {
        textColor: 1,
        fontSize: 20,
        alignHorizontal: 1,
        alignVertical: 2,
        background: 9
    },
    merge: {
        row: 0,
        col: 9,
    }
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

writeInt

写入Int

writeInt({params})

params

row：

  • 类型：数字型
  • 描述：（可选项）行
  • 默认值：0

col：

  • 类型：数字型
  • 描述：（可选项）列
  • 默认值：0

data：

  • 类型：数字型
  • 描述：（可选项）需要写入的内容
  • 默认值：0

style：

  • 类型：JSON型
  • 描述：（可选项）单元格样式
{
    textColor : -1,//文字颜色 0:WHITE 1:BLUE 2:BROWN 3:GRAY 4:GREEN 5:LIME 6:ORANGE 7:PINK 8:PURPLE 9:RED 10:BLACK 11:YELLOW
    fontSize : 12,//文字大小
    alignHorizontal : 0,//0:水平居左 1:水平居中 2:水平居右
    alignVertical : 0,//0:垂直居顶 1:垂直居中 2:垂直居底
    borderArray : [{//线条样式
        pointer: 1,//0:left 1:right 2:top 3:bottom 4:all
        lineStyle : 0,//1:THIN 2:MEDIUM 3:DOUBLE 4:HAIR 5:MEDIUM_DASHED 6:DASH_DOT 7:MEDIUM_DASH_DOT 8:DASH_DOT_DOT 9:MEDIUM_DASH_DOT_DOT 10:SLANT_DASH_DOT
    }],
    background : -1,//单元格背景色 0:WHITE 1:BLUE 2:BROWN 3:GRAY 4:GREEN 5:LIME 6:ORANGE 7:PINK 8:PURPLE 9:RED 10:BLACK 11:YELLOW
    numFormat : '',//￥#,##0.00
}

merge：

  • 类型：JSON型
  • 描述：（可选项）单元格合并
{
    row ： 0,//从单元格起，向下合并到row行
    col ： 0,//从单元格起，向左合并到col列
}

示例代码

var demo = api.require('exportExcel');
demo.writeInt({
    row: 0,
    col: 0,
    data: '合并标题测试',
    style: {
        textColor: 1,
        fontSize: 20,
        alignHorizontal: 1,
        alignVertical: 2,
        background: 9
    },
    merge: {
        row: 0,
        col: 9,
    }
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

writeDouble

写入Double

writeDouble({params})

params

row：

  • 类型：数字型
  • 描述：（可选项）行
  • 默认值：0

col：

  • 类型：数字型
  • 描述：（可选项）列
  • 默认值：0

data：

  • 类型：浮点型
  • 描述：（可选项）需要写入的内容
  • 默认值：0.0

style：

  • 类型：JSON型
  • 描述：（可选项）单元格样式
{
    textColor : -1,//文字颜色 0:WHITE 1:BLUE 2:BROWN 3:GRAY 4:GREEN 5:LIME 6:ORANGE 7:PINK 8:PURPLE 9:RED 10:BLACK 11:YELLOW
    fontSize : 12,//文字大小
    alignHorizontal : 0,//0:水平居左 1:水平居中 2:水平居右
    alignVertical : 0,//0:垂直居顶 1:垂直居中 2:垂直居底
    borderArray : [{//线条样式
        pointer: 1,//0:left 1:right 2:top 3:bottom 4:all
        lineStyle : 0,//1:THIN 2:MEDIUM 3:DOUBLE 4:HAIR 5:MEDIUM_DASHED 6:DASH_DOT 7:MEDIUM_DASH_DOT 8:DASH_DOT_DOT 9:MEDIUM_DASH_DOT_DOT 10:SLANT_DASH_DOT
    }],
    background : -1,//单元格背景色 0:WHITE 1:BLUE 2:BROWN 3:GRAY 4:GREEN 5:LIME 6:ORANGE 7:PINK 8:PURPLE 9:RED 10:BLACK 11:YELLOW
    numFormat : '',//￥#,##0.00
}

merge：

  • 类型：JSON型
  • 描述：（可选项）单元格合并
{
    row ： 0,//从单元格起，向下合并到row行
    col ： 0,//从单元格起，向左合并到col列
}

示例代码

var demo = api.require('exportExcel');
demo.writeInt({
    row: 0,
    col: 0,
    data: '合并标题测试',
    style: {
        textColor: 1,
        fontSize: 20,
        alignHorizontal: 1,
        alignVertical: 2,
        background: 9
    },
    merge: {
        row: 0,
        col: 9,
    }
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

writeFormula

写入公式

writeFormula({params})

params

row：

  • 类型：数字型
  • 描述：（可选项）行
  • 默认值：0

col：

  • 类型：数字型
  • 描述：（可选项）列
  • 默认值：0

data：

  • 类型：字符串型
  • 描述：（可选项）需要写入的内容

style：

  • 类型：JSON型
  • 描述：（可选项）单元格样式
{
    textColor : -1,//文字颜色 0:WHITE 1:BLUE 2:BROWN 3:GRAY 4:GREEN 5:LIME 6:ORANGE 7:PINK 8:PURPLE 9:RED 10:BLACK 11:YELLOW
    fontSize : 12,//文字大小
    alignHorizontal : 0,//0:水平居左 1:水平居中 2:水平居右
    alignVertical : 0,//0:垂直居顶 1:垂直居中 2:垂直居底
    borderArray : [{//线条样式
        pointer: 1,//0:left 1:right 2:top 3:bottom 4:all
        lineStyle : 0,//1:THIN 2:MEDIUM 3:DOUBLE 4:HAIR 5:MEDIUM_DASHED 6:DASH_DOT 7:MEDIUM_DASH_DOT 8:DASH_DOT_DOT 9:MEDIUM_DASH_DOT_DOT 10:SLANT_DASH_DOT
    }],
    background : -1,//单元格背景色 0:WHITE 1:BLUE 2:BROWN 3:GRAY 4:GREEN 5:LIME 6:ORANGE 7:PINK 8:PURPLE 9:RED 10:BLACK 11:YELLOW
    numFormat : '',//￥#,##0.00
}

示例代码

var demo = api.require('exportExcel');
demo.writeInt({
    row: 0,
    col: 0,
    data: '合并标题测试',
    style: {
        textColor: 1,
        fontSize: 20,
        alignHorizontal: 1,
        alignVertical: 2,
        background: 9
    }
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

writeImage

写入图片

writeImage({params})

params

row：

  • 类型：数字型
  • 描述：（可选项）行
  • 默认值：0

col：

  • 类型：数字型
  • 描述：（可选项）列
  • 默认值：0

data：

  • 类型：字符串型
  • 描述：（可选项）需要写入的内容

示例代码

var demo = api.require('exportExcel');
demo.writeImage({
    row: 0,
    col: 0,
    data: 'fs://test.jpg',
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

closeWorkbook

关闭workbook(关闭后才算完全执行写入xls逻辑)

closeWorkbook()

##ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

示例代码

var demo = api.require('exportExcel');
var ret = demo.closeWorkbook();

可用性

Android、iOS系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/11/18