# sortByOrderConditions-条件排序
调用sortByOrderConditions函数对指定Excel区域进行排序。
最小支持版本：6.5.0
# 接口说明
已打开Excel文件, 详情请参见open (opens new window)。
已创建WorkBook对象，详情请参见createWorkbook (opens new window)。
已获取ExcelSheet对象，详情请参见getSheetByIndex (opens new window)。
已获取ExcelWorkbook对象、ExcelSheet对象或ExcelRange对象，详情请参见getUsedRange (opens new window)。
# 语法
<ExcelRange object>.sortByOrderConditions(<orderConditions>, 1, 0, false, 1, {})
1
<ExcelRange object>.条件排序(<orderConditions>, 1, 0, false, 1, {})
1
# 函数类型
实例函数
# 请求参数
| 参数名称 | 类型 | 是否必选 | 默认值 | 示例值 | 描述 |
|---|---|---|---|---|---|
| orderConditions | Cube.Lang.KeyValue | 是 | 无 | { "1": { "key": "A", "sortOn": 0, "order": 1, "customOrder": "aaa,aaaaa,a,aaaa,aa" }, "2": { "key": "B", "sortOn": 0, "order": 2, "customOrder": "" } } | 排序条件，该值为一个键值对集合。 键名为排序条件的优先级，键值为一个键值对集合，支持设置四个排序条件：key是必须设置的条件，为排序参照的行或者列；sortOn为排序的属性依据，0表示按值排序，1表示按单元格颜色排序，2表示按字体颜色排序，3表示按单元格图标排序；order为排序顺序，1表示升序，2表示降序；customOrder为自定义排序序列。 |
| sortMethod | Cube.Lang.Number | 是 | 1 | 1 | 排序方式。 1: 拼音 2: 笔画 |
| header | Cube.Lang.Number | 是 | 0 | 0 | 是否包含表头。 0: 由Excel应用判断 1: 有 2: 无 |
| matchCase | Cube.Lang.Boolean | 是 | false | false | 是否大小写敏感。取值： true：敏感 false：不敏感 |
| orientation | Cube.Lang.Number | 是 | 1 | 1 | 排序方向。 1: 从上到下 2: 从左到右 |
| options | Cube.Lang.KeyValue | 是 | {} | {} | 扩展参数，暂无可使用扩展参数。 |
# 返回参数
| 参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Result | Cube.Lang.Null | 无 | 该函数返回值为空值。 |
# 请求示例
ExcelRange对象.sortByOrderConditions({"1": {"key": "A","sortOn": 0,"order": 1,"customOrder": "aaa,aaaaa,a,aaaa,aa"},"2": {"key": "B","sortOn": 0,"order": 2,"customOrder": ""}}, 1, 0, false, 1, {})
1
最近更新时间: {
"value": "2023-09-12",
"effect": true
}