noticeView

来自于:开发者立即使用

open appendData reloadData close

概述

noticeView实现了类似京东快报,淘宝头条轮播公告样式。

open

打开notiveView轮播公告

open({params}, callback(ret))

params

rect:

  • 类型:JSON 对象
  • 描述:(可选项)模块的位置及尺寸
  • 备注:
  • 内部字段:

    1. {
    2. x: 0, //(可选项)数字类型;公告视图左上角的 x 坐标(相对于所属的 Window 或 Frame);默认:0
    3. y: 0, //(可选项)数字类型;公告视图左上角的 y 坐标(相对于所属的 Window 或 Frame);默认:0
    4. w: 0, //(可选项)数字类型;公告视图的宽度;默认:所属的 Window 或 Frame 的宽度
    5. h: 50 //(可选项)数字类型;公告视图的高度;默认:40
    6. }

    style:

  • 类型:JSON 对象
  • 描述:(可选项)模块的样式
  • 备注:
  • 内部字段:
  1. {
  2. bgColor: '#FFFFFF',//(可选项)字符串类型;模块背景色,支持 rgb,rgba,#;默认:'#FFFFFF'
  3. marginL: 10, //(可选项)数字类型;模块距离屏幕左边的间距;默认:0
  4. marginR: 5, //(可选项)数字类型;模块距离屏幕右边的间距;默认:0
  5. }

icon:

  • 类型:JSON 对象
  • 描述:(可选项)模块左侧图片样式
  • 备注:图片容器高度不能超过模块主视图高度,图片在容器中居中显示
  • 内部字段:
  1. {
  2. image: 'widget://image/jd.png',//字符串,支持fs、widget等本地路径协议
  3. w: 50, //(可选项)数字类型;图片容器的宽度;默认:40
  4. h: 50, //(可选项)数字类型;图片容器的高度;默认:40
  5. }

message:

  • 类型:JSON 对象
  • 描述:(可选项)模块轮播公告内容文字样式
  • 备注:
  • 内部字段:
  1. {
  2. color: '#666666',//(可选项)字符串类型;模块公告内容文字的颜色;默认:#212121
  3. size: 14, //(可选项)数字类型;模块公告内容文字的大小;默认:14
  4. }

line:

  • 类型:JSON 对象
  • 描述:(可选项)模块内分割线样式
  • 备注:分割线高度小于模块主视图高度,分割线会自动垂直居中;
  • 内部字段:
  1. {
  2. color: '#666666',//(可选项)字符串类型;分割线颜色;默认:#666666
  3. w : 1, //(可选项)数字类型;分割线宽度;默认:1.0
  4. h : 20 //(可选项)数字类型;分割线高度;默认:20
  5. }

right:

  • 类型:JSON 对象
  • 描述:(可选项)模块右侧文字按钮样式
  • 备注:高度为自适应模块主视图高度
  • 内部字段:
  1. {
  2. text: '更多',//(可选项)字符串类型;右侧文字按钮文本;默认:'更多'
  3. size : 14, //(可选项)数字类型;按钮文字大小;默认:14
  4. color : '#666666' //(可选项)字符串类型;按钮文字颜色;默认:#666666
  5. w : 50 // (可选项)数字类型;按钮所占宽度;默认:40
  6. }

data:

  • 类型:JSON 对象
  • 描述:(可选项)轮播公告的数据源
  • 备注:传入data必须包含message内容,其他不限制,点击后会回掉被点击项的全部参数。
  • 内部字段:
  1. [{
  2. message : '这是第一条轮播测试内容',
  3. url : 'http://www.baidu.com'
  4. }, {
  5. message : '这是第二条轮播测试内容',
  6. id:'测试id'
  7. }, {
  8. message : '这是第三条轮播测试内容',
  9. image : 'http://baidu.com/ceshi.png'
  10. }, {
  11. message : '这是第四条轮播测试内容'
  12. }, {
  13. message : '这是第五条轮播测试内容'
  14. }]//数组类型

Interval

  • 类型:数字类型
  • 描述:(可选项)模块公告的轮播频率;单位:s
  • 默认值 :3.0

fixed

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

fixedOn

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

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
  1. {
  2. onclick: 'message' //字符串类型,交互事件类型
  3. //取值范围如下:
  4. //message(公告消息的点击事件)
  5. //right (右侧文字按钮的点击事件)
  6. data: //JSON对象;点击公告消息时,返回对应的JSON格式数据内容;仅当onclick为message时回掉
  7. }

示例代码

  1. var noticeView = api.require('noticeView');
  2. noticeView.open({
  3. rect : {
  4. x : 0,
  5. y : 100,
  6. h : 50
  7. },
  8. style : {
  9. bgColor : '#ffffff',
  10. marginL : 10,
  11. marginR : 5
  12. },
  13. icon : {
  14. image : 'widget://image/jd.png',
  15. w : 50,
  16. h : 50
  17. },
  18. message : {
  19. color : '#212121',
  20. size : 14
  21. },
  22. line : {
  23. color : '#666',
  24. h : 20,
  25. w : 1
  26. },
  27. right : {
  28. text : '更多',
  29. size : 14,
  30. color : '#666666',
  31. w : 50
  32. },
  33. data : [{
  34. message : '这是第一条轮播测试内容',
  35. url : 'http://www.baidu.com'
  36. }, {
  37. message : '这是第二条轮播测试内容',
  38. id:'测试id'
  39. }, {
  40. message : '这是第三条轮播测试内容',
  41. image : 'http://baidu.com/ceshi.png'
  42. }, {
  43. message : '这是第四条轮播测试内容'
  44. }, {
  45. message : '这是第五条轮播测试内容'
  46. }],
  47. Interval : 3,
  48. fixedOn : api.frameName
  49. }, function(ret, err) {
  50. alert(JSON.stringify(ret));
  51. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

appendData

向列表末端追加数据

appendData({params})

params

data:

  • 类型:JSON 对象
  • 描述:(可选项)公告的数据源
  • 备注:
  • 内部字段:
  1. {
  2. [ {message:'这是一个测试公告的追加内容'},{message : '这是第二个测试公告的追加内容'}]//数组类型
  3. }

示例代码

  1. var noticeView = api.require('noticeView');
  2. noticeView.appendData({
  3. data : [{
  4. message : '这是第一个测试公告的追加内容',
  5. url : '这是一个测试返回的内容'
  6. }, {
  7. message : '这是第二个测试公告的追加内容'
  8. }, {
  9. message : '这是第三个测试公告的追加内容'
  10. }, {
  11. message : '这是第四个测试公告的追加内容'
  12. }, {
  13. message : '这是第五个测试公告的追加内容'
  14. }]
  15. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

reloadData

刷新列表数据

reloadData({params})

params

data:

  • 类型:JSON 对象
  • 描述:(可选项)公告的数据源
  • 备注:
  • 内部字段:
  1. {
  2. [ {message:'这是一个测试公告内容'}]//数组类型
  3. }

示例代码

  1. var noticeView = api.require('noticeView');
  2. noticeView.reloadData({
  3. data : [{
  4. message : '刷新1',
  5. url : 'http://sdfds/com'
  6. }, {
  7. message : '刷新2'
  8. }, {
  9. message : '刷新3'
  10. }, {
  11. message : '刷新4'
  12. }, {
  13. message : '刷新5'
  14. }]
  15. });

close

关闭轮播公告模块

close()

示例代码

  1. var noticeView = api.require('noticeView');
  2. noticeView.close();