| 函数 | 语法 | 说明 |
| aggregates | aggregates( Scriptable scope, Object cgrid, Object odims, Object omeasures) | 从数据结果中提取出N列来计算分组和汇总的数据结果。 |
|
| 参数1：运行此脚本的作用域，通常用this，表示当前作用域。 |
|
| 参数2：DataGrid对象。 |
|
| 参数3：指定DimCol，定义分组列，是一个数组。 |
|
| 参数4：指定MeasureCol，定义合计列，是一个数组。 |
|
|
| newInstance | newInstance(String classname); | 创建一个对象实例。 |
| isNull | isNull (Object obj); | 检测对象是否为空。 |
| isNumber | isNumber(Object val); | 检测对象是否为数值类型。 |
| isDate | isDate(Object val) | 检测对象是否为日期类型。 |
| getWeek | getWeek(Object date) | 从Date对象返回一年中的第几周。 |
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
| getDate | getDate(Object date) | 返回一个Java的日期。 |
[tr] [/tr]
[tr] [/tr]
| cloneDate | cloneDate(Object date) | 复制一个Java的日期。 |
[tr] [/tr]
[tr] [/tr]
| formatDate | formatDate(Object val, String fmtstr); | 把日期按照指定的格式转化为字符串。 |
|
| 参数1：指定日期。 |
|
| 参数2：指定格式。 |
| parseDate | parseDate(String str, String fmt) | 根据指定格式，解析字符串，返回日期对象。 |
|
| 参数1：指定日期。 |
|
| 参数2：指定格式。 |
| dateAdd | dateAdd(Object date, String option) | 给日期添加指定时间间隔，时间间隔包括：year，quarter，month，weekofyear，dayofyear，dayofmonth，dayofweek，hour，minute，second。 |
[tr] [/tr]
[tr] [/tr]
| dateGap | dateGap(Object startDate, Object endDate, String option) | 计算两个日期之间的时间差，时间间隔包括：year，quarter，month，weekofyear，dayofyear，dayofmonth，dayofweek，hour，minute，second。 |
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
| datePart | datePart(Object date, String option) | 根据给定参数取出年、月、日等各部分的数值，参数有：year，quarter，month，weekofyear，dayofyear，dayofmonth，dayofweek，hour，minute，second。 |
[tr] [/tr]
[tr] [/tr]
| toDate | toDate(Object javaDate) | 将指定值转换为日期对象。 |
[tr] [/tr]
[tr] [/tr]
| split | split(String str, String delim, Object limit); | 将字符串分割为字符串数组。 |
|
| 参数1：待分割的字符串。 |
|
| 参数2：用于标识子字符串边界的字符串字符。 |
|
| 参数3：要返回的子字符串数，–1表示返回所有的子字符串。 |
| split2Array | split2Array(String str, int dataType) | 将字符串分割为指定对象的数组。 |
|
| 参数1：待分割的字符串，用","分割。 |
|
| 参数2：数组元素的数据类型。 |
| formatNumber | formatNumber(double number, String fmt); | 将数字按照指定的格式转化为字符串。 |
| toString | toString(Object val) | 将任意对象转换为字符串。 |
[tr] [/tr]
[tr] [/tr]
| sqr | sqr(Object val); | 返回给定数据的平方值。 |
| sqrt | sqrt(Object val); | 返回给定数据的平方根。 |
| abs | abs(Object val) | 返回给定数据的绝对值。 |
| debug | debug(Object msg);l | 用来调试，向前台和日志文件输出信息。 |
| execute | execute(Scriptable scope, int type, String path, [Object allCols]) | 运行一个数据集。 |
|
| 参数1：运行此脚本的作用域，通常用this，表示当前作用域。 |
|
| 参数2：数据集的类型，支持的有：SQL，EXCEL，SCRIPT，CUSTOM，CLOUD，EMBED，COMPOSITE，MONGO，DATA_FLOW，MDX，RESTFUL。 |
|
| 参数3：数据集的路径及名称。如果有目录就用'/' 连接起来。 |
|
| 参数4：可选。为true 时，数据集的表达式列可见；缺省值为false 时，数据集的表达式列不可见。 |
| preExecute | preExecute(Scriptable script, int type, String path, [Object allcols]) | 预运行一个数据集，返回ID以获取数据集结果。 |
|
| 参数1：运行此脚本的作用域，通常用this，表示当前作用域。 |
|
| 参数2：查询的类型，支持的有：SQL，EXCEL，SCRIPT，CUSTOM，CLOUD，EMBED，COMPOSITE，MONGO，DATA_FLOW，MDX，RESTFUL。 |
|
| 参数3：数据集的路径及名称。如果有目录就用'/' 连接起来。 |
|
| 参数4：可选。为true 时，数据集的表达式列可见；缺省值为false 时, 数据集的表达式列不可见。 |
| executed | executed(Object executedID) | 根据给定ID，获取数据集的数据结果。 |
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
| removeExecuted | removeExecuted(Object executedID) | 删除预运行数据集结果对应的ID。 |
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
| join | join(Scriptable scope, int jhint, int jop, Object jleft, Object jright, Object jlkeys, Object jrkeys, Object jlcols, Object jrcols) | 将两个数据结果连接。 |
|
| 参数1：运行此脚本的作用域，通常用this，表示当前作用域。 |
|
| 参数2：join 的提示。LEFT_MAIN：左表为主，RIGHT_MAIN：右表为主，FINAL_JOIN：是最终表，TEMP_JOIN：是个临时表，会被回收的表。 |
|
| 参数3：连接操作符。JOIN：是内连接，LEFT_JOIN：左连接，RIGHT_JOIN：右连接，FULL_JOIN：全连接。 |
|
| 参数4：左表，是一个DataGrid对象。 |
|
| 参数5：右表，是一个DataGrid对象。 |
|
| 参数6：左表的连接的字段，是一个整数数组或字符串数组，数组成员可以是列的index或名字。 |
|
| 参数7：右表的连接的字段，是一个整数数组或字符串数组，数组成员可以是列的index或名字。 |
|
| 参数8：左表的留下哪些字段，null表示所有字段，是一个整数数组或字符串数组，数组成员可以是列的index或名字。 |
|
| 参数9：右表的留下哪些字段，null表示所有字段，是一个整数数组或字符串数组，数组成员可以是列的index或名字。 |
| union | union (Scriptable scope, Object ugrids) | 将两个数据结果联合。 |
|
| 参数1：运行此脚本的作用域，通常用this，表示当前作用域。 |
|
| 参数2：DataGrid数组。 |
| columns | columns (Scriptable scope, Object cgrid, Object ccols) | 从数据结果中提取出N列组成新的数据结果。 |
|
| 参数1：运行此脚本的作用域，通常用this，表示当前作用域。 |
|
| 参数2：DataGrid对象。 |
|
| 参数3：指定哪些列被提取，是一个整数数组或字符串数组，数组成员可以是列的index或名字。 |
| sort | sort (Scriptable scope, Object sgrid, Object scols, Object sascs) | 对数据结果的指定列进行排序。 |
|
| 参数1：运行此脚本的作用域，通常用this，表示当前作用域。 |
|
| 参数2：DataGrid对象。 |
|
| 参数3：指定排序的列，是一个整数数组或字符串数组，数组成员可以是列的index或名字。 |
|
| 参数4：指定排序类型，是一个布尔数组，数组成员true( 升序)， false （降序）。 |
| embed | embed(Object val) | 将数组转换为内嵌数据。 |
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
| toArray | toArray(Object gobj,Object cobj) | 将数据集的数据结果中某列的数据转换为数组。 |
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
[tr] [/tr]
| position | position(Object ox, Object oy) | 把经度和纬度转化为一个长整型来存储。 |
| putGlobal | putGlobal(String key,Object val) | 将指定对象转换为全局常量。 |
[tr] [/tr]
[tr] [/tr]
| toSQLDate | toSQLDate(Object val, int ctype) | 将普通日期转换为SQL 支持的时间戳。 |
|
| 参数1：日期值。 |
|
| 参数2：DType.DATE_TIME，DType.DATE，DType.TIME。 |
| substring | substring(String str, Integer idx, Object end) | 返回某个指定位置的字符串的子集。 |
|
| 参数1：给定的字符串。 |
|
| 参数2：一个非负的整数，规定要提取的子串的第一个字符在给定的字符串中的位置。 |
|
| 参数3：可选，非负的整数。如果省略该参数，那么返回的子串会一直到字符串的结尾。 |
| indexOf | indexOf(String str, String istr, Object idx]) | 返回某个指定的字符串值在源字符串中首次出现处的索引。 |
|
| str：源字符串。 |
|
| istr：要查找的字符串。 |
|
| idx: 可选，从idx位置开始查找。 |
| toDate | toDate(Object javaDate) | 将后台取到的时间转换为另一种时间。 |
[tr] [/tr]
[tr] [/tr]
| getDataMartUpdateTime | getDataMartUpdateTime(String queryPath, int Type ) | 获取集市数据的更新时间，包括集市数据集使用的集市数据和抽取数据到集市的数据集使用的集市数据。 |
|
| 参数1：数据集的路径及名称。如果有目录就用'/' 连接起来。 |
|
| 参数2：数据集的类型，支持的有：SQL，SCRIPT，EXCEL，CUSTOM，CLOUD，COMPOSITE，MONGO，DATA_FLOW，RESTFUL。 |
| getDataMartDataSize | getDataMartDataSize(String queryPath, int Type ) | 获取集市数据的数据大小（单位：MB），包括集市数据集使用的集市数据和抽取数据到集市的数据集使用的集市数据。 |
|
| 参数1：数据集的路径及名称。如果有目录就用'/' 连接起来。 |
|
| 参数2：数据集的类型，支持的有：SQL，EXCEL，SCRIPT，CUSTOM，CLOUD，COMPOSITE，MONGO，DATA_FLOW，RESTFUL。 |
| getDataMartDataRows | getDataMartDataRows(String queryPath, int Type ) | 获取集市数据的数据行数，包括集市数据集使用的集市数据和抽取数据到集市的数据集使用的集市数据。 |
|
| 参数1：数据集的路径及名称。如果有目录就用'/' 连接起来。 |
|
| 参数2：数据集的类型，支持的有：SQL，SCRIPT，EXCEL，CUSTOM，CLOUD，COMPOSITE，MONGO，DATA_FLOW，RESTFUL。 |
| executeExp | executeExp(Scriptable script, String path) | 运行一个深度分析实验。 |
|
| 参数1：运行此脚本的作用域，通常用this，表示当前作用域。 |
| 参数2：实验的路径及名称。如果有目录就用'/' 连接起来。 |