npm 包 dataent-charts 使用教程

阅读时长 8 分钟读完

什么是 dataent-charts?

dataent-charts 是一个基于 D3.js 的可视化图表库,使用 TypeScript 编写,并发布在 npm 上,可以方便地在前端项目中使用。

安装

在终端窗口中执行以下命令即可安装 dataent-charts:

快速上手

首先在 HTML 文件中引入 dataent-charts 的样式文件和 JavaScript 文件:

然后创建一个容器元素,用于显示图表:

接着在 JavaScript 文件中编写代码:

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

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

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

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

以上代码创建了一个柱状图,并将其渲染到了 id 为 chart-container 的 div 元素中。

API

dataent-charts 包含以下类:

Chart

Chart 是一个抽象类,不能直接使用,它包含以下常用 API:

  • new Chart(container: string | HTMLElement, options: ChartOptions):创建一个图表实例。
  • render():渲染图表。
  • destroy():销毁图表。
  • resize():重置图表大小。
  • update(data?: Datum[]):更新图表的数据。

BarChart

BarChart 是一个柱状图类,继承自 Chart 类,它包含以下常用 API:

  • new BarChart(container: string | HTMLElement, options: BarChartOptions):创建一个柱状图实例。
  • setXAxis(xAxis: AxisOptions):设置 x 轴的配置。
  • setYAxis(yAxis: AxisOptions):设置 y 轴的配置。

LineChart

LineChart 是一个折线图类,继承自 Chart 类,它包含以下常用 API:

  • new LineChart(container: string | HTMLElement, options: LineChartOptions):创建一个折线图实例。
  • setXAxis(xAxis: AxisOptions):设置 x 轴的配置。
  • setYAxis(yAxis: AxisOptions):设置 y 轴的配置。

PieChart

PieChart 是一个饼图类,继承自 Chart 类,它包含以下常用 API:

  • new PieChart(container: string | HTMLElement, options: PieChartOptions):创建一个饼图实例。

ChartOptions

ChartOptions 是一个接口,包含以下属性:

  • data: Datum[]:图表的数据。
  • width?: number:图表宽度,默认为 800。
  • height?: number:图表高度,默认为 400。
  • padding?: PaddingOption:图表内边距,默认为 { top: 80, right: 80, bottom: 80, left: 80 }。
  • backgroundColor?: string:图表背景颜色,默认为 #FFFFFF。
  • backgroundOpacity?: number:图表背景透明度,默认为 1。

BarChartOptions

BarChartOptions 是一个接口,继承自 ChartOptions,包含以下属性:

  • xField: string:x 轴字段名。
  • yField: string:y 轴字段名。

LineChartOptions

LineChartOptions 是一个接口,继承自 ChartOptions,包含以下属性:

  • xField: string:x 轴字段名。
  • yField: string:y 轴字段名。

PieChartOptions

PieChartOptions 是一个接口,继承自 ChartOptions,包含以下属性:

  • field: string:扇形面积所对应的字段名。
  • categoryField: string:扇形的分类字段名。

AxisOptions

AxisOptions 是一个接口,包含以下属性:

  • visible?: boolean:轴是否可见,默认为 true。
  • label?: LabelOptions:轴标签配置。
  • tick?: TickOptions:轴刻度配置。

LabelOptions

LabelOptions 是一个接口,包含以下属性:

  • visible?: boolean:标签是否可见,默认为 true。
  • position?: string:标签位置,默认为 middle。
  • fontSize?: number:标签字体大小,默认为 12。
  • color?: string:标签颜色,默认为 #000000。

TickOptions

TickOptions 是一个接口,包含以下属性:

  • visible?: boolean:刻度是否可见,默认为 true。
  • size?: number:刻度长度,默认为 6。
  • color?: string:刻度颜色,默认为 #000000。

Datum

Datum 是一个接口,表示图表的一个数据项,包含以下属性:

  • category: string | number:分类字段,可以是字符串或数字。
  • value: number:值字段,必须为数字类型。

示例代码

以下是一个包含柱状图和折线图的完整示例代码:

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

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

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

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

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

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

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

运行该代码,将会在浏览器中显示一个包含柱状图和折线图的页面。

总结

dataent-charts 是一个功能丰富、易用性强的可视化图表库,使用起来非常方便。本文介绍了如何安装和使用 dataent-charts,以及它的 API 和示例代码,希望对你有所帮助。

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

纠错
反馈