amis-formula 1.2.4 → 1.2.8

package/README.md

@@ -1,5 +1,5 @@
 # amis-tpl
 
-负责 amis 里面的表达式实现，内置公式，编辑器等
+负责 amis 里面的表达式、公式及模板的实现
 
 属于 [amis](https://github.com/baidu/amis) 子项目

package/dist/doc.js

@@ -98,9 +98,9 @@ export default [
     ],
     returns: {
       type: "any",
-      description: "返回第一个满足条件的结果，没有命中的返回 false。"
+      description: "第一个满足条件的结果，没有命中的返回 false。"
     },
-    namespace: ""
+    namespace: "逻辑函数"
   },
   {
     name: "ABS",
@@ -115,7 +115,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回传入数值的绝对值"
+      description: "传入数值的绝对值"
     },
     namespace: "数学函数"
   },
@@ -132,7 +132,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回所有传入值中最大的那个"
+      description: "所有传入值中最大的那个"
     },
     namespace: "数学函数"
   },
@@ -149,7 +149,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回所有传入值中最小的那个"
+      description: "所有传入值中最小的那个"
     },
     namespace: "数学函数"
   },
@@ -166,7 +166,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回所有传入数值的总和"
+      description: "所有传入数值的总和"
     },
     namespace: "数学函数"
   },
@@ -183,7 +183,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回数值对应的整形"
+      description: "数值对应的整形"
     },
     namespace: "数学函数"
   },
@@ -205,7 +205,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回两数相除的余数"
+      description: "两数相除的余数"
     },
     namespace: "数学函数"
   },
@@ -216,7 +216,7 @@ export default [
     params: [],
     returns: {
       type: "number",
-      description: "返回圆周率数值"
+      description: "圆周率数值"
     },
     namespace: "数学函数"
   },
@@ -238,7 +238,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回传入数值四舍五入后的结果"
+      description: "传入数值四舍五入后的结果"
     },
     namespace: "数学函数"
   },
@@ -260,7 +260,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回传入数值向下取整后的结果"
+      description: "传入数值向下取整后的结果"
     },
     namespace: "数学函数"
   },
@@ -282,7 +282,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回传入数值向上取整后的结果"
+      description: "传入数值向上取整后的结果"
     },
     namespace: "数学函数"
   },
@@ -299,7 +299,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回开平方的结果"
+      description: "开平方的结果"
     },
     namespace: "数学函数"
   },
@@ -316,7 +316,80 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回所有数值的平均值"
+      description: "所有数值的平均值"
+    },
+    namespace: "数学函数"
+  },
+  {
+    name: "DEVSQ",
+    description: "返回数据点与数据均值点之差（数据偏差）的平方和",
+    example: "DEVSQ(num1, num2, ...numN)",
+    params: [
+      {
+        type: "...number",
+        name: "num",
+        description: "要处理的数字"
+      }
+    ],
+    returns: {
+      type: "number",
+      description: "所有数值的平均值"
+    },
+    namespace: "数学函数"
+  },
+  {
+    name: "AVEDEV",
+    description: "数据点到其算术平均值的绝对偏差的平均值",
+    example: "AVEDEV(num1, num2, ...numN)",
+    params: [
+      {
+        type: "...number",
+        name: "num",
+        description: "要处理的数字"
+      }
+    ],
+    returns: {
+      type: "number",
+      description: "所有数值的平均值"
+    },
+    namespace: "数学函数"
+  },
+  {
+    name: "HARMEAN",
+    description: "数据点的调和平均值",
+    example: "HARMEAN(num1, num2, ...numN)",
+    params: [
+      {
+        type: "...number",
+        name: "num",
+        description: "要处理的数字"
+      }
+    ],
+    returns: {
+      type: "number",
+      description: "所有数值的平均值"
+    },
+    namespace: "数学函数"
+  },
+  {
+    name: "LARGE",
+    description: "数据集中第 k 个最大值",
+    example: "LARGE(array, k)",
+    params: [
+      {
+        type: "array",
+        name: "nums",
+        description: "要处理的数字"
+      },
+      {
+        type: "number",
+        name: "k",
+        description: "第几大"
+      }
+    ],
+    returns: {
+      type: "number",
+      description: "所有数值的平均值"
     },
     namespace: "数学函数"
   },
@@ -333,7 +406,7 @@ export default [
     ],
     returns: {
       type: "string",
-      description: "返回数值中文大写字符"
+      description: "数值中文大写字符"
     },
     namespace: "数学函数"
   },
@@ -344,7 +417,7 @@ export default [
     params: [],
     returns: {
       type: "number",
-      description: "返回随机数"
+      description: "随机数"
     },
     namespace: "数学函数"
   },
@@ -422,7 +495,7 @@ export default [
     ],
     returns: {
       type: "Array<number>",
-      description: "返回长度集合"
+      description: "长度集合"
     },
     namespace: "文本函数"
   },
@@ -439,7 +512,7 @@ export default [
     ],
     returns: {
       type: "boolean",
-      description: "返回判断结果"
+      description: "判断结果"
     },
     namespace: "文本函数"
   },
@@ -456,7 +529,7 @@ export default [
     ],
     returns: {
       type: "string",
-      description: "返回连接后的文本"
+      description: "连接后的文本"
     },
     namespace: "文本函数"
   },
@@ -473,7 +546,7 @@ export default [
     ],
     returns: {
       type: "string",
-      description: "返回指定位置的字符"
+      description: "指定位置的字符"
     },
     namespace: "文本函数"
   },
@@ -490,7 +563,7 @@ export default [
     ],
     returns: {
       type: "string",
-      description: "返回结果文本"
+      description: "结果文本"
     },
     namespace: "文本函数"
   },
@@ -507,7 +580,129 @@ export default [
     ],
     returns: {
       type: "string",
-      description: "返回结果文本"
+      description: "结果文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "UPPERFIRST",
+    description: "将传入文本首字母转成大写",
+    example: "UPPERFIRST(text)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "结果文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "PADSTART",
+    description: "向前补齐文本长度\n\n示例 `PADSTART(\"6\", 2, \"0\")`\n\n返回 `06`",
+    example: "PADSTART(text)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      },
+      {
+        type: "number",
+        name: "num",
+        description: "目标长度"
+      },
+      {
+        type: "string",
+        name: "pad",
+        description: "用于补齐的文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "结果文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "CAPITALIZE",
+    description: "将文本转成标题\n\n示例 `CAPITALIZE(\"star\")`\n\n返回 `Star`",
+    example: "CAPITALIZE(text)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "结果文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "ESCAPE",
+    description: "对文本进行 HTML 转义\n\n示例 `ESCAPE(\"star\")`\n\n返回 `Star`",
+    example: "ESCAPE(text)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "结果文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "TRUNCATE",
+    description: "对文本长度进行截断\n\n示例 `TRUNCATE(\"amis.baidu.com\", 6)`\n\n返回 `amis...`",
+    example: "TRUNCATE(text, 6)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      },
+      {
+        type: "number",
+        name: "text",
+        description: "最长长度"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "结果文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "BEFORELAST",
+    description: "取在某个分隔符之前的所有字符串",
+    example: "BEFORELAST(text, '.')",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      },
+      {
+        type: "string",
+        name: "delimiter",
+        description: "结束文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "判断结果"
     },
     namespace: "文本函数"
   },
@@ -529,7 +724,7 @@ export default [
     ],
     returns: {
       type: "Array<string>",
-      description: "返回文本集"
+      description: "文本集"
     },
     namespace: "文本函数"
   },
@@ -546,7 +741,41 @@ export default [
     ],
     returns: {
       type: "string",
-      description: "返回处理后的文本"
+      description: "处理后的文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "STRIPTAG",
+    description: "去除文本中的 HTML 标签\n\n示例：`STRIPTAG(\"<b>amis</b>\")`\n\n返回：`amis`",
+    example: "STRIPTAG(text)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "处理后的文本"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "LINEBREAK",
+    description: "将字符串中的换行转成 HTML `<br>`，用于简单换行的场景\n\n示例：`LINEBREAK(\"\\n\")`\n\n返回：`<br/>`",
+    example: "LINEBREAK(text)",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "处理后的文本"
     },
     namespace: "文本函数"
   },
@@ -568,7 +797,29 @@ export default [
     ],
     returns: {
       type: "string",
-      description: "返回判断结果"
+      description: "判断结果"
+    },
+    namespace: "文本函数"
+  },
+  {
+    name: "ENDSWITH",
+    description: "判断字符串(text)是否以特定字符串(endString)结束，是则返回 True，否则返回 False",
+    example: "ENDSWITH(text, '片段')",
+    params: [
+      {
+        type: "string",
+        name: "text",
+        description: "文本"
+      },
+      {
+        type: "string",
+        name: "endString",
+        description: "结束文本"
+      }
+    ],
+    returns: {
+      type: "string",
+      description: "判断结果"
     },
     namespace: "文本函数"
   },
@@ -590,7 +841,7 @@ export default [
     ],
     returns: {
       type: "string",
-      description: "返回判断结果"
+      description: "判断结果"
     },
     namespace: "文本函数"
   },
@@ -617,7 +868,7 @@ export default [
     ],
     returns: {
       type: "string",
-      description: "返回处理结果"
+      description: "处理结果"
     },
     namespace: "文本函数"
   },
@@ -644,7 +895,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回命中的位置"
+      description: "命中的位置"
     },
     namespace: "文本函数"
   },
@@ -671,7 +922,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回命中的位置"
+      description: "命中的位置"
     },
     namespace: "文本函数"
   },
@@ -682,7 +933,7 @@ export default [
     params: [],
     returns: {
       type: "Date",
-      description: "返回日期对象"
+      description: "日期对象"
     },
     namespace: "日期函数"
   },
@@ -704,7 +955,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回时间戳"
+      description: "时间戳"
     },
     namespace: "日期函数"
   },
@@ -715,7 +966,7 @@ export default [
     params: [],
     returns: {
       type: "number",
-      description: "返回日期"
+      description: "日期"
     },
     namespace: "日期函数"
   },
@@ -726,7 +977,7 @@ export default [
     params: [],
     returns: {
       type: "number",
-      description: "返回日期"
+      description: "日期"
     },
     namespace: "日期函数"
   },
@@ -748,7 +999,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回日期字符串"
+      description: "日期字符串"
     },
     namespace: "日期函数"
   },
@@ -809,7 +1060,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回数值"
+      description: "数值"
     },
     namespace: "日期函数"
   },
@@ -826,7 +1077,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回数值"
+      description: "数值"
     },
     namespace: "日期函数"
   },
@@ -843,7 +1094,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回数值"
+      description: "数值"
     },
     namespace: "日期函数"
   },
@@ -860,7 +1111,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回数值"
+      description: "数值"
     },
     namespace: "日期函数"
   },
@@ -877,7 +1128,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回数值"
+      description: "数值"
     },
     namespace: "日期函数"
   },
@@ -894,7 +1145,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回数值"
+      description: "数值"
     },
     namespace: "日期函数"
   },
@@ -916,7 +1167,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回数值"
+      description: "数值"
     },
     namespace: "日期函数"
   },
@@ -938,7 +1189,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回数值"
+      description: "数值"
     },
     namespace: "日期函数"
   },
@@ -960,7 +1211,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回数值"
+      description: "数值"
     },
     namespace: "日期函数"
   },
@@ -982,7 +1233,7 @@ export default [
     ],
     returns: {
       type: "number",
-      description: "返回数值"
+      description: "数值"
     },
     namespace: "日期函数"
   },
@@ -1009,7 +1260,7 @@ export default [
     ],
     returns: {
       type: "date",
-      description: "返回日期对象"
+      description: "日期对象"
     },
     namespace: "日期函数"
   },
@@ -1031,7 +1282,7 @@ export default [
     ],
     returns: {
       type: "date",
-      description: "返回日期对象"
+      description: "日期对象"
     },
     namespace: "日期函数"
   },
@@ -1058,7 +1309,7 @@ export default [
     ],
     returns: {
       type: "boolean",
-      description: "} 返回判断结果"
+      description: "判断结果"
     },
     namespace: "日期函数"
   },
@@ -1085,7 +1336,7 @@ export default [
     ],
     returns: {
       type: "boolean",
-      description: "} 返回判断结果"
+      description: "判断结果"
     },
     namespace: "日期函数"
   },
@@ -1112,7 +1363,7 @@ export default [
     ],
     returns: {
       type: "boolean",
-      description: "} 返回判断结果"
+      description: "判断结果"
     },
     namespace: "日期函数"
   },
@@ -1139,7 +1390,7 @@ export default [
     ],
     returns: {
       type: "boolean",
-      description: "} 返回判断结果"
+      description: "判断结果"
     },
     namespace: "日期函数"
   },
@@ -1156,7 +1407,7 @@ export default [
     ],
     returns: {
       type: "boolean",
-      description: "返回结果"
+      description: "结果"
     },
     namespace: "其他"
   }