API知识点Word文档下载推荐.docx

API知识点Word文档下载推荐.docx

《API知识点Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《API知识点Word文档下载推荐.docx（26页珍藏版）》请在冰豆网上搜索。

scaleEnabled：

（可选项）页面是否可以缩放

slidBackEnabled：

（可选项）是否支持滑动返回。

及以上系统中，在新打开的页面中向右滑动，可以返回到上一个页面，该字段只iOS有效

slidBackType：

full

（可选项）当支持滑动返回时，设置手指在页面右滑的有效作用区域。

取值范围（full:

整个页面范围都可以右滑返回，edge:

在页面左边缘右滑才可以返回），该字段只iOS有效

animation：

（可选项）动画参数，不传时使用默认动画，type：

动画类型，subType：

动画子类型。

内部字段：

{

type:

"

none"

'

pageParam:

{

name:

'

test'

}

}）;

补充说明

窗口操作

可用性

iOS系统，Android系统

可提供的及更高版本

closeWin

关闭window

closeWin（{params}）

（可选项）window名字，不传时关闭当前window，为root时无效

rect:

x:

0,

y:

w:

320,

h:

480

},

bounces:

true,

bgColor:

rgba（0,0,0,0）'

vScrollBarEnabled:

hScrollBarEnabled:

true

closeFrame

关闭frame

closeFrame（{params}）

（可选项）frame名字，不传时关闭当前frame

示例代码

（{

page2'

setFrameAttr

设置frame属性

setFrameAttr（{params}）

frame名称

hidden：

（可选项）本frame是否隐藏（隐藏即从屏幕上移除，但不销毁）

（可选项）背景色，支持图片和颜色，格式为#fff、#ffffff、rgba（r,g,b,a）等，图片路径支持APICloud自定义文件路径协议，同时支持相对路径

只iOS有效

rect：

（可选项）窗口区域

0,'

iOS系统

closePopoverWin

关闭整个弹出层窗口，只iPad上面有效

在当前弹出层里面的任意页面里面调用都会关闭整个弹出层

closePopoverWin（）

（）;

openSlidLayout

打开侧滑式布局

打开后，其所在window的name默认为slidLayout，所以关闭整个侧滑布局可以通过（{name:

'

slidLayout'

}）实现，同时可以通过（{name:

}）来把整个侧滑显示到最前面

openSlidLayout（{params},callback（ret,err））

type：

all

（可选项）侧滑类型（left：

左侧滑、right：

右侧滑、all：

左右侧滑）。

安卓暂只支持left。

leftEdge：

数字

60

（可选项）左侧滑时，侧滑window停留时露出的宽度。

即将废弃，用slidPaneStyle中leftEdge参数代替

rightEdge：

（可选项）右侧滑时，侧滑window停留时露出的宽度。

即将废弃，用slidPaneStyle中rightEdge参数代替

slidPaneStyle：

侧滑层window样式

leftEdge:

animation:

none'

leftPane:

leftPane'

url:

openDrawerPane

打开抽屉式侧滑Pane

openDrawerPane（{params}）

侧滑类型，left或right

left'

closeDrawerPane

关闭抽屉式侧滑Pane

closeDrawerPane（）

execScript

在指定window或者frame中执行脚本，对于frameGroup里面的frame也有效，若name和frameName都未指定，则在当前window中执行脚本，具体执行逻辑见补充说明。

execScript（{params}）

（可选项）window名称，若要跨window执行脚本，该字段必须指定，首页的名称为root

frameName：

（可选项）frame名称

script：

js代码

files：

{}.

（可选项）内容

modal：

（可选项）是否模态，模态时整个页面将不可交互

style:

default'

animationType:

fade'

title:

努力加载中...'

text:

先喝杯茶...'

modal:

false}）;

显示进度提示框

hideProgress

隐藏进度提示框

hideProgress（）

toast

弹出一个定时自动关闭的提示框

toast（{params}）

msg：

提示消息

duration：

2000

（可选项）持续时长，单位：

毫秒

location：

bottom

（可选项）弹出位置，顶部、中间或底部（详见toast位置常量）

global：

（可选项）是否是全局的toast。

若为false，toast将只在当前window范围可见；

若为true，安卓手机上面弹出的位置将会固定在底部区域。

msg:

网络错误'

duration:

2000,

location:

bottom'

openPicker

打开时间选择器

openPicker（{params},callback（ret,err））

拾取器类型（详见拾取器类型常量）

date：

当前时间

（可选项）时间格式化字符串，格式yyyy-MM-ddHH:

mm

title：

（可选项）显示在拾取器上面的标题

callback（ret,err）

ret：

year:

2000,.

（可选项）下拉文字描述

textUp：

松开可以刷新...

（可选项）松开时文字描述

textLoading：

加载中...

（可选项）加载状态文字描述

textTime：

最后更新加日期时间

（可选项）更新时间文字描述

showTime：

（可选项）是否显示更新时间

处于下拉刷新状态的回调

err：

错误信息

visible:

loadingImg:

#ccc'

textColor:

#fff'

textDown:

下拉刷新...'

textUp:

松开刷新...'

showTime:

},function（ret,err）{

//在这里从服务器加载数据，加载完成后调用（）方法恢复组件到默认状态

下拉刷新

setCustomRefreshHeaderInfo

显示顶部自定义下拉刷新组件，页面必须设置为弹动。

可以在里面配置要使用的自定义下拉刷新模块名称，如：

<

preferencename="

customRefreshHeader"

value="

UIPullRefresh"

/>

或者在使用openWin、openFrame等方法打开页面时传入customRefreshHeader参数来指定。

setCustomRefreshHeaderInfo（{params},callback（ret,err））

由对应的自定义下拉刷新模块提供

#C0C0C0'

images:

pull:

transform:

[

],

load:

]

refreshHeaderLoading

设置下拉刷新组件为刷新中状态

refreshHeaderLoading（）

refreshHeaderLoadDone

通知顶部下拉刷新数据加载完毕，组件会恢复到默认状态

refreshHeaderLoadDone（）

通知顶部刷新数据加载完毕

showFloatBox

展示一个悬浮框，浮动在屏幕上，点击时关闭当前widget

showFloatBox（{params}）

iconPath：

应用图标

（可选项）展示在悬浮框中的图片地址

5000毫秒

（可选项）自动消隐时长。

在该时长内不发生触摸悬浮框行为，悬浮框自动消隐至半透状态

iconPath:

3000}）;

对主widget无效

getPicture

通过系统相册或拍照获取图片和视频

getPicture（{params},callback（ret,err））

sourceType：

library

（可选项）图片源类型，从相册、图片库或相机获取图片（详见图片源类型常量）

encodingType：

png

（可选项）返回图片类型，jpg或png（详见图片编码类型常量）

mediaValue：

pic

（可选项）媒体类型，图片或视频（详见媒体类型常量）

destinationType：

url

（可选项）返回数据类型，指定返回图片地址或图片经过base64编码后的字符串（详见图片数据格式常量）

direction：

rear

（可选项）选择前置或后置摄像头，取值范围（front、rear），只支持iOS

allowEdit：

（可选项）是否可以选择图片后进行编辑，支持iOS及部分安卓手机

quality：

50

（可选项）图片质量，只针对jpg格式图片（0-100整数）

videoQuality：

medium

（可选项）视频质量，取值范围（low、medium、high），只支持iOS

targetWidth：

原图宽度

（可选项）压缩后的图片宽度，图片会按比例适配此宽度

targetHeight：

原图高度

（可选项）压缩后的图片高度，图片会按比例适配此高度

saveToPhotoAlbum：

（可选项）拍照或录制视频后是否保存到相册

data:

//图片路径

base64Data:

//base64数据，destinationType为base64时返回

0//视频时长（数字类型）

}

//错误描述}

sourceType:

camera'

encodingType:

jpg'

mediaValue:

pic'

destinationType:

url'

allowEdit:

quality:

50,

targetWidth:

100,

targetHeight:

saveToPhotoAlbum:

false

if（ret）{

alert（ret））;

}else{

alert（err））;

获取图片

saveMediaToAlbum

保存图片和视频到系统相册

saveMediaToAlbum（{params},callback（ret,err））

path：

本地文件路径，支持，必须带有扩展名

status:

true//是否保存成功}

path:

function（ret,err）{

if（ret&

&

alert（'

保存成功'

）;

保存失败'

startRecord

录制amr格式音频

startRecord（{params}）

（可选项）文件路径，不传时自动创建路径

;

录音格式为amr

stopRecord

停止录音

stopRecord（callback（ret,err））

//字符串，返回的音频地址

0//数字类型，音频的时长

（function（ret,err）{

varpath=;

varduration=;

startPlay

开始播放音频

startPlay（{params},callback（ret,err））

描述：

文件路径，支持,err）

ret

播放完成的回调

err

播放完成'

播放音频

stopPlay

停止播放音频

stopPlay（）

openVideo

打开系统视频播放器

openVideo（{pa