YoWASP WaveDrom软件包

此软件包为JavaScript和Python应用程序提供了一个自包含的WaveDrom渲染器。有关YoWASP项目的概述详情。

命令行工具

此软件包安装了一个命令行工具yowasp-wavedrom。

Usage: yowasp-wavedrom [<input.json>] [<output.svg>]

API参考（JavaScript）

包@yowasp/wavedrom有一个入口点，render(source): string。它接受WaveJSON格式的JavaScript对象，并返回作为字符串序列化的SVG图像

import { render } from '@yowasp/wavedrom';

console.log(render({signal: [{ name: "clk", wave: "p..." }, { name: "data", wave: "01.0" }]}));
// => <svg.../svg>

API参考（Python）

软件包yowasp-wavedrom有一个入口点，render(source) -> str。它接受WaveJSON格式的Python字典，并返回作为字符串序列化的SVG图像

from yowasp_wavedrom import render

print(render({"signal": [{ "name": "clk", "wave": "p..." }, { "name": "data", "wave": "01.0" }]}))
# => <svg.../svg>

实现说明

此软件包包含由upstream WaveDrom库捆绑的最小依赖量，用于生成序列化的SVG，对于Python软件包，还包含JavaScript运行时。此外，输出与上游库相比进行了后处理，如下所示

• 根<svg>元素的id属性被删除。
• 样式表被修改，以考虑通过媒体查询的暗色方案偏好。如果用户代理报告暗色方案偏好，则图表中的颜色将被反转。
  • 在暗色波形图表皮肤的情况下，这将导致它使用浅色。
  • 当使用<img>标签将SVG图像嵌入HTML文档时，可以使用CSS规则如img { color-scheme: light; }为每张图像设置颜色方案偏好。这可以用于使图像对动态主题做出响应，或者简单地覆盖默认行为。
• 解决了几个其他阻碍性的bug。

更新

与大多数YoWASP包不同，此包不会自动跟踪上游发布。如果您需要来自WaveDrom较新版本的特性，请提交一个拉取请求，提升package-in.json中wavedrom的版本。

许可

此包受MIT许可的保护。