引用地址:https://blog.csdn.net/Lyy1991Wdl/article/details/124175868
配置文檔 · API · 教程:快速上手 | Luckysheet文檔
第一步:
定義Luckysheet組件:組件系統(tǒng)是 Vue 的另一個重要概念,因為它是一種抽象即纲,允許我們使用小型逾滥、獨立和通骋确兀可復用的組件構(gòu)建大型應用龄减,因此惯悠,先定義好可重復使用的Luckysheet組件。代碼如下:
<template>
<div class="hello">
<div id="luckysheet" class="luckysheet-content"></div>
</div>
</template>
<script>
export default {
name: "HelloWorld",
data() {
return {};
},
mounted() {
// In some cases, you need to use $nextTick
// this.$nextTick(() => {
$(function () {
luckysheet.create({
container: "luckysheet", // 設定DOM容器的id
title: "Luckysheet Demo", // 設定表格名稱
lang: "zh", // 設定表格語言
plugins: ["chart"],
data: [
{
name: "", //工作表名稱
color: "#eee333", //工作表(工作表名稱底部邊框線)顏色
index: 0, //工作表索引(新增一個工作表時該值是一個隨機字符串)
status: 1, //激活狀態(tài)
order: 0, //工作表的下標
hide: 0, //是否隱藏
row: 36, //行數(shù)
column: 10, //列數(shù)
defaultRowHeight: 28, //自定義行高,單位px
defaultColWidth: 100, //自定義列寬,單位px
celldata: [], //初始化使用的單元格數(shù)據(jù),r代表行尖奔,c代表列茬底,v代表該單元格的值沪悲,最后展示的是value1,value2
config: {
merge: {}, //合并單元格
rowlen: {}, //表格行高
columnlen: {}, //表格列寬
rowhidden: {}, //隱藏行
colhidden: {}, //隱藏列
borderInfo: {}, //邊框
authority: {}, //工作表保護
},
scrollLeft: 0, //左右滾動條位置
scrollTop: 0, //上下滾動條位置
luckysheet_select_save: [], //選中的區(qū)域
calcChain: [], //公式鏈
isPivotTable: false, //是否數(shù)據(jù)透視表
pivotTable: {}, //數(shù)據(jù)透視表設置
filter_select: {}, //篩選范圍
filter: null, //篩選配置
luckysheet_alternateformat_save: [], //交替顏色
luckysheet_alternateformat_save_modelCustom: [], //自定義交替顏色
luckysheet_conditionformat_save: {}, //條件格式
frozen: {}, //凍結(jié)行列配置
chart: [], //圖表配置
zoomRatio: 1, // 縮放比例
image: [], //圖片
showGridLines: 1, //是否顯示網(wǎng)格線
dataVerification: {}, //數(shù)據(jù)驗證配置
},
],
showtoolbar: false,
showtoolbarConfig: {
undoRedo: false, //撤銷重做阱表,注意撤消重做是兩個按鈕殿如,由這一個配置決定顯示還是隱藏
paintFormat: false, //格式刷
currencyFormat: false, //貨幣格式
percentageFormat: false, //百分比格式
numberDecrease: false, // '減少小數(shù)位數(shù)'
numberIncrease: false, // '增加小數(shù)位數(shù)
moreFormats: false, // '更多格式'
font: false, // '字體'
fontSize: false, // '字號大小'
bold: false, // '粗體 (Ctrl+B)'
italic: false, // '斜體 (Ctrl+I)'
strikethrough: false, // '刪除線 (Alt+Shift+5)'
underline: false, // '下劃線 (Alt+Shift+6)'
textColor: false, // '文本顏色'
fillColor: false, // '單元格顏色'
border: false, // '邊框'
mergeCell: false, // '合并單元格'
horizontalAlignMode: false, // '水平對齊方式'
verticalAlignMode: false, // '垂直對齊方式'
textWrapMode: false, // '換行方式'
textRotateMode: false, // '文本旋轉(zhuǎn)方式'
image: false, // '插入圖片'
link: false, // '插入鏈接'
chart: false, // '圖表'(圖標隱藏,但是如果配置了chart插件最爬,右擊仍然可以新建圖表)
postil: false, //'批注'
pivotTable: false, //'數(shù)據(jù)透視表'
function: false, // '公式'
frozenMode: false, // '凍結(jié)方式'
sortAndFilter: false, // '排序和篩選'
conditionalFormat: false, // '條件格式'
dataVerification: false, // '數(shù)據(jù)驗證'
splitColumn: false, // '分列'
screenshot: false, // '截圖'
findAndReplace: false, // '查找替換'
protection: false, // '工作表保護'
print: false, // '打印'
},
showsheetbar: false, //是否顯示底部sheet頁按鈕
showsheetbarConfig: {
add: false, //新增sheet
menu: false, //sheet管理菜單
sheet: false, //sheet頁顯示
},
showinfobar: false, //是否顯示頂部信息欄
showstatisticBar: false, //是否顯示底部計數(shù)欄
showstatisticBarConfig: {
count: false, // 計數(shù)欄
view: false, // 打印視圖
zoom: false, // 縮放
},
sheetFormulaBar: false, //是否顯示公式欄
allowCopy: false, //是否允許拷貝
enableAddRow: true, //允許添加行
});
});
// });
},
};
</script>
<style lang="css" scoped>
.luckysheet-content {
margin: 0px;
padding: 0px;
position: absolute;
width: 100%;
height: 500px;
left: 0px;
top: 40px;
bottom: 0px;
}
</style>
- 可實現(xiàn)復制粘貼涉馁,excel的單元格下拉等表格操作,重點在于創(chuàng)建luckysheet實例時對實例屬性的配置爱致。
第二步:
引用組件烤送,在父組件中注冊并引用組件。先import 組件糠悯,再components 中注冊帮坚,最后在以標簽的形式引用組件。代碼如下:
<template>
<div id="app">
<HelloWorld />
</div>
</template>
<script>
import HelloWorld from './components/HelloWorld.vue'
export default {
name: 'App',
components: {
HelloWorld
}
}
</script>
<style>
#app {
font-family: Avenir, Helvetica, Arial, sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
text-align: center;
color: #2c3e50;
margin-top: 60px;
}
</style>
第三步:
父組件將接口返回的數(shù)據(jù)傳遞給子組件互艾,子組件獲取數(shù)據(jù)渲染數(shù)據(jù)试和。代碼如下:
- 父組件中獲取數(shù)據(jù)并綁定參數(shù)傳值。
<template>
<div id="app">
<HelloWorld v-bind:sheetParams="sheetParams" />
</div>
</template>
<script>
import HelloWorld from "./components/HelloWorld.vue";
export default {
name: "App",
components: {
HelloWorld,
},
data() {
return {
sheetParams: {
excelHeader: ["姓名", "年齡", "性別"],
excelData: {
姓名: ["張三", "趙蘭", "李四"],
年齡: ["18", "17", "20"],
性別: ["男", "女", "男"],
},
},
};
},
};
</script>
<style>
#app {
font-family: Avenir, Helvetica, Arial, sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
text-align: center;
color: #2c3e50;
margin-top: 60px;
}
</style>
- 子組件獲取父組件傳遞的數(shù)據(jù)纫普,渲染數(shù)據(jù)阅悍。
<template>
<div class="hello">
<div id="luckysheet" class="luckysheet-content"></div>
</div>
</template>
<script>
export default {
name: "HelloWorld",
props: {
sheetParams: {},
},
data() {
return {
luckysheetOption: {
container: "luckysheet", // 設定DOM容器的id
title: "Luckysheet Demo", // 設定表格名稱
lang: "zh", // 設定表格語言
plugins: ["chart"],
data: [
{
name: "", //工作表名稱
color: "#eee333", //工作表(工作表名稱底部邊框線)顏色
index: 0, //工作表索引(新增一個工作表時該值是一個隨機字符串)
status: 1, //激活狀態(tài)
order: 0, //工作表的下標
hide: 0, //是否隱藏
row: 36, //行數(shù)
column: 10, //列數(shù)
defaultRowHeight: 28, //自定義行高,單位px
defaultColWidth: 100, //自定義列寬,單位px
celldata: [], //初始化使用的單元格數(shù)據(jù),r代表行,c代表列昨稼,v代表該單元格的值节视,最后展示的是value1,value2
config: {
merge: {}, //合并單元格
rowlen: {}, //表格行高
columnlen: {}, //表格列寬
rowhidden: {}, //隱藏行
colhidden: {}, //隱藏列
borderInfo: {}, //邊框
authority: {}, //工作表保護
},
scrollLeft: 0, //左右滾動條位置
scrollTop: 0, //上下滾動條位置
luckysheet_select_save: [], //選中的區(qū)域
calcChain: [], //公式鏈
isPivotTable: false, //是否數(shù)據(jù)透視表
pivotTable: {}, //數(shù)據(jù)透視表設置
filter_select: {}, //篩選范圍
filter: null, //篩選配置
luckysheet_alternateformat_save: [], //交替顏色
luckysheet_alternateformat_save_modelCustom: [], //自定義交替顏色
luckysheet_conditionformat_save: {}, //條件格式
frozen: {}, //凍結(jié)行列配置
chart: [], //圖表配置
zoomRatio: 1, // 縮放比例
image: [], //圖片
showGridLines: 1, //是否顯示網(wǎng)格線
dataVerification: {}, //數(shù)據(jù)驗證配置
},
],
showtoolbar: false,
showtoolbarConfig: {
undoRedo: false, //撤銷重做假栓,注意撤消重做是兩個按鈕肴茄,由這一個配置決定顯示還是隱藏
paintFormat: false, //格式刷
currencyFormat: false, //貨幣格式
percentageFormat: false, //百分比格式
numberDecrease: false, // '減少小數(shù)位數(shù)'
numberIncrease: false, // '增加小數(shù)位數(shù)
moreFormats: false, // '更多格式'
font: false, // '字體'
fontSize: false, // '字號大小'
bold: false, // '粗體 (Ctrl+B)'
italic: false, // '斜體 (Ctrl+I)'
strikethrough: false, // '刪除線 (Alt+Shift+5)'
underline: false, // '下劃線 (Alt+Shift+6)'
textColor: false, // '文本顏色'
fillColor: false, // '單元格顏色'
border: false, // '邊框'
mergeCell: false, // '合并單元格'
horizontalAlignMode: false, // '水平對齊方式'
verticalAlignMode: false, // '垂直對齊方式'
textWrapMode: false, // '換行方式'
textRotateMode: false, // '文本旋轉(zhuǎn)方式'
image: false, // '插入圖片'
link: false, // '插入鏈接'
chart: false, // '圖表'(圖標隱藏,但是如果配置了chart插件但指,右擊仍然可以新建圖表)
postil: false, //'批注'
pivotTable: false, //'數(shù)據(jù)透視表'
function: false, // '公式'
frozenMode: false, // '凍結(jié)方式'
sortAndFilter: false, // '排序和篩選'
conditionalFormat: false, // '條件格式'
dataVerification: false, // '數(shù)據(jù)驗證'
splitColumn: false, // '分列'
screenshot: false, // '截圖'
findAndReplace: false, // '查找替換'
protection: false, // '工作表保護'
print: false, // '打印'
},
showsheetbar: false, //是否顯示底部sheet頁按鈕
showsheetbarConfig: {
add: false, //新增sheet
menu: false, //sheet管理菜單
sheet: false, //sheet頁顯示
},
showinfobar: false, //是否顯示頂部信息欄
showstatisticBar: false, //是否顯示底部計數(shù)欄
showstatisticBarConfig: {
count: false, // 計數(shù)欄
view: false, // 打印視圖
zoom: false, // 縮放
},
sheetFormulaBar: false, //是否顯示公式欄
allowCopy: false, //是否允許拷貝
enableAddRow: true, //允許添加行
}
};
},
created() {},
mounted() {
this.initLuckysheet(this.sheetParams);
},
methods: {
initLuckysheet(data) {
var _this = this;//注意這里要重新指定下this對象。
// In some cases, you need to use $nextTick
// this.$nextTick(() => {
$(function () {
if (data.excelHeader.length != 0 && JSON.stringify(data.excelData) != "{}") {
_this.luckysheetOption.hook = {
workbookCreateAfter: function () {
_this.dataRendSheet(data.excelHeader, data.excelData);
},
};
}
luckysheet.create(_this.luckysheetOption);
});
// });
},
/**接口數(shù)據(jù)回顯 */
dataRendSheet(excelHeader, excelData) {
//回顯表格表頭抗楔,第一行
if (excelHeader.length > 0) {
excelHeader.forEach((item1, index1) => {
luckysheet.setCellValue(0, index1, item1);
//普通回顯數(shù)據(jù)
if (JSON.stringify(excelData) != "{}") {
excelData[item1].forEach((item2, index2) => {
var row = index2 + 1;
luckysheet.setCellValue(row, index1, item2);
});
}
});
}
},
},
};
</script>
<style lang="css" scoped>
.luckysheet-content {
margin: 0px;
padding: 0px;
position: absolute;
width: 100%;
height: 500px;
left: 0px;
top: 40px;
bottom: 0px;
}
</style>
- 注意兩點棋凳,第一數(shù)據(jù)格式,就是對象數(shù)組的轉(zhuǎn)換连躏,沒什么難度剩岳;第二用到了Luckysheet的鉤子函數(shù),鉤子函數(shù)的用法是在配置對象加一個hook對象入热,并給hook對象添加一個workbookCreateAfter方法拍棕,在工作簿創(chuàng)建好之后就執(zhí)行這個函數(shù)的渲染數(shù)據(jù)的邏輯晓铆。
第四步:
父組件獲取子組件修改后的數(shù)據(jù)。父組件的布局和樣式有調(diào)整绰播,以對話框的形式來引用組件骄噪,點擊按鈕,獲取數(shù)據(jù)蠢箩。代碼如下:
<template>
<div id="app">
<div>
<el-dialog
:title="luckysheetName"
:visible.sync="centerDialogVisible"
v-if="centerDialogVisible"
width="50%"
:fullscreen="fullscreen"
:lock-scroll="lockScroll"
:close-on-click-modal="closeOnClickModal"
:close-on-press-escape="closeOnPressEscape"
>
<div style="width: 100%; height: 500px; position: relative">
<!-- luckysheet 數(shù)據(jù)編輯組件引用 -->
<HelloWorld
ref="luckysheetRef"
v-on:getLuckySheetData="receive"
v-bind:sheetParams="sheetParams"
/>
</div>
<div slot="footer" class="dialog-footer">
<el-button @click="handleToClose">取 消</el-button>
<el-button type="primary" @click="saveSheetData">確 定</el-button>
</div>
</el-dialog>
</div>
</div>
</template>
<script>
import HelloWorld from "./components/HelloWorld.vue";
export default {
name: "App",
components: {
HelloWorld,
},
data() {
return {
centerDialogVisible: true,
closeOnClickModal: false,
closeOnPressEscape: false,
fullscreen: false,
lockScroll: false,
luckysheetName: "luckysheet數(shù)據(jù)編輯",
sheetParams: {
excelHeader: ["姓名", "年齡", "性別"],
excelData: {
姓名: ["張三", "趙蘭", "李四"],
年齡: ["18", "17", "20"],
性別: ["男", "女", "男"],
},
},
luckySheetData: {
excelHeader: [],
excelData: {},
},
};
},
methods: {
saveSheetData() {
var _this = this;
_this.$refs.luckysheetRef.getSheetData(); //調(diào)用子組件獲取sheet數(shù)據(jù)
console.log(JSON.stringify(_this.luckySheetData));
// document.getElementById("luckysheet-input-box").style.zIndex = "-1";
// document.getElementsByClassName("luckysheet-cell-input").innerHTML = "";
// _this.dialogFormVisible = false; //關(guān)閉對話框
},
//luckySheet數(shù)據(jù)接收
receive: function (sheetTitle, commonData) {
var _this = this;
_this.luckySheetData.excelHeader = sheetTitle;
_this.luckySheetData.excelData = commonData;
},
handleToClose() {
this.centerDialogVisible = false;
}
},
};
</script>
<style>
#app {
font-family: Avenir, Helvetica, Arial, sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
text-align: center;
color: #2c3e50;
margin-top: 60px;
}
</style>
點擊確定按鈕链蕊,獲取的數(shù)據(jù)格式為:
{"excelHeader":["姓名","年齡","性別"],"excelData":[{"姓名":"張三","年齡":18,"性別":"男"},{"姓名":"趙蘭","年齡":17,"性別":"女"},{"姓名":"李四","年齡":20,"性別":"男"}]}
- 注意一:如果想每次打開對話框都重新加載數(shù)據(jù)和渲染畫布,則在對話框加上兩行代碼:
:visible.sync="centerDialogVisible"谬泌;v-if="centerDialogVisible"
-
注意二:luckysheet文件的引用路徑一定要對