npm 包 wepy-com-charts 使用教程

阅读时长 15 分钟读完

前言

wepy-com-charts 是一款基于 echarts 封装的 wepy 框架组件库,旨在为开发者提供一种轻松的方式在 wepy 项目中使用现代化的图表库。本教程将详细讲解如何使用 wepy-com-charts,包括安装、使用和示例。

安装

基本用法

首先,在 wpy 文件中引入 wepy-com-charts 组件:

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

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

上面的示例中,我们初始化一个 wepy-com-charts 组件并传递了一个 options 属性。该属性是一个 echarts 配置项对象,我们将在下面的示例中详细讲解。

echarts 配置项

如前所述,options 属性是一个 echarts 配置项对象,通过该对象可以定制图表的样式、数据等属性。下面是一个简单的示例:

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

上面的示例中,我们在 options 属性中定义了一些 echarts 配置项:

  • title: 标题,用来描述图表的名称和作者等信息。
  • tooltip: 提示框,用来显示鼠标悬浮在图表上时的详细信息。
  • legend: 图例,用来表示不同数据系列的颜色。
  • series: 数据系列,用来描述图表的具体数据内容。

需要注意的是,echarts 配置项大部分都是对象或数组类型,其中包含了一些属性和方法,而这些属性和方法的用法和意义都需要参照 echarts 文档进行了解和了解。在使用 wepy-com-charts 组件的过程中,我们主要需要关注的是如何定制这些 echarts 配置项,以及如何通过 wepy-com-charts 的接口与这些配置项进行交互。

接口说明

wepy-com-charts 提供了以下接口:

  • <wepy-com-charts> 组件:
    • 属性:
      • options: echarts 配置项,必需属性。
      • onInit: 组件初始化回调函数,参数 chart 为 echarts 实例。
    • 方法:
      • setOption: 设置 echarts 配置项。
  • this.$wepyComCharts: wepy-com-charts 全局接口对象:
    • 属性:
      • version: 当前 wepy-com-charts 版本号。
    • 方法:
      • render: 绘制图表,参数 selector 为选择器字符串或 DOM 节点。
      • dispose: 销毁图表,参数 selector 同上。
      • getInstance: 获取 echarts 实例,参数 selector 同上。

示例

接下来,我们将使用一些示例来帮助大家更好地了解和学习 wepy-com-charts 组件库。

折线图

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

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

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

上面的示例中,我们定义了一个折线图,通过 type: 'line' 来指定折线图的类型。我们通过定义 xAxisyAxis 来设置坐标轴的属性,而设置图例和数据则需要在 legendseries 中进行完成。

在组件初始化函数 onChartInit(chart) 中,我们调用了全局接口对象 $wepyComChartsgetInstance 方法来获取 echarts 实例,并通过实例的 resize 方法来实现 echarts 图表的自适应。

柱状图

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

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

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

上面的示例中,我们定义了一个柱状图,通过 type: 'bar' 来指定柱状图的类型。我们也可以将不同系列的图表数据叠放在同一个柱状图中,由于我们将 name 属性分别设置为‘直接访问’、‘邮件营销’、‘联盟广告’和‘视频广告’,所以在图例中我们可以看到这四个数据系列。在数据处理上,xAxis 中的 type: 'value' 表示横轴的数据类型为数值型,yAxis 中通过 data 属性设置了纵轴的刻度列表, boundaryGap: [0, 0.01] 表示横轴数据的空隙尺寸。在 series 中,stack 属性表示将该数据系列和指定的数据系列叠加在同一个条形图上,我们在上面的示例中将‘邮件营销’、‘联盟广告’和‘视频广告’指定了同一个堆叠区域。

饼图

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

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

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

上面的示例中,我们定义了一个饼图,通过 type: 'pie' 来指定饼图的类型。关于饼图的数据结构,我们在 series 中添加了一个 data 数组,其中每个元素表示一个扇形区域,如 {value: 335, name: '直接访问'},表示一个扇形区域所占的比例为数据项 value 的值,扇形区域名称为数据项 name 的值。在 legend 中,我们采用竖直方向的布局,通过 data 属性设置饼图图例的标记名称和图例文本。在配置饼图属性时,我们可以使用 radiuscenter 分别设置饼图的半径和中心位置。通过 itemStyle 属性,我们可以定义鼠标悬浮在饼图部分的样式。

结语

wepy-com-charts 是一款非常易用的 wepy 框架图表组件库,它可以使开发者通过简单的配置很容易地实现各种类型的图表。在本教程中,我们详细介绍了 wepy-com-charts 的安装、使用和示例,并详细介绍了 echarts 配置项和 wepy-com-charts 的接口说明。我们希望这篇教程对大家有所帮助,也欢迎大家在使用组件库时多多探索和实践,进一步完善和提高自己。

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

纠错
反馈