# sort-排序
调用sort函数将指定Excel工作表区域按规则排序。
最小支持版本：5.0.0
# 接口说明
已新建/打开Excel文件，详情请参见open (opens new window)。
已获取ExcelSheet对象，详情请参见addSheet (opens new window)。
已获取ExcelRange对象，详情请参见getRange (opens new window)。
# 语法
<ExcelRange object>.sort(-1, "", -1, "", -1, -1, "", -1, -1, [], false, -1, -1, -1, -1)
1
<ExcelRange object>.排序(-1, "", -1, "", -1, -1, "", -1, -1, [], false, -1, -1, -1, -1)
1
# 函数类型
实例函数
# 请求参数
| 参数名称 | 类型 | 是否必选 | 默认值 | 示例值 | 描述 |
|---|---|---|---|---|---|
| sortMethod | Cube.Lang.Number | 是 | -1 | 1 | 排序方式。 1: 拼音 2: 笔画 |
| key1 | Cube.Lang.String | 是 | 无 | "" | 排序列名（表头）或列标签1。 该排序会先按Key1排序；在按照Key1有序的情况下, 按照Key2排序；Key1、Key2 都有序的情况下，按照Key3排序。 |
| order1 | Cube.Lang.Number | 是 | -1 | 1 | Key1的排序顺序。 1: 升序 2: 降序 -4135: 手动排序 |
| key2 | Cube.Lang.String | 是 | 无 | "" | 排序列名（表头）或列标签2。 该排序会先按Key1排序；在按照Key1有序的情况下, 按照Key2排序；Key1、Key2 都有序的情况下，按照Key3排序。 |
| sortedType | Cube.Lang.Number | 是 | -1 | -1 | 透视表排序类型。取值： -1：默认排序。 |
| order2 | Cube.Lang.Number | 是 | -1 | -1 | Key2的排序顺序。 1: 升序 2: 降序 -4135: 手动排序 |
| key3 | Cube.Lang.String | 是 | 无 | "" | 排序列名（表头）或列标签3。 该排序会先按Key1排序；在按照Key1有序的情况下, 按照Key2排序；Key1、Key2 都有序的情况下，按照Key3排序。 |
| order3 | Cube.Lang.Number | 是 | -1 | -1 | Key3的排序顺序。 1: 升序 2: 降序 -4135: 手动排序 |
| header | Cube.Lang.Number | 是 | -1 | -1 | 区域是否有表头。 0: Excel决定是否有表头 2: 没有表头, 整个区域都会被排序 1: 有表头 |
| orderCustom | Cube.Lang.List | 是 | [] | [] | 排序偏移量，自定义列表内数值类型参数，一般直接定义为空列表。 |
| matchCase | Cube.Lang.Boolean | 是 | false | false | 是否大小写敏感。取值： true：表示区分大小写排序 false：表示不区分大小写排序 |
| orientation | Cube.Lang.Number | 是 | -1 | -1 | 排序方向。 |
| dataOption1 | Cube.Lang.Number | 是 | -1 | -1 | Key1排序时的选项。 0: 数字和文本分开排序 1: 数字和文本一起进行排序 |
| dataOption2 | Cube.Lang.Number | 是 | -1 | 1 | Key2排序时的选项。 0: 数字和文本分开排序 1: 数字和文本一起进行排序 |
| dataOption3 | Cube.Lang.Number | 是 | -1 | 1 | Key3排序时的选项。 0: 数字和文本分开排序 1: 数字和文本一起进行排序 |
# 返回参数
| 参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Result | Cube.Lang.Null | 无 | 该函数返回值为空值。 |
# 请求示例
ExcelRange对象.sort(-1, "", -1, "", -1, -1, "", -1, -1, [], 0, -1, -1, -1, -1)
1
最近更新时间: {
"value": "2023-09-12",
"effect": true
}