当前位置: 首页 > 工具软件 > Luckysheet > 使用案例 >

luckysheet 个人使用总结

柳翼
2023-12-01

一、简介

Luckysheet ,一款纯前端类似excel的在线表格,功能强大、配置简单、完全开源。

在线文档:快速上手 | Luckysheet文档

在线Demo:Luckysheet

github仓库:GitHub - mengshukeji/Luckysheet: Luckysheet is an online spreadsheet like excel that is powerful, simple to configure, and completely open source.

二、常见问题:常见问题 | Luckysheet文档

三、个人使用总结:

elementUI中使用:

luckysheet 在 elementUI 的 dialog 中菜单和编辑框被遮罩,需要设置以下样式:

.luckysheet-cols-menu{
  z-index: 9004 !important;
}
.luckysheet-input-box{
  z-index: 3000 !important;
}
.luckysheet-wa-editor{
  z-index: 2005 !important;
}
.luckysheet-modal-dialog-slider{
  z-index: 2005 !important;
}

自定义鼠标右键菜单:

options: {
        cellRightClickConfig: {
          customs: [
            //自定义右键菜单
            {
              title: "自定义菜单",
              onClick: (clickEvent, event, params) => {
                console.log(params);
              },
            },
            .
            .
            .
          ],
        },
      },

公式触发:

forceCalculation 作用为初始化表格时强制刷新公式。如果公式较多会有性能问题,目前测试千条公式渲染大概1~2s,公式不多可以用。

options:{
	forceCalculation:true,//强制刷新公式
}

设置单元格公式:

单元格的公式属性为 f,若无公式不要添加 f 属性,或者给 f 赋值null,其它值可能有奇怪问题

{
	"r": 36,
  "c": 6,
  "v": {
    "v": 1,
    "m": "1",
    "f": "=SUM(A1:A2)",//无值给null,其它值可能会有奇怪问题
	}
}

如果单元格有公式,必须添加对应公式链 calcChain

{
	"r": 6, //行数
  "c": 3, //列数
  "index": 1, //工作表id
  //"func": [true, 23.75, "=AVERAGE(D3:D6)"], //公式信息,包含公式计算结果和公式字符串
  "color": "w", //"w":采用深度优先算法 "b":普通计算
  "parent": null,
  "chidren": {},
  "times": 0
}

设置单元格跳转sheet:

需要设置工作表配置中的 hyperlink。(或者可以参考下数据透视表 pivotTable)

options:{
	data:[{
		hyperlink:{
    	'1_1':{
        linkType: 'external', //链接类型 external外部链接,internal内部链接
        linkAddress: 'sheet名称!A2',  //链接地址 网页地址或工作表单元格引用
        linkTooltip: '提示',  //提示
      },
      ...
    }
  }]
}

工作表保护:

options:{
	data:[{
		config:{
    	authority:{// 当前工作表的权限配置
        sheet: 1, // sheet表下标。
        hintText: "这部分不可以进行修改", // 弹窗提示的文字
        allowRangeList: [
        	{ sqref: '$A$2:$D$6' },//设置A2~D6为可编辑区域,其它区域不可编辑
          ...
        ],
      }//工作表保护
    }
  }]
}

初始化含合并单元格:

options:{
	data:[{
		config:{
    	merge:{
        '0_0':{
        	r:0,
          c:0,
          rs:2,//合并行数
          cs:1 //合并列数
        },
        ...
      }// 合并单元格配置
    }
  }]
}

导入导出:

先安装依赖

npm i -S exceljs file-saver luckyexcel

导出工具 export.js

import Excel from 'exceljs';

import FileSaver from 'file-saver';

const exportExcel = function(luckysheet, value) {
    // 参数为luckysheet.getluckysheetfile()获取的对象
    // 1.创建工作簿,可以为工作簿添加属性
    const workbook = new Excel.Workbook();
    // 2.创建表格,第二个参数可以配置创建什么样的工作表
    if (Object.prototype.toString.call(luckysheet) === '[object Object]') {
        luckysheet = [luckysheet];
    }
    luckysheet.forEach(function(table) {
        if (table.data.length === 0) { return true; }
        // ws.getCell('B2').fill = fills.
        const worksheet = workbook.addWorksheet(table.name);
        const merge = (table.config && table.config.merge) || {};
        const borderInfo = (table.config && table.config.borderInfo) || {};
        // 3.设置单元格合并,设置单元格边框,设置单元格样式,设置值
        setStyleAndValue(table.data, worksheet);
        setMerge(merge, worksheet);
        setBorder(borderInfo, worksheet);
        return true;
    });

    // return
    // 4.写入 buffer
    const buffer = workbook.xlsx.writeBuffer().then(data => {
    // console.log('data', data)
        const blob = new Blob([data], {
            type: 'application/vnd.ms-excel;charset=utf-8'
        });
        console.log('导出成功!');
        FileSaver.saveAs(blob, `${value}.xlsx`);
    });
    return buffer;
};

var setMerge = function(luckyMerge = {}, worksheet) {
    const mergearr = Object.values(luckyMerge);
    mergearr.forEach(function(elem) {
    // elem格式:{r: 0, c: 0, rs: 1, cs: 2}
    // 按开始行,开始列,结束行,结束列合并(相当于 K10:M12)
        worksheet.mergeCells(
            elem.r + 1,
            elem.c + 1,
            elem.r + elem.rs,
            elem.c + elem.cs
        );
    });
};

var setBorder = function(luckyBorderInfo, worksheet) {
    if (!Array.isArray(luckyBorderInfo)) { return; }
    // console.log('luckyBorderInfo', luckyBorderInfo)
    luckyBorderInfo.forEach(function(elem) {
    // 现在只兼容到borderType 为range的情况
    // console.log('ele', elem)
        if (elem.rangeType === 'range') {
            let border = borderConvert(elem.borderType, elem.style, elem.color);
            let rang = elem.range[0];
            // console.log('range', rang)
            let row = rang.row;
            let column = rang.column;
            for (let i = row[0] + 1; i < row[1] + 2; i++) {
                for (let y = column[0] + 1; y < column[1] + 2; y++) {
                    worksheet.getCell(i, y).border = border;
                }
            }
        }
        if (elem.rangeType === 'cell') {
            // col_index: 2
            // row_index: 1
            // b: {
            //   color: '#d0d4e3'
            //   style: 1
            // }
            const { col_index, row_index } = elem.value;
            const borderData = Object.assign({}, elem.value);
            delete borderData.col_index;
            delete borderData.row_index;
            let border = addborderToCell(borderData, row_index, col_index);
            // console.log('bordre', border, borderData)
            worksheet.getCell(row_index + 1, col_index + 1).border = border;
        }
    // console.log(rang.column_focus + 1, rang.row_focus + 1)
    // worksheet.getCell(rang.row_focus + 1, rang.column_focus + 1).border = border
    });
};
var setStyleAndValue = function(cellArr, worksheet) {
    if (!Array.isArray(cellArr)) { return; }
    cellArr.forEach(function(row, rowid) {
        row.every(function(cell, columnid) {
            if (!cell) { return true; }
            let fill = fillConvert(cell.bg);

            let font = fontConvert(
                cell.ff,
                cell.fc,
                cell.bl,
                cell.it,
                cell.fs,
                cell.cl,
                cell.ul
            );
            let alignment = alignmentConvert(cell.vt, cell.ht, cell.tb, cell.tr);
            let value = '';

            if (cell.f) {
                value = { formula: cell.f, result: cell.v };
            } else if (!cell.v && cell.ct && cell.ct.s) {
                // xls转为xlsx之后,内部存在不同的格式,都会进到富文本里,即值不存在与cell.v,而是存在于cell.ct.s之后
                // value = cell.ct.s[0].v
                cell.ct.s.forEach(arr => {
                    value += arr.v;
                });
            } else {
                value = cell.v;
            }
            //  style 填入到_value中可以实现填充色
            let letter = createCellPos(columnid);
            let target = worksheet.getCell(letter + (rowid + 1));
            // console.log('1233', letter + (rowid + 1))
            for (const key in fill) {
                target.fill = fill;
                break;
            }
            target.font = font;
            target.alignment = alignment;
            target.value = value;

            return true;
        });
    });
};

var fillConvert = function(bg) {
    if (!bg) {
        return {};
    }
    // const bgc = bg.replace('#', '')
    let fill = {
        type: 'pattern',
        pattern: 'solid',
        fgColor: { argb: bg.replace('#', '') }
    };
    return fill;
};

var fontConvert = function(
    ff = 0,
    fc = '#000000',
    bl = 0,
    it = 0,
    fs = 10,
    cl = 0,
    ul = 0
) {
    // luckysheet:ff(样式), fc(颜色), bl(粗体), it(斜体), fs(大小), cl(删除线), ul(下划线)
    const luckyToExcel = {
        0: '微软雅黑',
        1: '宋体(Song)',
        2: '黑体(ST Heiti)',
        3: '楷体(ST Kaiti)',
        4: '仿宋(ST FangSong)',
        5: '新宋体(ST Song)',
        6: '华文新魏',
        7: '华文行楷',
        8: '华文隶书',
        9: 'Arial',
        10: 'Times New Roman ',
        11: 'Tahoma ',
        12: 'Verdana',
        num2bl: function(num) {
            return num === 0 ? false : true;
        }
    };
    // 出现Bug,导入的时候ff为luckyToExcel的val

    let font = {
        name: typeof ff === 'number' ? luckyToExcel[ff] : ff,
        family: 1,
        size: fs,
        color: { argb: fc.replace('#', '') },
        bold: luckyToExcel.num2bl(bl),
        italic: luckyToExcel.num2bl(it),
        underline: luckyToExcel.num2bl(ul),
        strike: luckyToExcel.num2bl(cl)
    };

    return font;
};

var alignmentConvert = function(
    vt = 'default',
    ht = 'default',
    tb = 'default',
    tr = 'default'
) {
    // luckysheet:vt(垂直), ht(水平), tb(换行), tr(旋转)
    const luckyToExcel = {
        vertical: {
            0: 'middle',
            1: 'top',
            2: 'bottom',
            default: 'top'
        },
        horizontal: {
            0: 'center',
            1: 'left',
            2: 'right',
            default: 'left'
        },
        wrapText: {
            0: false,
            1: false,
            2: true,
            default: false
        },
        textRotation: {
            0: 0,
            1: 45,
            2: -45,
            3: 'vertical',
            4: 90,
            5: -90,
            default: 0
        }
    };

    let alignment = {
        vertical: luckyToExcel.vertical[vt],
        horizontal: luckyToExcel.horizontal[ht],
        wrapText: luckyToExcel.wrapText[tb],
        textRotation: luckyToExcel.textRotation[tr]
    };
    return alignment;
};

var borderConvert = function(borderType, style = 1, color = '#000') {
    // 对应luckysheet的config中borderinfo的的参数
    if (!borderType) {
        return {};
    }
    const luckyToExcel = {
        type: {
            'border-all': 'all',
            'border-top': 'top',
            'border-right': 'right',
            'border-bottom': 'bottom',
            'border-left': 'left'
        },
        style: {
            0: 'none',
            1: 'thin',
            2: 'hair',
            3: 'dotted',
            4: 'dashDot', // 'Dashed',
            5: 'dashDot',
            6: 'dashDotDot',
            7: 'double',
            8: 'medium',
            9: 'mediumDashed',
            10: 'mediumDashDot',
            11: 'mediumDashDotDot',
            12: 'slantDashDot',
            13: 'thick'
        }
    };
    let template = {
        style: luckyToExcel.style[style],
        color: { argb: color.replace('#', '') }
    };
    let border = {};
    if (luckyToExcel.type[borderType] === 'all') {
        border['top'] = template;
        border['right'] = template;
        border['bottom'] = template;
        border['left'] = template;
    } else {
        border[luckyToExcel.type[borderType]] = template;
    }
    // console.log('border', border)
    return border;
};

function addborderToCell(borders, row_index, col_index) {
    let border = {};
    const luckyExcel = {
        type: {
            l: 'left',
            r: 'right',
            b: 'bottom',
            t: 'top'
        },
        style: {
            0: 'none',
            1: 'thin',
            2: 'hair',
            3: 'dotted',
            4: 'dashDot', // 'Dashed',
            5: 'dashDot',
            6: 'dashDotDot',
            7: 'double',
            8: 'medium',
            9: 'mediumDashed',
            10: 'mediumDashDot',
            11: 'mediumDashDotDot',
            12: 'slantDashDot',
            13: 'thick'
        }
    };
    // console.log('borders', borders)
    for (const bor in borders) {
    // console.log(bor)
        if (borders[bor].color.indexOf('rgb') === -1) {
            border[luckyExcel.type[bor]] = {
                style: luckyExcel.style[borders[bor].style],
                color: { argb: borders[bor].color.replace('#', '') }
            };
        } else {
            border[luckyExcel.type[bor]] = {
                style: luckyExcel.style[borders[bor].style],
                color: { argb: borders[bor].color }
            };
        }
    }

    return border;
}

function createCellPos(n) {
    let ordA = 'A'.charCodeAt(0);

    let ordZ = 'Z'.charCodeAt(0);
    let len = ordZ - ordA + 1;
    let s = '';
    while (n >= 0) {
        s = String.fromCharCode((n % len) + ordA) + s;

        n = Math.floor(n / len) - 1;
    }
    return s;
}

export {
    exportExcel
};

引入依赖:

import LuckyExcel from 'luckyexcel';
import { exportExcel } from './export';

导入本地Excel:

//导入本地文件
loadExcel(evt) {
  const files = evt.target.files;
  if (files == null || files.length == 0) {
    alert("请选择文件");
    return;
  }
  
  //获取文件名
  let name = files[0].name;
  //获取文件后缀
  let suffixArr = name.split("."),
    suffix = suffixArr[suffixArr.length - 1];
  if (suffix != "xlsx") {
    alert("目前只能导入xlsx类型的文件");
    return;
  }
  //转换数据
  LuckyExcel.transformExcelToLucky(
    files[0],
    function (exportJson, luckysheetfile) {
      if (exportJson.sheets == null || exportJson.sheets.length == 0) {
        alert("无法读取excel文件的内容,当前不支持xls文件!");
        return;
      }
      console.log("exportJson", exportJson);
      console.log("luckysheetfile",luckysheetfile)
      jsonData.value = exportJson;

      window.luckysheet.destroy();

      window.luckysheet.create({
        container: "luckysheet", //luckysheet is the container id
        showinfobar: false,
        data: exportJson.sheets,
        title: exportJson.info.name,
        userInfo: exportJson.info.name.creator,
      });
    }
  );
},

导出Excel:

//第2个参数是导出的文件名
exportExcel(window.luckysheet.getAllSheets(), 'Excel文件名称');

添加单元格扩展属性:

在luckysheet源码中,/src/global/setdata.js 文件中修改  setcellvalue 方法

function setcellvalue(r, c, d, v) {
    if(d == null){
        d = Store.flowdata;
    }
    // 若采用深拷贝,初始化时的单元格属性丢失
    // let cell = $.extend(true, {}, d[r][c]);
    let cell = d[r][c];

    let vupdate;

    if(getObjType(v) == "object"){
        if(cell == null){
            cell = v;
        }
        else{
            if(v.f != null){
                cell.f = v.f;
            }else if(cell.hasOwnProperty('f')){
                delete cell.f;
            }

            if(v.spl != null){
                cell.spl = v.spl;
            }

            if(v.ct != null){
                cell.ct = v.ct;
            }
            // 添加扩展属性
            if(v.expand != null){
                cell.expand = v.expand
            }
        }
		...
}

去掉工作表保护区弹窗:

在luckysheet源码的 /src/global/protection.js 文件中

// 注释掉所有 
// tooltip.info("", ht);

希望这篇文章对大家的开发有所帮助!

 类似资料: