antvg2中的Slider 滑块插件的简介

1. 使用前提:

  • Slider 组件作为 G2 的交互插件,必须在 G2 引入的前提下使用!
  • 为了做到纯粹和解耦,Slider 组件是完全基于数据的筛选操作,需要配合 DataSet 以及状态量使用,当滑动条发生变化时,通过定义 onChange 更新状态量,来达到图表的自动更新。
  • 引入脚本
import G2 from '@antv/g2';
import Slider from '@antv/g2-plugin-slider';

const slider = new Slider({
  
});
  • 创建 Slider 的方式如下:
new Slider({
  container: {string} | {HTMLElement},
  width?: {number} | {string},
  height?: {number},
  padding?: {object} | {number} | {array},
  xAxis: {string},
  yAxis: {string},
  start: {string} | {number},
  end: {string} | {number},
  data: {array} | {dataview},
  fillerStyle?: {object},
  backgroundStyle?: {object},
  textStyle?: {object},
  handleStyle?: {object},
  backgroundChart?: {object}
});

2. 属性

container

  • (string | HTMLElement)
  • 对应 slider 的 DOM 容器,可以传入该 DOM 的 id 或者直接传入容器的 html 节点对象。

width

  • (string | number)
  • 设置 slider 组件的宽度,默认为 auto,表示自适应容器的宽度。

height

  • (number)
  • 设置 slider 组件的高度,默认为 26,单位为 ‘px’。

padding

  • 设置 slider 组件所在画布 canvas 的内边距,用于与图表对齐(默认图表的 canvas 容器也是带了内边距),默认值同 G2 默认主题的 padding 相同,[ 20, 20, 95, 80 ]。

xAxis

  • (string)
  • Slider 是带有背景图表的滑动条组件,该字段用于声明该背景图表的横轴映射字段,同时该字段也是数据过滤字段。
  • 必须声明。

yAxis

  • (string)
  • Slider 是带有背景图表的滑动条组件,该字段用于声明该背景图表的纵轴轴映射字段。
  • 必须声明,不然会报错。xAxis和yAxis用于展示滑块上的缩略图。

data

  • (array | dataview)
  • 必须声明,数据源

start

  • (number | string)
  • 声明滑动条起始滑块的位置对应的数据值,默认为最小值。

end

  • (number | string)
  • 声明滑动条结束滑块的位置对应的数据值,默认为最大值。

scales ----- 还未使用过,不太明白具体的使用方法

  • (object)
  • 用于对 xAxis 和 yAxis 字段进行列定义,用于同操作的图表中对应的列定义相同。
  • 示例代码:
scales: {
  [`${xAxis}`]: {
    type: 'time',
    mask: 'MM-DD'
  }
}

onChange

  • (function)
  • 当滑动条滑块发生变化时,触发该回调函数,主要用于更新 ds 的状态量。该回调函数会提供一个参数,该参数是一个对象,包含如下属性:
onChange: (obj) => {
  const { startValue, endValue, startText, endText } = obj;
}
  • startValue 起点滑块当前对应的原始数据值,如果是 time 或者 timeCat 类型是,该值为时间戳,请注意。
  • endValue 终点滑块当前对应的原始数据值,如果是 time 或者 timeCat 类型是,该值为时间戳,请注意。
  • startText 起点滑块当前的显示文本值
  • endText 终点滑块当前的显示文本值
  • 说明:之所以区分 text 和 value,是因为大部分情况下用户会对数值进行格式化,所以在设置状态量和更新状态量时,需要保证前后数值类型的一致。

fillerStyle

  • (object)
  • 选中区域的样式配置,默认配置如下:
{
  fill: '#BDCCED',
  fillOpacity: 0.3
}
  • 图中红框框选区域:
    在这里插入图片描述

backgroundStyle

  • (object)
  • slider 整体背景样式。

textStyle

  • (object)
  • slider 辅助文本字体样式配置。

handleStyle

  • (object)
  • slider 滑块的样式配置,可配置的属性如下:
{
  img: 'https://gw.alipayobjects.com/zos/rmsportal/QXtfhORGlDuRvLXFzpsQ.png', // 可以使图片地址也可以是 data urls
  width: 5,
  height: 26
}

backgroundChart

  • (object)
  • slider 滑块的背景图表配置,可配置其图表类型以及颜色:
{
  type: [ 'area' ], // 图表的类型,可以是字符串也可是是数组
  color: '#CCD6EC'
}

3. 方法

render

  • slider.render() 渲染组件,即将其绘制到页面上。

changeData

  • slider.changeData(data) 更新数据源。

repaint

  • slider.repaint() 重绘。

destroy

  • slider.destroy() 销毁。
展开阅读全文

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: 大白 设计师: CSDN官方博客
应支付0元
点击重新获取
扫码支付

支付成功即可阅读