1.0.10 • Published 8 months ago

excel-jiniu v1.0.10

Weekly downloads
-
License
-
Repository
-
Last release
8 months ago

Excel组件文档

仅支持 vue 项目使用

安装


使用 npm

$ npm install excel-jiniu

使用 yarn

$ yarn add excel-jiniu

用法


main.js 中引入

import Vue from 'vue'
import ExcelInstall from 'excel-jiniu'
import 'excel-jiniu/excel.style.css'

Vue.use(ExcelInstall)

test.vue/test.tsx文件中使用

<ExcelJN :config="config" ref="excelRef"></ExcelJN>
<script setup>
import { ref, nextTick } from "vue";
// import ExcelJN from "./views/index.vue";

const excelRef = ref();
const excelData = ref();
const config = ref({
  wsUrl: `ws://127.0.0.1:7001/ws?excel/${知识库名}/${文件名}`,
  data: {},
});

const getExcelData = () => {
  const params = {
    id: "96d72cbb-6635-107b-de35-2a2cced7c62d",
  };
  fetch("http://127.0.0.1:7001/excel/getExcel", {
    method: "POST",
    body: JSON.stringify(params),
    headers: {
      token: "uItiVZDpgQHVTzFHWUdDzqyCgTsaXezm1724846619",
      "content-type": "application/json",
    },
  })
    .then((res) => res.json())
    .then((res) => {
      excelData.value = res.data;
      formatData(res.data);
    });
};

// 接口数据格式化为excel初始化数据格式
const formatData = (data) => {
  const workbook = {
    id: data.id,
    name: data.title,
    sheetOrder: data.sheetOrder || [],
    sheets: {},
    styles: {},
  };

  if (Array.isArray(data.sheets)) {
    data.sheets.forEach((item) => {
      const worksheet = {
        id: item.id,
        name: item.name,
        color: item.color,
        hide: item.hide,
        columnCount: item.columnCount,
        rowCount: item.rowCount,
        cellData: item.cellData,
        mergeData: item.mergeData,
      };
      workbook.sheets[item.id] = worksheet;
    });
  }

  config.value.data = workbook;

  nextTick(() => {
    // 初始化excel组件
    excelRef.value?.init();
  });
};

getExcelData();
</script>

配置参数

  • WorkbOOK
参数是否必填类型描述默认值
appVersionstring版本0.2.12
idstring工作簿id-
localestring语音zh_CN
namestring工作簿名称-
resourcesResources[]存储插件相关数据undefined
sheetOrderstring[]sheet页id顺序[]
sheetsRecord<string, Worksheet>sheet页数据{}
stylesStyle样式undefined
  • Worksheet
参数是否必填类型描述默认值
idstringidundefined
cellDataCellData表格数据配置undefined
datastring数据undefined
namestringsheet页名称-
columnCountnumber列数36
rowCountnumber行数300
rowDataRowData[]行配置undefined
rowHeaderRowHeader行头数据undefined
columnDataColumnData[]列数据属性undefined
columnHeaderColumnHeader列头属性undefined
defaultColumnWidthnumber默认列宽84
defaultRowHeightnumber默认行高32
freezeFreezeundefined
hiddenBooleanNumber是否隐藏undefined
mergeDataRange合并单元格undefined
rightToLeftBooleanNumber是否从右到左展示undefined
showGridlinesBooleanNumber显示表格线1
tabColorstringsheet页tab颜色undefined
  • Resource
参数是否必填类型描述默认值
idstringidundefined
namestring名称-
datastring数据-
  • CellData
参数是否必填类型描述默认值
fstring公式undefined
pstring名称undefined
sobject样式数据undefined
sistring公式idundefined
tNullable值类型-
vstring|number|boolean-
  • CellValueType
枚举
BOOLEAN3
FORCE_STRING4
NUMBER2
STRING1
  • RowData
参数是否必填类型描述默认值
hdBooleanNumber隐藏undefined
hnumber高度undefined
ahnumber自动高度undefined
iaBooleanNumbertrue当前行自动高度 false固定高度undefined
  • RowHeader
参数是否必填类型描述默认值
hiddenBooleanNumber隐藏undefined
widthnumber款度84
  • ColumnData
参数是否必填类型描述默认值
hdBooleanNumber隐藏undefined
wnumber宽度undefined
  • ColumnHeader
参数是否必填类型描述默认值
hiddenBooleanNumber隐藏undefined
heightnumber高度32
  • Freeze
参数是否必填类型描述默认值
startRownumber-undefined
startColumnnumber-undefined
ySplitnumber-undefined
xSplitnumber-undefined
  • Range
参数是否必填类型描述默认值
startRownumber-undefined
startColumnnumber-undefined
endRownumber-undefined
endColumnnumber-undefined
  • Style
参数是否必填类型描述默认值
bblnumber边框底线undefined
bdnumber-undefined
bgnumber-undefined
blnumber-undefined
  • TextDecoration
参数是否必填类型描述默认值
cBooleanNumber颜色跟随字体颜色。默认值为TRUE,如果未定义,也为TRUE。当c为TRUE时,cl不起作用。undefined
clstring颜色undefined
sBooleanNumber显示状态undefined
tTextDecoration线类型undefined
  • TextDecoration
枚举
DASH0
DASHED_HEAVY3
DASH_DOT_DOT_HEAVY1
DASH_DOT_HEAVY2
DASH_LONG4
DASH_LONG_HEAVY5
DOTTED8
DOTTED_HEAVY9
DOT_DASH6
DOT_DOT_DASH7
DOUBLE10
NONE11
SINGLE12
THICK13
WAVE14
WAVY_DOUBLE15
WAVY_HEAVY16
WORDS17
  • BooleanNumber
枚举
TRUE1
FALSE0