使用VUE组件创建SpreadJS自定义单元格(一)

SpreadJS自定义单元格功能提供了强大的拓展能力，一方面拓展数据展示的效果，比如checkbox，Radio button的形式展示数据。另一方面，当单元格进入编辑状态可以使用下拉菜单等任何输入控件来进行输入。

关于自定义单元格的内容可以参考学习指南-自定义单元格以及API文档。
由于框架生命周期以及自定义单元格渲染逻辑的问题，目前无法直接在框架页面下直接通过template的方式使用框架下的组件。

经过了一些调研，VUE支持动态渲染的方式来创建和挂载组件，考虑可以通过这种方式在自定义单元格中注入组件。
下面使用Element UI中autocomplete为例，演示如何在VUE 2 的项目中给SpreadJS创建一个使用VUE 组件的自定义单元格。
这种方式是否有副作用还不清楚，使用时请详细测试，大家也可以跟帖讨论，一起完善方案。
Demo中数据时mock的，实际使用中可以参考combo celltype 通过items传入。

首先，需要在项目中开启运行时加载，在vue.config.js中添加runtimeCompiler: true（更新：可以参考https://gcdn.grapecity.com.cn/showtopic-131931-1-1.html 不设置此选项）

1. module.exports = {
   
2.     devServer: {
   
3.         port: 3000
   
4.     },
   
5.     <font color="#ff0000">runtimeCompiler: true</font>
   
6.   }

复制代码

引用ElementUI，这里要注意要把element 的css引用放在APP import前，这样组件中对于样式的修改，才能覆盖原有项目

1. import Vue from 'vue'
   
2. import ElementUI from 'element-ui';
   
3. import 'element-ui/lib/theme-chalk/index.css';
   
4. import App from './App.vue'
   
5. import router from './router'
   
6. 
   
7. Vue.use(ElementUI);
   
8. 
   
9. new Vue({
   
10.   el: '#app',
    
11.   router,
    
12.   render: h => h(App)
    
13. })
    
14. 
    
15. Vue.config.productionTip = false

复制代码

创建AutoComplateCellType，具体代码如下，需要注意几点。
1. 对于自定义的元素，需要添加gcUIElement属性，如果元素或者其父元素没有该属性，点击创建的组件便会直接退出编辑状态无法编辑。
对于ElementUI 的autocomplete，默认下拉选项内容是注入到body中的，这就导致上面说问题，这里需要给组件模板中设置:popper-append-to-body="false"，让弹出的下拉选项在gcUIElement的Div中渲染。
如果使用其他组件没有类似选项，也可以跟进实际情况在弹出时在添加gcUIElement属性。
2.  使用动态挂载组件的 this.vm  设置和获取 单元格的值。
3. 在deactivateEditor中销毁组件

1. 
   
2. import Vue from 'vue'
   
3. import * as GC from "@grapecity/spread-sheets"
   
4. import DataService from './dataService'
   
5. 
   
6. function AutoComplateCellType() {
   
7. }
   
8. AutoComplateCellType.prototype = new GC.Spread.Sheets.CellTypes.Base();
   
9. AutoComplateCellType.prototype.createEditorElement = function (context, cellWrapperElement) {
   
10.   cellWrapperElement.style.overflow = 'visible'
    
11.   let editorContext = document.createElement("div")
    
12.   editorContext.setAttribute("gcUIElement", "gcEditingInput");
    
13.   let editor = document.createElement("div");
    
14.   // 自定义单元格中editorContext作为容器，需要在创建一个child用于挂载，不能直接挂载到editorContext上
    
15.   editorContext.appendChild(editor);
    
16.   return editorContext;
    
17. }
    
18. AutoComplateCellType.prototype.activateEditor = function (editorContext, cellStyle, cellRect, context) {
    
19.     let width = cellRect.width > 180 ? cellRect.width : 180;
    
20.     if (editorContext) {
    
21.         
    
22.         // 动态创建VUE 组件并挂载到editor
    
23.         const AutoCompleteComponent = {
    
24.             props: ['text','cellStyle'],
    
25.             template: `<div>
    
26.                         <el-autocomplete
    
27.                         :style="cellStyle"
    
28.                         popper-class="my-autocomplete"
    
29.                         v-model="text"
    
30.                         :fetch-suggestions="querySearch"
    
31.                         placeholder="请输入内容"
    
32.                         :popper-append-to-body="false"
    
33.                         value-key="name"
    
34.                         @select="handleSelect">
    
35.                         <i class="el-icon-edit el-input__icon"
    
36.                             slot="suffix"
    
37.                             @click="handleIconClick">
    
38.                         </i>
    
39.                         <template slot-scope="{ item }">
    
40.                             <div class="name">{{ item.name }}</div>
    
41.                             <span class="addr">{{ item.phone }}</span>
    
42.                         </template>
    
43.                         </el-autocomplete>
    
44.                     </div>`,
    
45.             mounted() {
    
46.                 this.items = DataService.getEmployeesData();
    
47.             },
    
48.             methods: {
    
49.                 querySearch(queryString, cb) {
    
50.                     var items = this.items;
    
51.                     var results = queryString ? items.filter(this.createFilter(queryString)) : items;
    
52.                     // 无法设置动态内容的位置，可以动态添加gcUIElement
    
53.                     // setTimeout(() => {
    
54.                     //   let popDiv = document.getElementsByClassName("my-autocomplete")[0];
    
55.                     //   if(popDiv){
    
56.                     //     popDiv.setAttribute("gcUIElement", "gcEditingInput");
    
57.                     //   }
    
58.                     // }, 500);
    
59.                     // 调用 callback 返回建议列表的数据
    
60.                     cb(results);
    
61.                 },
    
62.                 createFilter(queryString) {
    
63.                     return (restaurant) => {
    
64.                     return (restaurant.name.toLowerCase().indexOf(queryString.toLowerCase()) === 0);
    
65.                     };
    
66.                 },
    
67.                 handleSelect(item) {
    
68.                     console.log(item);
    
69.                 },
    
70.                 handleIconClick(ev) {
    
71.                     console.log(ev);
    
72.                 }
    
73.             }
    
74.         };
    
75. 
    
76.       // create component constructor
    
77.       const AutoCompleteCtor = Vue.extend(AutoCompleteComponent);
    
78.       this.vm = new AutoCompleteCtor({
    
79.         propsData: {
    
80.           cellStyle: {width: width+"px"}
    
81.         }
    
82.       }).$mount(editorContext.firstChild);
    
83.     }
    
84.     return editorContext;
    
85. };
    
86. AutoComplateCellType.prototype.updateEditor = function(editorContext, cellStyle, cellRect) {
    
87.     // 给定一个最小编辑区域大小
    
88.     let width = cellRect.width > 180 ? cellRect.width : 180;
    
89.     let height = cellRect.height > 40 ? cellRect.height : 40;
    
90.     return {width: width, height: height};
    
91. };
    
92. AutoComplateCellType.prototype.getEditorValue = function (editorContext) {
    
93.     // 设置组件默认值
    
94.     if (this.vm) {
    
95.         return this.vm.text;
    
96.     }
    
97. };
    
98. AutoComplateCellType.prototype.setEditorValue = function (editorContext, value) {
    
99.     // 获取组件编辑后的值
    
100.     if (editorContext) {
     
101.       this.vm.text = value;
     
102.     }
     
103. };
     
104. AutoComplateCellType.prototype.deactivateEditor = function (editorContext, context) {
     
105.     // 销毁组件
     
106.     this.vm.$destroy();
     
107.     this.vm = undefined;
     
108. };
     
109. 
     
110. 
     
111. export {AutoComplateCellType};

复制代码

最后，按照一般使用单元格类型的方式设置即可

1. import {AutoComplateCellType} from "../static/autocomplateCellType"

复制代码

1. var sheet = spread.getActiveSheet();
   
2.         sheet.getCell(1, 1).value("A").backColor("lightblue")
   
3.         sheet.setCellType(1, 1, new AutoComplateCellType())

复制代码

效果如图：

Joanna 发表于 2024-3-12 13:47
请问一下，我设置了下拉组件，但是当我点击下拉组件的选项时，那个input框就是消失掉，请问怎么处理

您好，需要您开个新帖，上传下您当前代码，我们来排查下。

请问一下，我设置了下拉组件，但是当我点击下拉组件的选项时，那个input框就是消失掉，请问怎么处理

目前来说没有什么更好的方法了，您可以尝试一下，如果可行的话欢迎您分享您的解决方案~

这个自定义的化每次都要写一个js方法吗?有没有更方便的方法?直接通过vue的h函数渲染上去.能够将这行的数据暴露出来让组件能够操作数据

这样写element-ui autoconplete自身的样式都失效了是为什么？ 变成这样了

注意到关于此问题您另开了新帖，后续在新帖中交流：
https://gcdn.grapecity.com.cn/fo ... read&tid=151077

您好，我用的版本9，为什么new GC.Spread.Sheets.CellTypes.Base();这个方法报错，显示没有CellTypes方法？

小鱼 发表于 2021-10-13 09:53
hi，我自己定义了一个组件，和你的一样，react 内 用了antd的 dropdown，但是下拉框不能从单元格出来，隐藏 ...

DOM里看看是那个元素overflow设置了hidden，改一下，可以参考下面代码

1. AutoComplateCellType.prototype.createEditorElement = function (context, cellWrapperElement) {
   
2.   cellWrapperElement.style.overflow = 'visible'

复制代码

hi，我自己定义了一个组件，和你的一样，react 内 用了antd的 dropdown，但是下拉框不能从单元格出来，隐藏到里面了，有什么建议吗