更好的扩展SVG.Element的方法,可以使vscode知道所做的更改并提供文档

如何解决更好的扩展SVG.Element的方法,可以使vscode知道所做的更改并提供文档

我正在使用SVG.js,而documentation描述了一种扩展库中类的方法,以便为扩展该类的所有对象添加额外的功能。

我想出了这个示例,为从SVG.Element继承的任何对象提供一个红色边框。

import * as SVG from '@svgdotjs/svg.js';

SVG.extend(SVG.Element,{
    bounding_box: function(margin) {
        var bbox = this.bbox()
        return this.parent().rect({
            x: bbox.x - margin/2,y: bbox.y - margin/2,width: bbox.width + margin,height: bbox.height + margin
        })
        .stroke("red")
        .attr("fill-opacity",0)
    }
})

但是,尽管这可行,但是在运行时发生的事实不允许vscode在继承自SVG.Element的对象上为此功能提供智能建议。同样,我无法提供使用此功能文档来获得此功能的任何人

我尝试在Element类的正文中更改node_modules/@svgdotjs/svg.js/dist/svg.node.js文件和node_modules/@svgdotjs/svg.js/src/elements/Element.js 以包括我的功能,但是尝试使用它时我收到一条错误消息,说该功能不存在。

我更愿意为open source project on github做出贡献,但是在我弄清这些该死的文件以及实际上将要工作的东西之前,恐怕我没有用。

我需要更改哪个文件才能将新功能写入库的SVG.Element类?我需要克隆存储库并进行重建吗?

我以前从未做过开源,所以这对我来说是第一次。干杯。

解决方法

IntelliSense使用JSDoc语法的子集来增强代码完成度。不幸的是,关于什么有效或无效的文档不完整。 This page做出了很多承诺,但是here起作用的列表要小得多。

描述此类扩展的正确JSDoc方法是使用@mixin MyExtension注释对象文字作为SVG.extend()的参数,然后用@mixes MyExtension注释该类。这在VSCode v1.48中不起作用。

相反,尽管将@memberof批注的使用列为“越野车”,但这似乎是可行的。您要混合的方法必须与对象文字分开编写:

//mockup for the purpose of testing
const SVG = {};

SVG.Element = class {
    bbox () {
        return {x:0,y:0,width:1,height:1}
    }
    parent () {
        return this;
    }
}

/** 
 * @memberof SVG.Element
 * @param {number} margin
 */
function bounding_box (margin) {
    var bbox = this.bbox()
    return this.parent().rect({
        x: bbox.x - margin/2,y: bbox.y - margin/2,width: bbox.width + margin,height: bbox.height + margin
    })
    .stroke("red")
    .attr("fill-opacity",0)
}

SVG.extend(SVG.Element,{bounding_box});

然后将this函数内的bounding_box正确识别为SVG.Element类型。写作时

const el = SVG.Element();
el.bounding_box()

.bounding_box未在提示中列为方法,但正确键入了margin参数。

enter image description here

在边栏中,大纲将.bounding_box显示为SVG.Element的成员,但将其显示为属性,而不是方法。

enter image description here

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


依赖报错 idea导入项目后依赖报错,解决方案:https://blog.csdn.net/weixin_42420249/article/details/81191861 依赖版本报错:更换其他版本 无法下载依赖可参考:https://blog.csdn.net/weixin_42628809/a
错误1:代码生成器依赖和mybatis依赖冲突 启动项目时报错如下 2021-12-03 13:33:33.927 ERROR 7228 [ main] o.s.b.d.LoggingFailureAnalysisReporter : *************************** APPL
错误1:gradle项目控制台输出为乱码 # 解决方案:https://blog.csdn.net/weixin_43501566/article/details/112482302 # 在gradle-wrapper.properties 添加以下内容 org.gradle.jvmargs=-Df
错误还原:在查询的过程中,传入的workType为0时,该条件不起作用 <select id="xxx"> SELECT di.id, di.name, di.work_type, di.updated... <where> <if test=&qu
报错如下,gcc版本太低 ^ server.c:5346:31: 错误:‘struct redisServer’没有名为‘server_cpulist’的成员 redisSetCpuAffinity(server.server_cpulist); ^ server.c: 在函数‘hasActiveC
解决方案1 1、改项目中.idea/workspace.xml配置文件,增加dynamic.classpath参数 2、搜索PropertiesComponent,添加如下 <property name="dynamic.classpath" value="tru
删除根组件app.vue中的默认代码后报错:Module Error (from ./node_modules/eslint-loader/index.js): 解决方案:关闭ESlint代码检测,在项目根目录创建vue.config.js,在文件中添加 module.exports = { lin
查看spark默认的python版本 [root@master day27]# pyspark /home/software/spark-2.3.4-bin-hadoop2.7/conf/spark-env.sh: line 2: /usr/local/hadoop/bin/hadoop: No s
使用本地python环境可以成功执行 import pandas as pd import matplotlib.pyplot as plt # 设置字体 plt.rcParams['font.sans-serif'] = ['SimHei'] # 能正确显示负号 p
错误1:Request method ‘DELETE‘ not supported 错误还原:controller层有一个接口,访问该接口时报错:Request method ‘DELETE‘ not supported 错误原因:没有接收到前端传入的参数,修改为如下 参考 错误2:cannot r
错误1:启动docker镜像时报错:Error response from daemon: driver failed programming external connectivity on endpoint quirky_allen 解决方法:重启docker -> systemctl r
错误1:private field ‘xxx‘ is never assigned 按Altʾnter快捷键,选择第2项 参考:https://blog.csdn.net/shi_hong_fei_hei/article/details/88814070 错误2:启动时报错,不能找到主启动类 #
报错如下,通过源不能下载,最后警告pip需升级版本 Requirement already satisfied: pip in c:\users\ychen\appdata\local\programs\python\python310\lib\site-packages (22.0.4) Coll
错误1:maven打包报错 错误还原:使用maven打包项目时报错如下 [ERROR] Failed to execute goal org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources (default-resources)
错误1:服务调用时报错 服务消费者模块assess通过openFeign调用服务提供者模块hires 如下为服务提供者模块hires的控制层接口 @RestController @RequestMapping("/hires") public class FeignControl
错误1:运行项目后报如下错误 解决方案 报错2:Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.8.1:compile (default-compile) on project sb 解决方案:在pom.
参考 错误原因 过滤器或拦截器在生效时,redisTemplate还没有注入 解决方案:在注入容器时就生效 @Component //项目运行时就注入Spring容器 public class RedisBean { @Resource private RedisTemplate<String
使用vite构建项目报错 C:\Users\ychen\work>npm init @vitejs/app @vitejs/create-app is deprecated, use npm init vite instead C:\Users\ychen\AppData\Local\npm-