npm 包 cal-heatmap 使用教程

阅读时长 5 分钟读完

简介

cal-heatmap 是一个基于 D3.js 的可视化库,用于创建热力图。它能够处理和显示大量的时间序列数据,并支持各种自定义选项。

cal-heatmap 的优点:

  • 易于使用和集成到现有的项目中。
  • 可以处理大量数据且具有良好的性能。
  • 可以高度自定义,包括颜色映射、单元格大小、标记等等。

安装

在使用之前,需要先安装 cal-heatmap。可以通过以下命令来安装:

接下来,我们需要引入样式文件 cal-heatmap.css 和脚本文件 cal-heatmap.min.js,例如:

基本用法

首先,我们需要一个 HTML 元素作为容器来渲染热力图。通常情况下,我们会使用一个 div 元素:

然后,在 JavaScript 中,我们需要实例化一个 CalHeatMap 对象,并将其附加到容器上:

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

以上代码会将热力图渲染到 #heatmap-container 元素中。其中,myData 是一个包含时间序列数据的对象。

自定义选项

cal-heatmap 提供了许多自定义选项,以便根据具体需求调整热力图的样式和行为。下面是一些常用的选项:

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

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

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

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

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

示例代码

下面是一个完整的示例代码,用于创建一个显示 GitHub 提交活动的热力图:

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

- ----------------------------------------------------------- --------
----------------------------------------------------------------------------------
纠错
反馈