NPM 包 tortuga-js 使用教程

阅读时长 4 分钟读完

简介

tortuga-js 是一个适用于前端开发者的一个快速生成时序图的工具。它使用简单,生成出来的图形更容易阅读与分析,是前端开发者进行时序图绘制的好帮手。

安装

在命令行中使用下面的命令进行安装:

使用方法

引入

在 Javascript 中引入 tortuga-js:

创建一个基本的时序图

通过 generateTimingDiagram 可以很容易地创建出一个基础的时序图。假设我们现在要绘制两个信号 Signal1Signal2

-- -------------------- ---- -------
----- ------ - -
  --- -----------------
  -------- -
    -
      ----- ----------
      ----- ----------
    --
    -
      ----- ----------
      ----- ------------------
    -
  -
--
------------------------------

自定义时序图

通过修改 config 参数可以自定义时序图的一些属性。

-- -------------------- ---- -------
----- ------ - -
  --- -----------------
  ----- ------- ---------
  ------- --
  ------- ---
  ------ ----
  --------- -----
  -------- -
    -
      ----- ----------
      ----- -----------
      --- ---
    --
    -
      ----- ----------
      ----- -------------------
      --- -----
    -
  -
--
------------------------------

参数说明:

  • id: 图表的 DOM 元素的 id。
  • name: 图表的名称。
  • hscale: 时间轴的缩放比例。
  • period: 时间轴的周期。
  • phase: 时间轴的相位。
  • showgrid: 是否显示网格。
  • signals: 信号数组,每个信号都需要包括 namewave 两个属性。

信号的类型

wave 字段中,可以使用以下字符来表示不同的时序信号类型:

  • 0: 低电平
  • 1: 高电平
  • h: 高阻态
  • l: 低阻态
  • x: 未知的状态
  • z: 高阻态

信号的时间间隔

wave 字段中,可以使用以下字符来设置信号状态的时间间隔:

  • 1: 一个时间单位
  • 2: 两个时间单位
  • 3: 三个时间单位
  • 4: 四个时间单位
  • 5: 五个时间单位
  • 6: 六个时间单位
  • 7: 七个时间单位
  • 8: 八个时间单位
  • 9: 九个时间单位
  • p: 半个周期
  • .: 一个时钟周期

代码示例:

-- -------------------- ---- -------
--------- -----
------
------
  ----- ----------------
  -----------------------------
  ------- ---------------------------------------------------------------------------------
-------
------
  ---- --------------------------
  --------
    ----- ------ - -
      --- -----------------
      ----- ------- ---------
      ------- --
      ------- ---
      ------ ----
      --------- -----
      -------- -
        -
          ----- ----------
          ----- -----------
          --- ---
        --
        -
          ----- ----------
          ----- -------------------
          --- -----
        -
      -
    --
    ------------------------------
  ---------
-------
-------

结语

tortuga-js 简单易用,可以让前端开发者在进行时序图绘制时,更高效地完成任务。欢迎大家在项目中使用。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055f1c81e8991b448dcb2f

纠错
反馈