WPS 加载项开发说明wpsjs

wpsjs几个常用的CMD命令:

1.打开cmd输入命令测试版本号 npm -v

2.首次安装nodejs,npm默认国外镜像,包下载较慢时,可切换到国内镜像

//下载速度较慢时可切换国内镜像

npm config set registry https://registry.npmmirror.com

//国内镜像不可用时,恢复官方镜像

npm config set registry https://registry.npmjs.org

3.全局安装命令:npm install -g wpsjs

4.以前安装过可以用更新命令:npm update -g wpsjs

5.显示帮助信息命令:wpsjs -h

6.wpsjs debug 命令启动加载项进行调式,按下Ctrl + C可停止调式

7.打包命令:wpsjs build,选择离线插件

8.发布命令:wpsjs publish

9.把wpstest.7z解压到jsaddons目录,输入cmd命令可快速打开该文件夹:start %Appdata%\kingsoft\wps\jsaddons

注意!解压的文件夹名称格式必须是加载项名称 + _ + 版本号,例如:wpsai_1.0.0

10.新建一个wps加载项(文字、电子表格): wpsjs create HelloWps

11.代码联想依赖包wps-jsapi更新:npm update --save-dev wps-jsapi

wps-jsapi这个依赖包是wps支持的全部接口的TypeScript描述,方便在vscode中敲代码时,提供代码联想功能,由于wps接口会跟随业务需求不断更新,因此当发现代码联想接口不支持时,可以通过该命令更新这个包。

WPS 加载项结构

WPS 加载项由 自定义功能区和 网页 两部分组成。

自定义功能区只需要一个配置文件,对应 WPS 加载项目录中的ribbon.xml文件;

网页部分负责执行自定义功能区对应的逻辑功能。因为不需要显示网页,所以省略了 HTML 文件,并用main.js来引入所有的外部 JavaScript 文件; 在这些 JavaScript 文件中通常包含了一系列用 JavaScript 实现的函数。

启动流程

WPS 加载项启动时,首先:

在 WPS 加载项对应文件夹中自动创建index.html网页并打开,

index.html从当前路径引入main.js,从而能够在接下来的过程中执行接口函数。

当网页打开成功之后,开始解析ribbon.xml生成自定义功能区,解析过程中会调用若干次接口函数,最终完成加载。

注意,开发者应当避免在该目录下创建index.html。

WPS 加载项 API 使用

WPS 加载项 API 通过对 JavaScript 功能进行的扩展,实现了网页与 WPS 应用程序交互的能力。这些 API 被集中在window.wps对象下,而我们在开发中通常会省略掉window,直接以wps开始。

调试

WPS 加载项调试是对其中的一个网页单独进行的调试。调试时会弹出一个独立调试器对话框,除此之外和网页调试基本一致。 可以在调试器的 Console 中直接查看任意的 API 属性和调用 API 方法。调试自动生成的index.html网页,使用快捷键 ALT + F12。 注意调试过程中需要先关闭alert或其它同步弹框,才能继续向下调试。

系统集成

可以在自己的浏览器中调用 WPS 加载项的 JavaScript 方法。 wps_sdk.js对调用进行了封装,让开发者可以快速调用, wps_sdk.js对Chrome、Edge、IE8及IE8以上浏览器进行了支持。

WPS加载项的JSAPI技术内核

相关推荐
醇氧1 天前
【wps】 excel 删除重复项
excel·wps
不坑老师3 天前
利用不坑盒子的Copilot,快速排值班表
microsoft·word·powerpoint·excel·copilot·wps
LENG_Lingliang14 天前
word出现由WPS切换后公式异常无法删除的情况处理
word·wps·mathtype
阿门阿前一棵小白菜16 天前
宇宙尽头是WPS之——【Excel】一个自动重新排序的宏
excel·wps
Ven%16 天前
Linux环境下使用WPS比较word文档并生成修订
linux·服务器·python·wps
明月看潮生16 天前
青少年编程与数学 01-012 通用应用软件简介 02 WPS Office办公软件
青少年编程·wps·编程与数学·应用软件
大头大了17 天前
《超级处理器》怎么安装到WPS/excel(最后有下载地址)
excel·wps
坚毅不拔的柠檬柠檬17 天前
AI办公提效,Deepseek + wps生成ppt
人工智能·ai·wps·deepseek
流浪猪头拯救地球18 天前
WPS 和 office (word/excel/ppt) 找到模板所在位置以及更改模板的方式(公文写作格式要求、字体安装、模板下载)
word·excel·wps
爱上妖精的尾巴18 天前
3-18 WPS JS宏 颜色设置实例应用(按条件设置单元格颜色)学习笔记
javascript·笔记·学习·excel·wps·js宏·jsa