UIBarChart

来自于:官方立即使用

open reloadData close hide show scrollTo

论坛示例

为帮助用户更好更快的使用模块,论坛维护了一个示例,示例中包含示例代码、知识点讲解、注意事项等,供您参考。

概述

UIBarChart 是一个柱状图模块,可自定义 X、Y 轴样式以及柱子的个数和颜色。本模块可监听左右拖动到头的事件,可向当前数据拼接加载、刷新等操作。同一个页面可以打开多个模块实例,以模块 id 区分。本模块是 barChart 的优化版

图片说明

open

打开柱状图视图

open({params}, callback(ret, err))

params

rect:

  • 类型:JSON 对象
  • 描述:(可选项)模块的位置及尺寸
  • 内部字段:
  1. {
  2. x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认:0
  3. y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认:0
  4. w: 320, //(可选项)数字类型;模块的宽度;默认:所属的 Window 或 Frame 的宽度
  5. h: 200 //(可选项)数字类型;模块的高度;默认:w * 2.0/3.0
  6. }

yAxis:

  • 类型:JSON 对象
  • 描述:柱状图的y轴信息
  • 内部字段:
  1. {
  2. max: 50, //数字类型;y轴最大值
  3. min: 0, //数字类型;y轴最小值
  4. step: 20, //数字类型;y轴刻度间隔
  5. }

data:

  • 类型:数组
  • 描述:柱状图关键结点的数据
  • 内部字段:
  1. [{
  2. xAxis: '一月', //字符串类型;关键结点的x轴数据
  3. yAxis: 80, //数字类型;关键结点的y轴数据
  4. id: 1, //开发者可自定义扩展参数 ,可在回调函数内获取(selectedInfo)
  5. title: '', //开发者可自定义扩展参数 ,可在回调函数内获取(selectedInfo)
  6. ...
  7. },{
  8. xAxis: '二月', //字符串类型;关键结点的x轴数据
  9. yAxis: 56, //数字类型;关键结点的y轴数据
  10. id: 2, //开发者可自定义扩展参数 ,可在回调函数内获取(selectedInfo)
  11. title: '', //开发者可自定义扩展参数 ,可在回调函数内获取(selectedInfo)
  12. ...
  13. }]

text:

  • 类型:JSON 对象
  • 描述:(可选项)X、Y轴说明文字配置
  • 内部字段:
  1. {
  2. xAxis: 'X轴', //(可选项)字符串类型;x 轴标注文字;默认:X轴
  3. yAxis: 'Y轴' //(可选项)字符串类型;y 轴标注文字;默认:Y轴
  4. }

styles:

  • 类型:
  • 描述:(可选项)模块视图内元素样式设置
  • 默认值:见内部字段
  • 内部字段:
  1. {
  2. yAxis: { //(可选项)JSON 对象;Y轴样式
  3. width:30, //(可选项)数字类型;Y轴宽度,默认:20
  4. bg: '#B2DFEE', //(可选项)字符串类型;Y轴背景,支持 rgb、rgba、#、img,默认:'#B2DFEE'
  5. markColor: '#fff',//(可选项)字符串类型;Y轴标注字体颜色,支持 rgb、rgba、#,默认:'#fff'
  6. markSize: 12 //(可选项)数字类型;Y轴标注字体大小,默认:12
  7. },
  8. xAxis: { //(可选项)JSON 对象;X轴样式
  9. height:30, //(可选项)数字类型;X轴高度,默认:20
  10. bg: '#B2DFEE', //(可选项)字符串类型;X轴背景,支持 rgb、rgba、#、img,默认:'#B2DFEE'
  11. markColor: '#fff',//(可选项)字符串类型;X轴标注字体颜色,支持 rgb、rgba、#,默认:'#fff'
  12. markSize: 12 //(可选项)数字类型;X轴标注字体大小,默认:12
  13. },
  14. coordinate: { //(可选项)JSON 对象;坐标系样式
  15. bg: '#FCFCFC', //(可选项)字符串类型;坐标系背景,支持 rgb、rgba、#、img,默认:'#FCFCFC'
  16. },
  17. bar: { //(可选项)JSON 对象;柱子样式
  18. width:30, //(可选项)数字类型;柱子的宽度,默认:20
  19. bg: '#696969', //(可选项)字符串类型;柱子的背景色,支持 rgb、rgba、#、img,默认:'#696969'
  20. tint: '#8DB6CD', //(可选项)字符串类型;柱子的数据展示色,支持 rgb、rgba、#,默认:'#8DB6CD'
  21. interval: 16 //(可选项)数字类型;柱子间隔大小,默认:16
  22. }
  23. }

showData:

  • 类型:布尔
  • 描述:(可选项)点击柱状图,是否显示该条目数据
  • 默认值:false

fixedOn:

  • 类型:字符串类型
  • 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认:模块依附于当前 window

fixed:

  • 类型:布尔
  • 描述:(可选项)模块是否随所属 window 或 frame 滚动
  • 默认值:true(不随之滚动)

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. id: 1, //数字类型;模块的 id,用于区分模块的多个实例
  3. eventType: 'show', //字符串类型;交互事件类型
  4. //取值范围:
  5. //show(打开模块成功)
  6. //click(点击柱状图的柱子的点击事件)
  7. //reachLeftmost(拖动柱图至左边缘)
  8. //reachRightmost(拖动柱图至右边缘)
  9. index: //数字类型;点击柱状图柱子的索引,当 eventType 为 click 时有效
  10. value: //数字类型;所点击柱子的值,当 eventType 为 click 时有效
  11. selectedInfo: { //JSON 对象,返回所选柱子的数据详情,当 eventType 为 click 时有效
  12. xAxis: '二月',
  13. yAxis: 56,
  14. id: 1,
  15. title: '',
  16. ...
  17. }
  18. }

示例代码

  1. var UIBarChart = api.require('UIBarChart');
  2. UIBarChart.open({
  3. rect: {
  4. x: 30,
  5. y: api.frameHeight / 2 - 170,
  6. w: api.frameWidth - 60,
  7. h: 340
  8. },
  9. yAxis: {
  10. max: 50,
  11. min: 0,
  12. step: 10
  13. },
  14. data: [{
  15. xAxis: '一月',
  16. yAxis: 80
  17. }, {
  18. xAxis: '二月',
  19. yAxis: 0
  20. }, {
  21. xAxis: '三月',
  22. yAxis: 16
  23. }, {
  24. xAxis: '四月',
  25. yAxis: 36
  26. }, {
  27. xAxis: '五月',
  28. yAxis: 26
  29. }, {
  30. xAxis: '六月',
  31. yAxis: 46
  32. }, {
  33. xAxis: '七月',
  34. yAxis: 66
  35. }, {
  36. xAxis: '八月',
  37. yAxis: 11
  38. }, {
  39. xAxis: '九月',
  40. yAxis: 8
  41. }, {
  42. xAxis: '十月',
  43. yAxis: 56
  44. }, {
  45. xAxis: '十一月',
  46. yAxis: 61
  47. }, {
  48. xAxis: '十二月',
  49. yAxis: 35
  50. }],
  51. styles: {
  52. yAxis: {
  53. width: 30,
  54. bg: '#B2DFEE',
  55. markColor: '#fff',
  56. markSize: 12
  57. },
  58. xAxis: {
  59. height: 30,
  60. bg: '#B2DFEE',
  61. markColor: '#fff',
  62. markSize: 12
  63. },
  64. coordinate: {
  65. bg: '#FCFCFC',
  66. },
  67. bar: {
  68. width: 30,
  69. bg: '#696969',
  70. tint: '#8DB6CD',
  71. interval: 16
  72. }
  73. },
  74. fixedOn: api.frameName,
  75. fixed: false
  76. }, function(ret, err) {
  77. if (ret) {
  78. alert(JSON.stringify(ret));
  79. } else {
  80. alert(JSON.stringify(err));
  81. }
  82. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

reloadData

重新加载数据

reloadData({params}, callback(ret, err))

params

id:

  • 类型:数字
  • 描述:模块的 id,用于区分模块的多个实例

type:

  • 类型:字符串
  • 描述:更新数据的方式
  • 默认值:’updateAll’
  • 取值范围:
    • prepend(往数据源头部追加数据)
    • append(往数据源尾部追加数据)
    • updateAll(更新所有数据)

data:

  • 类型:数组
  • 描述:要更新的数据
  • 内部字段:
  1. [{
  2. xAxis: '一月', //字符串类型;关键结点的x轴数据
  3. yAxis: 80 //数字类型;关键结点的y轴数据
  4. },{
  5. xAxis: '二月', //字符串类型;关键结点的x轴数据
  6. yAxis: 56 //数字类型;关键结点的y轴数据,
  7. }]

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:

    1. {
    2. status: true, //布尔类型;数据源是否刷新成功, true|false
    3. count: 20 //数字类型;刷新数据后总数据量数
    4. }

示例代码

  1. var UIBarChart = api.require('UIBarChart');
  2. UIBarChart.reloadData({
  3. id: 1,
  4. type: 'prepend',
  5. data: [{
  6. xAxis: '五月',
  7. yAxis: 45
  8. }, {
  9. xAxis: '六月',
  10. yAxis: 70
  11. }, {
  12. xAxis: '七月',
  13. yAxis: 20
  14. }, {
  15. xAxis: '八月',
  16. yAxis: 85
  17. }]
  18. }, function(ret, err) {
  19. if (ret) {
  20. alert(JSON.stringify(ret));
  21. } else {
  22. alert(JSON.stringify(err));
  23. }
  24. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

close

关闭柱状图

close({params})

params

id:

  • 类型:数字
  • 描述:模块的 id,用于区分模块的多个实例

示例代码

  1. var UIBarChart = api.require('UIBarChart');
  2. UIBarChart.close({
  3. id: 1
  4. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

hide

隐藏柱状图视图

hide({params})

params

id:

  • 类型:数字
  • 描述:模块的 id,用于区分模块的多个实例

示例代码

  1. var UIBarChart = api.require('UIBarChart');
  2. UIBarChart.hide({
  3. id: 1
  4. });

补充说明

隐藏已显示的柱状图视图,并没有从内存里清除

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

show

显示已隐藏的柱状图视图

show({params})

params

id:

  • 类型:数字
  • 描述:模块的 id,用于区分模块的多个实例

示例代码

  1. var UIBarChart = api.require('UIBarChart');
  2. UIBarChart.show({
  3. id: 1
  4. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

scrollTo

滚动到指定索引的条目,

以模块左边 Y 轴为基准线,

index 设置为 1,则从第二条数据开始显示,以此类推,

index值不可大于条目总数减去每屏显示个数

scrollTo({params})

params

id:

  • 类型:数字
  • 描述:模块的 id,用于区分模块的多个实例

index:

  • 类型:数字
  • 描述:(可选项)指定的条目的索引,不可大于总条目数减去每屏显示个数,从0开始
  • 默认:0

animation:

  • 类型:布尔
  • 描述:(可选项)滚动时是否带有动画效果
  • 默认:false

示例代码

  1. var UIBarChart = api.require('UIBarChart');
  2. UIBarChart.scrollTo({
  3. id: 1,
  4. index: 3,
  5. animation: true
  6. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

论坛示例

为帮助用户更好更快的使用模块,论坛维护了一个示例,示例中包含示例代码、知识点讲解、注意事项等,供您参考。