ShtUtils
- 说明:
- 工作表函数工具库,增强工作表操作。 备注:这里面工作表作为参数都可以传表名或者工作表对象
函数:
z安全已使用区域(工作表) → {Range}
- 说明:
- 获取工作表从A1开始的可使用区
- 别名:
-
- z安全已使用区域
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
工作表 |
Worksheet | 要获取安全已使用区域的工作表 |
返回值:
返回工作表从A1开始的可使用区
- Type
- Range
例子
var usedRange = ShtUtils.z安全已使用区域(工作表);
console.log(usedRange.Address()); // 从A1开始的可使用区
safeUsedRange(sht) → {Range}
- 说明:
- 获取工作表从A1开始的可使用区
- 别名:
-
- safeUsedRange
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
sht |
Worksheet | 要获取安全已使用区域的工作表 |
返回值:
返回工作表从A1开始的可使用区
- Type
- Range
例子
var usedRange = ShtUtils.safeUsedRange(sht);
console.log(usedRange); // 安全已使用区域对象
z包含表名(表名, 表集合opt) → {boolean}
- 说明:
- 检查表集合中是否包含指定表名 可以用*通配符
- 别名:
-
- includesSht
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
表名 |
string | 要检查的表名 | ||
表集合 |
Object |
<optional> |
Sheets
|
要检查的表集合对象 |
返回值:
如果表集合中包含指定表名,则返回true;否则返回false
- Type
- boolean
例子
var includesSheet = ShtUtils.z包含表名(表名, 表集合);
console.log(includesSheet); // 是否包含表名
includesSht(shtname, shtsopt) → {boolean}
- 说明:
- 检查表集合中是否包含指定表名 可以用*通配符
- 别名:
-
- z包含表名
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
shtname |
string | 要检查的表名 | ||
shts |
Object |
<optional> |
Sheets
|
要检查的表集合对象 |
返回值:
如果表集合中包含指定表名,则返回true;否则返回false
- Type
- boolean
例子
var includesSheet = ShtUtils.includesSht(表名, 表集合);
console.log(includesSheet); // 是否包含表名
z表名筛选(表名, 表集合opt) → {Array}
- 说明:
- 筛选表集合中包含指定表名的表
- 别名:
-
- filterShts
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
表名 |
string | 要筛选的表名 | ||
表集合 |
Sheets |
<optional> |
Sheets
|
要筛选的表集合对象 |
返回值:
返回包含筛选结果的数组,数组中的元素为表名称
- Type
- Array
例子
var filteredSheets = ShtUtils.z表名筛选(表名, 表集合);
console.log(filteredSheets); // 包含筛选结果的数组
filterShts(shtname, shtsopt) → {Array}
- 说明:
- 筛选表集合中包含指定表名的表
- 别名:
-
- z表名筛选
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
shtname |
string | 要筛选的表名 | ||
shts |
Object |
<optional> |
Sheets
|
要筛选的表集合对象 |
返回值:
返回包含筛选结果的数组,数组中的元素为表对象
- Type
- Array
例子
var filteredSheets = ShtUtils.filterShts(表名, 表集合);
console.log(filteredSheets); // 包含筛选结果的表名数组
findSht(sht, shtsopt) → {Sheet}
- 说明:
- 在表集合中查找指定的表
- 别名:
-
- findSht
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
sht |
string | 要查找的表名 | ||
shts |
Object |
<optional> |
Sheets
|
要查找的表集合对象 |
返回值:
返回查找到的表对象
- Type
- Sheet
例子
var sheet = ShtUtils.findSht(sht, shts);
console.log(sheet); // 查找到的表对象
z判断空表(工作表) → {boolean}
- 说明:
- 判断工作表是否为空表
- 别名:
-
- z判断空表
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
工作表 |
Worksheet | 要判断的工作表 |
返回值:
如果工作表为空表,则返回true;否则返回false
- Type
- boolean
例子
var isEmpty = ShtUtils.z判断空表(工作表);
console.log(isEmpty); // 是否为空表
isEmptySht(sht) → {boolean}
- 说明:
- 判断工作表是否为空表
- 别名:
-
- isEmptySht
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
sht |
Worksheet | 要判断的工作表 |
返回值:
如果工作表为空表,则返回true;否则返回false
- Type
- boolean
例子
var isEmpty = ShtUtils.isEmptySht(sht);
console.log(isEmpty); // 是否为空表
z删除表(工作表) → {undefined}
- 说明:
- 删除指定的工作表
- 别名:
-
- deleteSht
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
工作表 |
Worksheet | 要删除的工作表 |
返回值:
无返回值
- Type
- undefined
例子
ShtUtils.z删除表(工作表);
deleteSht(sht) → {undefined}
- 说明:
- 删除指定的工作表
- 别名:
-
- z删除表
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
sht |
Worksheet | 要删除的工作表 |
返回值:
无返回值
- Type
- undefined
例子
ShtUtils.deleteSht(sht);
z按代码名称(表名, 表集合opt) → {Range}
- 说明:
- 按照代码名称查找表集合中的表
- 别名:
-
- byCodeName
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
表名 |
string | 要查找的代码名称 | ||
表集合 |
Object |
<optional> |
Sheets
|
要查找的表集合对象 |
返回值:
返回查找到的表对象
- Type
- Range
例子
var sheetRange = ShtUtils.z按代码名称(表名, 表集合);
console.log(sheetRange); // 查找到的表对象
byCodeName(sht, shtsopt) → {Sheet}
- 说明:
- 按照代码名称查找表集合中的表
- 别名:
-
- z按代码名称
参数列表:
参数名称 | 参数类型 | 属性 | 默认值 | 备注 |
---|---|---|---|---|
sht |
Worksheet | 要查找的代码名称 | ||
shts |
Object |
<optional> |
Sheets
|
要查找的表集合对象 |
返回值:
返回查找到的表对象
- Type
- Sheet
例子
var sheet = ShtUtils.byCodeName(sht, shts);
console.log(sheet); // 查找到的表对象
z隐藏表(表集合) → {undefined}
- 说明:
- 隐藏表集合中的表 不传参数则隐藏当前表外所有表
- 别名:
-
- hideSheets
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
表集合 |
Object | 要隐藏的表集合对象 |
返回值:
无返回值
- Type
- undefined
例子
ShtUtils.z隐藏表(表集合);
hideSheets(shts) → {undefined}
- 说明:
- 隐藏表集合中的表 不传参数则隐藏当前表外所有表
- 别名:
-
- z隐藏表
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
shts |
Object | 要隐藏的表集合对象 |
返回值:
无返回值
- Type
- undefined
例子
ShtUtils.hideSheets(shts);
z显示表(表集合) → {undefined}
- 说明:
- 显示表集合中的表 不传参数则显示所有表
- 别名:
-
- showSheets
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
表集合 |
Array | 表名数组 也可以是/分隔的多表 |
返回值:
无返回值
- Type
- undefined
例子
ShtUtils.z显示表(表集合);
showSheets(shts) → {undefined}
- 说明:
- 显示表集合中的表
- 别名:
-
- z显示表
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
shts |
Object | 要显示的表集合对象 |
返回值:
无返回值
- Type
- undefined
例子
ShtUtils.showSheets(shts);
shtActivate(工作表) → {undefined}
- 说明:
- 激活工作表函数
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
工作表 |
Worksheet | 待激活的工作表 |
返回值:
无返回值
- Type
- undefined
例子
示例
z激活表(工作表) → {undefined}
- 说明:
- 根据工作表名称激活工作表函数
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
工作表 |
Worksheet | 待激活的工作表 |
返回值:
无返回值
- Type
- undefined
例子
示例
sheetsSort(shts, sortFn) → {undefined}
- 说明:
- 对给定的工作表数组进行排序。
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
shts |
Array | 要排序的工作表数组。 |
sortFn |
function | 用于排序工作表的函数或者表名数组。 |
返回值:
- 不返回任何内容。
- Type
- undefined
例子
sheetsSort(Sheets,(sht)=>sht.Name)
z工作表排序(shts, sortFn) → {undefined}
- 说明:
- 和sheetsSort功能相同,但是函数名称为中文。
参数列表:
参数名称 | 参数类型 | 备注 |
---|---|---|
shts |
Array | 要排序的工作表数组。 |
sortFn |
function | 用于排序工作表的函数。 |
返回值:
- 不返回任何内容。
- Type
- undefined