nativeObj管理系统原生对象。
对象:
回调方法:
权限:
5+功能模块(permissions)
AnimationOptions
原生动画参数
说明:
指定动画的类型、持续时间等信息。
属性:
示例:
uni-app使用plus注意事项
AnimationViewStyles
原生动画窗口样式
说明:
指定动画窗口的样式,如背景图片,绘制的文字等。
属性:
- bitmap: (Bitmap 类型 )动画窗口上绘制的背景图片
图片可以通过Webview对象的draw方法截图,也可以通过Bitmap的API从本地文件中加载。
- text: (String 类型 )动画窗口上绘制的文本内容
- textStyles: (TextStyles 类型 )动画窗口上绘制的文本样式
- textRect: (Rect 类型 )动画窗口上绘制的文本区域
默认值为{top:'0px',left:'0px',width:'100%',height:'44px'}。
示例:
uni-app使用plus注意事项
Bitmap
原生图片对象
说明:
原生图片对象会占用较大的内存资源,在使用时需谨慎管理,当图片不再使用时应该及时调用clear方法进行销毁。
构造:
属性:
方法:
Bitmap(id, path)
创建Bitmap对象
说明:
创建后为空Bitmap对象,需要调用Webview对象的draw方法更新,或者调用load/loadBase64Data方法加载图片。
参数:
- id: ( String ) 可选 Bitmap图片对象的id
给图片对象指定id后,可以通过plus.nativeObj.Bitmap.getBitmapById()获取。 如果不设置id则创建匿名图片对象,仅可通过plus.nativeObj.Bitmap.getItems()获取。 可创建多个相同id的图片,此时plus.nativeObj.Bitmap.getBitmapById()获取第一个创建的id图片对象。
- path: ( String ) 可选 Bitmap对象自动加载图片的地址
当图片对象未加载到内存或内存被回收(调用recycle方法),此时使用图片对象时自动加载图片的地址。 适用于低内存环境下使用,仅在图片实际使用时才自动加载到内存中,使用后调用recycle方法回收释放内存。 注意:调用load/save方法会更新此地址。
返回值:
Bitmap : Bitmap图片对象
示例:
uni-app使用plus注意事项
id
Bitmap对象的标识
说明:
String 类型 只读属性
在创建Bitmap对象时设置,如果没有设置标识,此属性值为null。
示例:
uni-app使用plus注意事项
getItems
静态方法,获取所有Bitmap图片对象
说明:
获取应用运行期创建的所有Bitmap图片对象,包含所有空Bitmap对象,不包含已经销毁的Bitmap对象。返回的Bitmap对象在数组中按创建的属性排列,及数组中第一个是最先创建的Bitmap对象。
参数:
无
返回值:
Array[Bitmap] : 应用中创建的所有Bitmap图片对象数组。
示例:
uni-app使用plus注意事项
getBitmapById
静态方法,获取指定标识的Bitmap图片对象
说明:
在应用中已创建的图片对象中查找指定标识的Bitmap对象并返回。 若存在多个相同标识的Bitmap图片,则返回第一个创建的Bitmap图片。
参数:
- id: ( String ) 必选 要查找的Bitmap图片标识
返回值:
Bitmap : Bitmap图片对象,若没有查找到指定标识的图片对象则返回null。
示例:
uni-app使用plus注意事项
clear
销毁Bitmap图片
说明:
释放Bitmap图片占用的内存资源,销毁后图片对象将不可使用,其id属性值为undefined,调用其所有方法操作都会失败。
参数:
无
返回值:
void : 无
示例:
uni-app使用plus注意事项
load
加载Bitmap图片
说明:
从指定的路径(仅支持本地文件系统)中加载图片,此操作将覆盖之前的图片内容, 如果加载图片失败则保留之前的图片内容。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
loadBase64Data
加载Base64编码格式图片到Bitmap对象
说明:
从Base64编码格式图片数据中加载图片,此操作将覆盖之前的图片内容, 如果加载图片失败则保留之前的图片内容。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
recycle
回收Bitmap图片内存
说明:
释放Bitmap图片占用的内存资源,但不销毁图片对象,依然可以继续使用图片对象。 当图片对象再次被使用时会自动从设置的路径(构造函数或load/save方法设置)加载到内存中。
参数:
无
返回值:
void : 无
示例:
uni-app使用plus注意事项
save
保存图片
说明:
将图片保存到指定的路径(仅支持本地文件系统),如果图片为空或者指定的路径文件已经存在则返回失败。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
toBase64Data
获取图片的Base64编码数据
说明:
读取图片的数据内容,并转换为Base64编码格式字符串。
参数:
无
返回值:
String : 图片的Base64编码数据,如果图片为空则返回null。
示例:
uni-app使用plus注意事项
BitmapSaveOptions
JSON对象,保存图片的参数
属性:
- overwrite: (Boolean 类型 )覆盖保存图片文件
仅在保存的图片路径文件存在时有效: true表示覆盖存在的文件; false表示不覆盖,如果文件存在,则返回失败。 默认值为false。
- format: (String 类型 )保存图片的格式
支持"jpg"、"png",如果未指定则默认使用指定的保存路径后缀对应的文件格式,如果后缀文件格式无效则使用jpg格式。
- quality: (Number 类型 )保存图片的质量
取值范围为1-100,1表示使用最低的图片质量(保存后的图片文件最小)、100表示使用最高的图片质量(保存后的图片文件最大); 默认值为50。
- clip: (Rect 类型 )指定裁剪区域保存图片
相对于图片的区域信息,默认值为{top:'0px',left:'0px',width:'100%',height:'100%'}。
ImageSlider
原生图片轮播控件对象
说明:
原生图片轮播控件对象从原生View控件(plus.nativeObj.View)继承而来,用于绘制图片轮播内容。
构造:
方法:
ImageSlider(id, styles, tags)
创建图片轮播控件对象
说明:
与原生View控件一样,创建后需要调用show方法显示,或者添加到Webview中显示。
参数:
- id: ( String ) 必选 图片轮播控件对象的id
与原生View控件的id作用一样。
- styles: ( ImageSliderStyles ) 可选 图片轮播控件的样式
设置控件的位置、大小及显示的图片等信息。
- tags: ( Array[ViewDrawTagStyles] ) 可选 图片轮播控件上需要额外绘制的内容
与原生View控件一样,额外绘制自定义内容。
返回值:
ImageSlider : 原生图片轮播控件
示例:
uni-app使用plus注意事项
addImages
添加图片轮播控件的图片
说明:
动态添加图片轮播控件显示的图片。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
currentImageIndex
获取当前图片轮播控件显示的图片索引值
说明:
索引值从0开始,即0表示图片轮播控件当前显示第一张图片。
参数:
无
返回值:
Number : 当前图片轮播控件显示的图片索引值
示例:
uni-app使用plus注意事项
setImages
设置图片轮播控件的图片
说明:
动态更新图片轮播控件显示的图片。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
ImageSliderStyles
图片轮播控件样式
说明:
从ViewStyles继承而来,扩展支持轮播图片等配置。
属性:
- autoplay: (Boolean 类型 )是否自动播放
可取值: "true" - 自动播放; "false" - 不自动播放。 默认值为"false"。
- fullscreen: (Boolean 类型 )是否可全屏显示
可取值: "true" - 表示可全屏显示,用户点击轮播图片时全屏显示; "false" - 表示不可全屏显示,用户点击轮播图片时无响应。 默认值为"true"。
- loop: (Boolean 类型 )是否可循环轮播
可取值: "true" - 支持循环轮播; "false" - 不支持循环轮播。 默认值为"false"。
- images: (Array[ImageSliderImageStyles] 类型 )轮播的图片
至少必须设置一张图片的地址信息,否则可能导致图片轮播控件显示不正常。
- interval: (Number 类型 )自动播放切换时间
当autoplay属性值为true时生效,单位为毫秒。默认值为3000(3秒)。
ImageSliderImageStyles
图片轮播控件中图片项配置参数
说明:
用于指定图片地址等信息。
属性:
- src: (String 类型 )图片地址
支持本地地址(相对地址、绝对路径、RelativeURL、本地路径URL); 也支持网络地址(http://或https://)。
- align: (String 类型 )图片水平对齐方式
仅在图片显示的宽度与图片轮播控件宽度不一致时有效,可取值: "left" - 图片在轮播控件中水平居左对齐; "center" - 图片在轮播控件中水平居中对齐; "right" - 图片在轮播控件中水平居右对齐。 默认值为"center"。
- height: (String 类型 )图片显示的高度
可取值: 像素值,如"100px"; 百分比,如"10%",现对于图片轮播控件的高度; 自动计算"auto",如果指定图片宽度(width),则按图片实际大小等比缩放图片高度值,如果没有指定宽度(width值为"auto")则自动缩放图片至可完整显示。
- width: (String 类型 )图片显示的宽度
可取值: 像素值,如"100px"; 百分比,如"10%",相对于图片轮播控件的宽度; 自动计算"auto",如果指定图片高度(height),则按图片实际大小等比缩放图片宽度值,如果没有指定高度(height值为"auto")则自动缩放图片至可完整显示。 默认值为"auto"。
- verticalAlign: (String 类型 )图片垂直对齐方式
仅在图片显示的高度与图片轮播控件宽度不一致时有效,可取值: "top" - 图片在轮播控件中垂直居顶对齐; "middle" - 图片在轮播控件中垂直居中对齐; "bottom" - 图片在轮播控件中垂直居底对齐。 默认值为"middle"。
InputStyles
输入框样式
说明:
用于定义输入框的显示样式,如字体大小,提示内容等信息。 输入文本内容在指定区域水平居左,垂直居中显示。
属性:
- type: (String 类型 )输入框类型
可取值: "email" - 邮箱地址输入框; "number" - 数字输入框; "search" - 搜索文本输入框; "tel" - 电话号码输入框; "text" - 普通文本输入框; "url" - URL地址输入框。 默认为text(即普通文本输入框)。
- placeholder: (String 类型 )输入框的提示文本
当用户未输入内容时显示在编辑框中(灰色文字)。
- fontSize: (String 类型 )输入框的字体大小
可取值:字体高度像素值,数字加"px"格式字符串,如"12px"。 默认值为"16px"。
- borderColor: (String 类型 )输入框的边框颜色
可取值: "#RRGGBB"格式字符串,如"#FF0000"表示红色边框。默认值为"#000000"(黑色)。
- borderRadius: (String 类型 )输入框边框圆角半径
可取值:圆角半径像素值,数字加"px"格式字符串,如"6px"。 默认值为"0px"(边框无圆角)。
- borderWidth: (String 类型 )输入框的边框宽度
可取值:像素值,数字加"px"格式字符串,如"2px"。 默认值为"1px"。
- onComplete: (InputCompleteCallback 类型 )输入框完成输入事件
弹出软键盘完成输入后,点击软键盘上的“完成”、“前往”按钮时触发。
- onFocus: (InputEventCallback 类型 )输入框获取焦点事件
当编辑框获取焦点时触发。
- onBlur: (InputEventCallback 类型 )输入框失去焦点事件
当编辑框失去焦点时触发。
示例:
uni-app使用plus注意事项
Rect
区域信息对象
说明:
包括位置、大小等信息。
属性:
- top: (String 类型 )区域左上角的垂直偏移量
可取值: 像素值,如"100px"; 百分比,如"10%",相对于作用对象的高度; 自动计算,如"auto",根据height值自动计算,相对于作用对象垂直居中。
- left: (String 类型 )区域左上角的水平偏移量
可取值: 像素值,如"100px"; 百分比,如"10%",相对于作用对象的宽度; 自动计算,如"auto",根据width值自动计算,相对于作用对象水平居中。
- width: (String 类型 )区域的宽度
可取值: 像素值,如"100px"; 百分比,如"10%",相对于作用对象的宽度。
- height: (String 类型 )区域的高度
可取值: 像素值,如"100px"; 百分比,如"10%",相对于作用对象的高度。 内容自适应,如"wrap_content",根据内容计算高度(如调用drawText绘制文本时支持)。
RectStyles
绘制区域样式对象
说明:
用于定义矩形区域的显示样式,如空心/实心样式、圆角等信息。
属性:
- color: (String 类型 )绘制颜色
矩形填充区域的颜色,可取值: "#RRGGBB"格式字符串,如"#FF0000"表示绘制红色区域; "rgba(R,G,B,A)",其中R/G/B分别代表红色值/绿色值/蓝色值,正整数类型,取值范围为0-255,A为透明度,浮点数类型,取值范围为0-1(0为全透明,1为不透明),如"rgba(255,0,0,0.5)",表示红色半透明。 默认值为"#FFFFFF"(白色)。
- radius: (String 类型 )矩形区域的圆角半径
可取值:圆角半径像素值,数字加"px"格式字符串,如"6px"。 默认值为"0px"(矩形无圆角)。
- borderColor: (String 类型 )矩形边框颜色
绘制矩形边框的颜色,可取值: "#RRGGBB"格式字符串,如"#FF0000"表示绘制红色区域; "rgba(R,G,B,A)",其中R/G/B分别代表红色值/绿色值/蓝色值,正整数类型,取值范围为0-255,A为透明度,浮点数类型,取值范围为0-1(0为全透明,1为不透明),如"rgba(255,0,0,0.5)",表示红色半透明。 默认值为矩形填充区域颜色(color属性值)。
- borderWidth: (String 类型 )矩形边框宽度
可取值:像素值,数字加"px"格式字符串,如"2px"。 默认值为"0px"(无边框)。
示例:
uni-app使用plus注意事项
RichTextStyles
富文本样式
说明:
用于定义富文本使用的默认使用的字体名称、字体文件路径等信息。
属性:
- align: (String 类型 )富文本内容的水平对齐方式
对整体内容有效,无法单独控制每行的内容。 可取值: "left"-字体在指定的区域中水平居左对齐; "center"-字体在指定的区域中水平居中对齐; "right"-字体在指定的区域中水平居右对齐。 默认值为"left"。
- family: (String 类型 )富文本默认使用的字体名称
例如"Times New Roman", 如果指定名称的字体不存在,则使用系统默认字体。
- fontSrc: (String 类型 )富文本默认使用的字体文件路径
加载字体文件路径,必须为本地路径,如果指定的文件路径无效,则使用系统默认字体。
- onClick: (RichTextClickedCallback 类型 )点击事件回调函数
如果设置此属性,则表示拦截所有RichText上的点击事件(不透传事件)。 如果没有设置此属性,则仅拦截操作包含onclick属性的a/img标签的点击事件。
示例:
uni-app使用plus注意事项
Position
区域信息对象
说明:
包括位置、大小等信息。
属性:
- top: (String 类型 )区域顶部相对于作用对象(或容器)向下的偏移量
可取值:像素值,如"100px";百分比,如"10%",相对于作用对象(或容器)的高度; 自动计算,如"auto",根据height值自动计算,相对于作用对象(或容器)垂直居中。
- left: (String 类型 )区域左侧相对于作用对象(或容器)向右的偏移量
可取值:像素值,如"100px";百分比,如"10%",相对于作用对象(或容器)的宽度; 自动计算,如"auto",根据width值自动计算,相对于作用对象(或容器)水平居中。
- width: (String 类型 )区域的宽度
可取值:像素值,如"100px";百分比,如"10%",相对于作用对象(或容器)的宽度。
- height: (String 类型 )区域的高度
可取值:像素值,如"100px";百分比,如"10%",相对于作用对象(或容器)的高度。
- bottom: (String 类型 )区域底部相对于作用对象(或容器)向上的偏移量
可取值:像素值,如"100px";百分比,如"10%",相对于作用对象(或容器)的高度。 当设置了top和height值时,忽略此属性值; 当未设置top值时,可通过bottom属性值来确定区域的垂直位置; 当未设置height值时,可通过top和bottom属性值来确定区域的高度。
- right: (String 类型 )区域右侧相对于作用对象(或容器)向左的偏移量
可取值:像素值,如"100px";百分比,如"10%",相对于作用对象(或容器)的宽度。 当设置了left和width值时,忽略此属性值; 当未设置left值时,可通过right属性值来确定区域的水平位置; 当未设置width值时,可通过left和right属性值来确定区域的宽度。
示例:
uni-app使用plus注意事项