Global
- 说明:
- 全局函数,主要是is和as系列函数,提供类型判断和匿名类型的输入提示
Members
(static) $fx
- 说明:
- worksheetfunction对象的简写
worksheetfunction对象的简写
Example
var rs = $fx.sum(1,2,3);
console.log(rs); // 调用工作表函数sum
函数:
$(x) → {Range}
- 说明:
- Range和Cell的快捷方式 $("A1")->Range("A1"); $(1,1)->Cells(1,1)
以及 RngUtils,ShtUtils,DateUtils三个函数库的快速调用入库 用 $.marRange('A1') 即可相当于用RngUtiles.maxRange('A1')
- Range和Cell的快捷方式 $("A1")->Range("A1"); $(1,1)->Cells(1,1)
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
x |
any | 单元格地址('A1') 单个数字(1),或者2个数字(1,1) 以及单元格对象 |
返回值:
返回创建的单元格对象
- Type
- Range
例子
var range = $(x);
console.log(range); // 新创建的单元格对象
$toArray(…args) → {Array}
- 说明:
- 将参数转换为数组 内部使用 用户一般不用
参数列表:
参数名称 | 参数类型 | 属性 | 备注 |
---|---|---|---|
args |
any |
<repeatable> |
要转换为数组的参数 |
返回值:
返回转换后的数组
- Type
- Array
例子
var array = $toArray(arg1, arg2, arg3);
console.log(array); // 转换后的数组
asArray(o) → {Array}
- 说明:
- 把无类型提示的数组包装为有提示的数组,方便代码书写
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
o |
any | 要转换为数组的对象 |
返回值:
返回转换后的数组
- Type
- Array
例子
var array = asArray(obj);
console.log(array); // 转换后的数组
asDate(d) → {Date}
- 说明:
- 将日期字符串js日期对象转换为日期对象,也可用于包装日期变量实现输入提示
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
d |
any | 要转换的日期字符串或者日期变量 |
返回值:
返回转换后的js日期对象
- Type
- Date
例子
var date = asDate("2023-9-21");
console.log(date); // 转换后的日期对象
asNumber(s) → {Number}
- 说明:
- 将字符串转换为数字对象,主要用于提供输入提示
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
s |
string | 要转换的字符串 |
返回值:
返回转换后的数字对象
- Type
- Number
例子
var number = asNumber(string);
console.log(number); // 转换后的数字对象
asRange(rng) → {Range}
- 说明:
- 将对象转换为单元格对象,可用$代替
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
rng |
any | 要转换的对象 |
返回值:
返回转换后的单元格对象
- Type
- Range
例子
var range = asRange(obj);
console.log(range); // 转换后的单元格对象
asShape(shp) → {Shape}
- 说明:
- 将对象转换为形状对象
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
shp |
any | 要转换的对象 |
返回值:
返回转换后的形状对象
- Type
- Shape
例子
var shape = asShape(obj);
console.log(shape); // 转换后的形状对象
asSheet(sht, shts) → {Sheet}
- 说明:
- 将对象转换为工作表对象
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
sht |
any | 要转换的对象 |
shts |
Object | 包含工作表的对象 |
返回值:
返回转换后的工作表对象
- Type
- Sheet
例子
var sheet = asSheet(sht, shts);
console.log(sheet); // 转换后的工作表对象
asString(s) → {String}
- 说明:
- 将对象转换为字符串对象
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
s |
any | 要转换的对象 |
返回值:
返回转换后的字符串对象
- Type
- String
例子
var str = asString(s);
console.log(str); // 转换后的字符串对象
asWorkbook(wbk) → {Workbook}
- 说明:
- 将对象转换为工作簿对象
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
wbk |
any | 要转换的对象 |
返回值:
返回转换后的工作簿对象
- Type
- Workbook
例子
var workbook = asWorkbook(wbk);
console.log(workbook); // 转换后的工作簿对象
cdate(v) → {Number}
- 说明:
- 将日期转换为数字对象
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
v |
any | 日期字符串 js日期对象都可以 |
返回值:
返回转换后的日期数值
- Type
- Number
例子
var num = cdate(v);
console.log(num); // 转换后的日期数值
cstr(v) → {String}
- 说明:
- 将值转换为字符串对象
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
v |
any | 要转换的值 |
返回值:
返回转换后的字符串对象
- Type
- String
例子
var str = cstr(v);
console.log(str); // 转换后的字符串对象
isArray(v) → {Boolean}
- 说明:
- 检查值是否为数组
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
v |
any | 要检查的值 |
返回值:
如果值是数组,则返回true;否则返回false
- Type
- Boolean
例子
var isArr = isArray(v);
console.log(isArr); // 是否为数组
isArray2D(v) → {Boolean}
- 说明:
- 检查值是否为二维数组
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
v |
any | 要检查的值 |
返回值:
如果值是二维数组,则返回true;否则返回false
- Type
- Boolean
例子
var is2DArray = isArray2D(v);
console.log(is2DArray); // 是否为二维数组
isBoolean(v) → {Boolean}
- 说明:
- 检查值是否为布尔值
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
v |
any | 要检查的值 |
返回值:
如果值是布尔值,则返回true;否则返回false
- Type
- Boolean
例子
var isBool = isBoolean(v);
console.log(isBool); // 是否为布尔值
isCollection(obj) → {Boolean}
- 说明:
- 检查对象是否为集合对象
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
obj |
any | 要检查的对象 |
返回值:
如果对象可遍历的集合对象,则返回true;否则返回false
- Type
- Boolean
例子
var isColl = isCollection(Sheets);
console.log(isColl); // 是否为集合对象
isDate(v) → {Boolean}
- 说明:
- 检查值是否为日期对象
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
v |
any | 要检查的值 |
返回值:
如果值是日期对象,则返回true;否则返回false
- Type
- Boolean
例子
var isDateObject = isDate(new Date());
console.log(isDateObject); // 是否为日期对象
isEmpty(value) → {Boolean}
- 说明:
- 检查值是否为空值 undifined null 空字符串 均判定为空值
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
value |
any | 要检查的值 |
返回值:
如果值为空值,则返回true;否则返回false
- Type
- Boolean
例子
var isEmptyValue = isEmpty(value);
console.log(isEmptyValue); // 是否为空值
isNumeric(v) → {Boolean}
- 说明:
- 检查值是否为数值类型
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
v |
any | 要检查的值 |
返回值:
如果值是数值类型,则返回true;否则返回false
- Type
- Boolean
例子
var isNumeric = isNumeric(v);
console.log(isNumeric); // 是否为数值类型
isRange(v) → {Boolean}
- 说明:
- 检查值是否为单元格对象
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
v |
any | 要检查的值 |
返回值:
如果值是单元格对象,则返回true;否则返回false
- Type
- Boolean
例子
var isRange = isRange(Range("A1"));
console.log(isRange); // 是否为单元格对象
isRegex(v) → {Boolean}
- 说明:
- 检查值是否为正则表达式对象
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
v |
any | 要检查的值 |
返回值:
如果值是正则表达式对象,则返回true;否则返回false
- Type
- Boolean
例子
var isRegex = isRegex(/\d+/g);
console.log(isRegex); // 是否为正则表达式对象
isSameClass(x, y) → {Boolean}
- 说明:
- 检查两个值是否属于同一类别
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
x |
any | 要比较的第一个对象 |
y |
any | 要比较的第二个对象 |
返回值:
如果两个值属于同一类别,则返回true;否则返回false
- Type
- Boolean
例子
var isSame = isSameClass(x, y);
console.log(isSame); // 是否属于同一类别
isSheet(v) → {Boolean}
- 说明:
- 检查值是否为工作表对象
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
v |
any | 要检查的值 |
返回值:
如果值是工作表对象,则返回true;否则返回false
- Type
- Boolean
例子
var isSht = isSheet(Sheets(1));
console.log(isSht); // 是否为工作表对象
isString(v) → {Boolean}
- 说明:
- 检查值是否为字符串类型
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
v |
any | 要检查的值 |
返回值:
如果值是字符串类型,则返回true;否则返回false
- Type
- Boolean
例子
var isstr = isString(v);
console.log(isstr); // 是否为字符串类型
isWorkbook(v) → {Boolean}
- 说明:
- 检查值是否为工作簿对象
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
v |
any | 要检查的值 |
返回值:
如果值是工作簿对象,则返回true;否则返回false
- Type
- Boolean
例子
var iswbk = isWorkbook(ActiveWorkbook(1));
console.log(iswbk); // 是否为工作簿对象
log(…args) → {undefined}
- 说明:
- 输出日志信息
- 别名:
-
- log
参数列表:
参数名称 | 参数类型 | 属性 | 备注 |
---|---|---|---|
args |
any |
<repeatable> |
要输出的日志信息 |
返回值:
无返回值
- Type
- undefined
例子
log(arg1, arg2, arg3);
logjson(x, wrapopt) → {undefined}
- 说明:
- 输出JSON格式的日志信息
- 别名:
-
- logjson
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
x |
any | 要输出的JSON对象 | ||
wrap |
boolean |
<optional> |
true
|
是否包装JSON对象 |
返回值:
无返回值
- Type
- undefined
例子
logjson(x);//主要用于输出二维数组以换行模式方便查看
typeName(x, showlog) → {String}
- 说明:
- 获取值的类型名称
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
x |
any | 要获取类型名称的值 |
showlog |
any | 设为false不打印log分隔符 |
返回值:
返回值的类型名称
- Type
- String
例子
var typeName = typeName(v);
console.log(typeName); // 值的类型名称
ubound(数组, 维数opt) → {Number}
- 说明:
- 获取数组的指定维度的上界 主要是方便vba习惯一下子改不过来的同学
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
数组 |
Array | 要获取上界的数组 | ||
维数 |
number |
<optional> |
1
|
要获取上界的维度 |
返回值:
返回指定维度的上界
- Type
- Number
例子
var upperBound = ubound(数组, 维数);
console.log(upperBound); // 指定维度的上界
val(s) → {Number}
- 说明:
- 字符串及布尔值转为数值 基本与vba中的val保持一致
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
s |
String | 要转换的字符串 |
返回值:
返回数值对象
- Type
- Number
例子
var value = val(s);
console.log(value); // 转换后的值
round(number, decimals) → {number}
- 说明:
- 使用 Excel 计算规则对数字进行四舍五入
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
number |
number | 要进行四舍五入的数字 |
decimals |
number | 保留的小数位数(可选,默认为0) |
返回值:
四舍五入后的结果
- Type
- number
parseAll(hz) → {String}
- 说明:
- 解析所有拼音
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
hz |
String | 待解析的汉字 |
返回值:
解析后的拼音字符串
- Type
- String
例子
示例 pinyin.parseAll("中国") //zhong guo
parse(hz) → {String}
- 说明:
- 解析首字母拼音
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
hz |
String | 待解析的汉字 |
返回值:
解析后的首字母拼音字符串
- Type
- String
例子
示例 pinyin.parse("中国") //z g