Skip to content

spritejs/q-charts

Repository files navigation

QCharts

特点

QCharts 是一个基于 spritejs 封装的图表库,它以数据驱动,将图表以最小组件进行拆分,具有高度全面灵活的属性配置方法,可对图表绘制过程中所有的点、线、面的大小、位置、填充颜色、描边颜色、描边线型、透明度等属性进行配置,配置方法简单易懂,语义清晰,无论如何复杂的图表,qcharts都能轻松胜任。 →详细文档,Demo:Quickstart

安装

1.通过 npm 获取 QCharts,我们提供了 QCharts npm 包,通过下面的命令即可完成安装

npm install @qcharts/core --save
// 通过模块引入的方式使用CatCharts
import { Chart, Pie, Tooltip, Legend } from '@qcharts/core'

2.既可以下载脚本到本地,也可以通过 cdn 获取 QCharts;QCharts依赖于spritejs,需要先引入spritejs。

<script src="https://unpkg.com/spritejs/dist/spritejs.min.js"></script>
<script src="https://unpkg.com/@qcharts/core/lib/index.js"></script>

开始使用

1.创建div图表容器,qcharts初始化container属性支持id选择器与class选择器

<div id='app'></div>

2.编写绘图代码

// 指定图表数据源
chart.source(data, {
  row: 'catgory',  // 以catgory字段分组
  value: 'sales', // 以sales字段取值
  text: 'date'   //  date为文本字段
})

// 创建折线对象
const line = new Line()
// 设置折线点的描边颜色为白色
line.style('point', { strokeColor: '#fff' })
// 创建提示框对象,格式化展示属性为:date scale
const tooltip = new Tooltip({
  formatter: function(data) {
    return `${data.date} ${data.sales}`
  }
})
// 创建底部坐标轴对象
const axisBottom = new Axis()
// 创建左侧坐标轴对象。隐藏轴体直线和刻度
const axisLeft = new Axis({ orient: 'left' }).style('axis', false).style('scale', false)
// 创建图例对象,设置位置以及图标和文本大小
const legend = new Legend({ align: ['center', 'bottom'] })
  .style('icon', { borderRadius: 10 })
  .style('text', { fontSize: 12 })
// 装载组件
chart.add([line, tooltip, axisBottom, axisLeft, legend])
// 渲染图表
chart.render()

一张折线图就绘制成功

在 React/Vue 中使用qchart

基于qchart良好的组合性和扩展性,qchart天然支持对React和 Vue 这两个常用框架的深度整合,在React环境下,我们推荐使用cat-charts-react ,在Vue环境下,我们推荐使用 cat-charts-vue。这两个产品都是基于qchart的封装,与qchart有着一致的开发体验,可以前往官网获取详细的使用说明和示例。当然,你可以自己动手封装成其他框架下的组件,在qchart下,这些封装成本非常低。

在微信小程序中使用qchart

qchart从v0.1.11开始支持微信小程序,使用方法如下:

通过NPM安装@spritejs/wxapp和@qcharts/core

npm install @spritejs/wxapp @qcharts/core --save

然后在微信小程序中构建 NPM 包

安装并构建之后,在app.json中配置chart组件:

  "usingComponents": {
    "q-chart": "@qcharts/core/chart"
  }

首先在页面index.wxss文件中编写设置图表大小的css样式:

.line-chart{
  height: 400px;
  width: 80%;
  margin: 0 auto;
}

然后在要使用的页面index.wxml文件中引入组件:

<view>
  <q-chart bindChartCreated="onChartCreated" chartId="my-chart" chart-class="line-chart">   </q-chart>
</view>

chartId为图表canvas的canvas-id值,默认值为“q-chart”,在当前page中必须唯一。chart-class可设置chart组件中canvas父容器的class属性,chart的与其父容器的大小保持一致。

bindChartCreated事件处理中通过参数可以获得创建好的chart对象:

const qcharts = require('@qcharts/core');

Page({
  onChartCreated({ detail: { chart } }) {
    const data = [
      { date: '05-01', catgory: '图例一', sales: 15.2 },
      { date: '05-02', catgory: '图例一', sales: 39.2 },
      { date: '05-03', catgory: '图例一', sales: 31.2 },
      { date: '05-04', catgory: '图例一', sales: 65.2 },
      { date: '05-05', catgory: '图例一', sales: 55.2 },
      { date: '05-06', catgory: '图例一', sales: 75.2 },
      { date: '05-07', catgory: '图例一', sales: 95.2 },
      { date: '05-08', catgory: '图例一', sales: 65.2 },
    ]

    const { Line, Legend, Tooltip, Axis } = qcharts

    chart.source(data, {
      row: 'catgory',
      value: 'sales',
      text: 'date'
    })

    const line = new Line()
    line.style('point', { strokeColor: '#fff' })

    const tooltip = new Tooltip({
      formatter: function(data) {
        return `${data.date} ${data.sales}`
      }
    })

    const axisBottom = new Axis()

    const axisLeft = new Axis({ orient: 'left' })
      .style('axis', false).style('scale', false)

    const legend = new Legend({ align: ['center', 'bottom'] })
      .style('icon', { borderRadius: 10 }).style('text', { fontSize: 12 })

    chart.add([line, tooltip, axisBottom, axisLeft, legend])
    chart.render()
  },
});

更多小程序图表示例可以前往我们的官方小程序示例代码仓库进行查看

About

A visulization library based on spritejs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published