From ebf086af902d900c40a1c7143410a457e15c3a3a Mon Sep 17 00:00:00 2001 From: hyb1996 <946994919@qq.com> Date: Mon, 2 Apr 2018 15:49:35 +0800 Subject: [PATCH] docs: update docs and indics to latest --- app/src/main/assets/docs/app.html | 28 +++++++++ .../assets/docs/{update.html => canvas.html} | 20 ++----- app/src/main/assets/docs/engines.html | 39 +++++++++++- app/src/main/assets/docs/events.html | 14 ++++- app/src/main/assets/docs/globals.html | 25 ++++++++ app/src/main/assets/docs/images.html | 60 +++++++++++++++++-- app/src/main/assets/indices/all.json | 42 +++++++++++++ 7 files changed, 206 insertions(+), 22 deletions(-) rename app/src/main/assets/docs/{update.html => canvas.html} (81%) diff --git a/app/src/main/assets/docs/app.html b/app/src/main/assets/docs/app.html index 211eddbb..ca798aa3 100644 --- a/app/src/main/assets/docs/app.html +++ b/app/src/main/assets/docs/app.html @@ -75,6 +75,10 @@

目录

默认情况下，如果为特定事件添加了超过 10 个监听器，则 EventEmitter 会打印一个警告。 此限制有助于寻找内存泄露。 但是，并不是所有的事件都要被限为 10 个。 emitter.setMaxListeners() 方法允许修改指定的 EventEmitter 实例的限制。 值设为 Infinity（或 0）表明不限制监听器的数量。

返回一个 EventEmitter 引用，可以链式调用。

- +

events.broadcast: 脚本间广播#

+

脚本间通信除了使用engines模块提供的ScriptEngine.emit()方法以外，也可以使用events模块提供的broadcast广播。

+

events.broadcast本身是一个EventEmitter，但它的事件是在脚本间共享的，所有脚本都能发送和监听这些事件；事件处理会在脚本主线程执行（后续可能加入函数onThisThread(eventName, ...args)来提供在其他线程执行的能力）。

+

例如在一个脚本发送一个广播hello:

+
events.broadcast.emit("hello", "小明");
+

在其他脚本中监听并处理：

+
events.broadcast.on("hello", function(name){
+    toast("你好, " + name);
+});
+//保持脚本运行
+setInterval(()=>{}, 1000);
+
diff --git a/app/src/main/assets/docs/globals.html b/app/src/main/assets/docs/globals.html index b9be56da..b160bd5f 100644 --- a/app/src/main/assets/docs/globals.html +++ b/app/src/main/assets/docs/globals.html @@ -87,6 +87,8 @@
  • exit()
  • random(min, max)
  • random()
    • +
  • requiresApi(api)
    • +
  • requiresAutojsVersion(version)
  • context
    • @@ -192,6 +194,29 @@ for(var i = 0; i < 100; i++){
  • 返回 <number>

    • 返回在[0, 1)的随机浮点数。

    +

    requiresApi(api)#

    +
    +

    表示此脚本需要Android API版本达到指定版本才能运行。例如requiresApi(19)表示脚本需要在Android 4.4以及以上运行。

    +

    调用该函数时会判断运行脚本的设备系统的版本号，如果没有达到要求则抛出异常。

    +

    可以参考以下Android API和版本的对照表:

    +

    平台版本： API级别

    +

    Android 7.0： 24

    +

    Android 6.0： 23

    +

    Android 5.1： 22

    +

    Android 5.0： 21

    +

    Android 4.4W： 20

    +

    Android 4.4： 19

    +

    Android 4.3： 18

    +

    requiresAutojsVersion(version)#

    +
    +

    表示此脚本需要Auto.js版本达到指定版本才能运行。例如requiresAutojsVersion("3.0.0 Beta")表示脚本需要在Auto.js 3.0.0 Beta以及以上运行。

    +

    调用该函数时会判断运行脚本的Auto.js的版本号，如果没有达到要求则抛出异常。

    +

    version参数可以是整数表示版本号，例如requiresAutojsVersion(250)；也可以是字符串格式表示的版本，例如"3.0.0 Beta", "3.1.0 Alpha4", "3.2.0"等。

    +

    可以通过app.autojs.versionCode和app.autojs.versionName获取当前的Auto.js版本号和版本。

    context#

    全局变量。一个android.content.Context对象。

    注意该对象为ApplicationContext，因此不能用于界面、对话框等的创建。

    diff --git a/app/src/main/assets/docs/images.html b/app/src/main/assets/docs/images.html index ac3f8b66..1187a09f 100644 --- a/app/src/main/assets/docs/images.html +++ b/app/src/main/assets/docs/images.html @@ -92,9 +92,13 @@
  • images.captureScreen()
  • images.captureScreen(path)
  • images.pixel(image, x, y)
    • -
  • images.save(image, path)
    • +
  • images.save(image, path[, format = "png", quality = 100])
  • images.read(path)
  • images.load(url)
    • +
  • images.fromBase64(base64)
    • +
  • images.toBase64(img[, format = "png", quality = 100])
    • +
  • images.fromBytes(bytes)
    • +
  • images.toBytes(img[, format = "png", quality = 100])
  • images.clip(img, x, y, w, h)
  • images.findColor(image, color, options)
  • images.findColorInRegion(img, color, x, y[, width, height, threshold])
    • @@ -259,13 +263,24 @@ toast(colors.toString(color));

    返回图片image在点(x, y)处的像素的ARGB值。

    该值的格式为0xAARRGGBB，是一个"32位整数"(虽然JavaScript中并不区分整数类型和其他数值类型)。

    坐标系以图片左上角为原点。以图片左侧边为y轴，上侧边为x轴。

    -

    images.save(image, path)#

    +

    images.save(image, path[, format = "png", quality = 100])#

    把图片image以PNG格式保存到path中。如果文件不存在会被创建；文件存在会被覆盖。

    -

    images.read(path)#

    +
    //把图片压缩为原来的一半质量并保存
+var img = images.read("/sdcard/1.png");
+images.save(img, "/sdcard/1.jpg", "jpg", 50);
+app.viewFile("/sdcard/1.jpg");
+

    images.read(path)#

    @@ -275,6 +290,43 @@ toast(colors.toString(color));
  • url <string> 图片URL地址

    • 加载在地址URL的网络图片并返回一个Image对象。如果地址不存在或者图片无法解码则返回null。

    +

    images.fromBase64(base64)#

    +
    +

    解码Base64数据并返回解码后的图片Image对象。如果base64无法解码则返回null。

    +

    images.toBase64(img[, format = "png", quality = 100])#

    +
    +

    把图片编码为base64数据并返回。

    +

    images.fromBytes(bytes)#

    +
    +

    解码字节数组bytes并返回解码后的图片Image对象。如果bytes无法解码则返回null。

    +

    images.toBytes(img[, format = "png", quality = 100])#

    +
    +

    把图片编码为字节数组并返回。

    images.clip(img, x, y, w, h)#