floatView

来自于:APICloud 官方立即使用

模块概述

使用此模块可添加悬浮按钮,可设置悬浮按钮背景图片、背景颜色、文字、以及是否可以拖动。悬浮按钮会悬浮在所有应用顶层,但添加悬浮按钮之前需要先获取在所有应用顶部显示权限。

模块接口

checkFloadPermission

检测悬浮框权限,使用悬浮框需要先获取权限

checkFloadPermission({params}, callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:true,                //布尔类型;true/状态良好,false/参考err查看错误信息
    permission:,              //布尔类型;是否已获取悬浮框权限
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
msg:'',                        //字符串类型;错误信息
}

示例代码

var floatView = api.require('floatView');
floatView.checkFloadPermission({
}, function(ret, err) {
   alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

addFloadWindow

添加悬浮框

addFloadWindow({params}, callback(ret))

parameter

rect:

  • 类型:JSON对象
  • 描述:(可选项)显示控件位置
  • 内部字段:
{
   x:,       //数字类型;控件左上角x坐标;默认值:0
   y:,      //数字类型;控件左上角y坐标;默认值:0
   w:,     //数字类型;控件宽;默认值:50
   h:,     //数字类型;控件高;默认值:50
}

text:

  • 类型:JSON对象
  • 描述:(可选项)悬浮框内文字设置
  • 内部字段:
{
  content:'',      //字符串类型;文字内容
  size:,               //数字类型;文字大小;默认:14
  color:'',          //字符串类型;文字颜色;默认:‘#000000’
}

background:

  • 类型:JSON对象
  • 描述:(可选项)背景颜色;默认白色
  • 内部字段:
{
  color:'',      //字符串类型;背景颜色,支持rgb,rgba
  image:'',    //字符串类型;背景图片路径,支持widget,fs;此参数有效时color无效
}

move:

  • 类型:布尔类型
  • 描述:(可选项)是否可拖动;
  • 默认值:true

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:true,                //布尔类型;true/状态良好,false/参考err查看错误信息
    action:'',                  //字符串类型;事件;取值范围:‘open’/打开,‘click’/点击,‘move’/移动
    location:{               //JSON对象;左上角当前位置,仅action为move时返回
    x:,                            //数字类型;x坐标
    y:,                           //数字类型;y坐标
    }
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
msg:'',                        //字符串类型;错误信息
}

示例代码

var floatView = api.require('floatView');
floatView.addFloadWindow({
}, function(ret, err) {
   alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

removeFloadWindow

移除悬浮框

removeFloadWindow({params}, callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:true,                //布尔类型;true/状态良好,false/参考err查看错误信息
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
msg:'',                        //字符串类型;错误信息
}

示例代码

var floatView = api.require('floatView');
floatView.removeFloadWindow({
}, function(ret, err) {
   alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本