# sortByIndex-按索引排序
调用sortByIndex函数通过行/列的索引对增强数据表进行排序。
最小支持版本：5.0.0
# 接口说明
已获取DataFrame实例，详情请参见fromObject (opens new window)。
# 语法
<DataFrame object>.sortByIndex(<axis>, <level>, <ascending>, <inplace>, <kind>, <naPosition>, <sortRemaining>, <ignoreIndex>)
1
<DataFrame object>.按索引排序(<axis>, <level>, <ascending>, <inplace>, <kind>, <naPosition>, <sortRemaining>, <ignoreIndex>)
1
# 函数类型
实例函数
# 请求参数
| 参数名称 | 类型 | 是否必选 | 默认值 | 示例值 | 描述 |
|---|---|---|---|---|---|
| axis | Cube.Object | 是 | 无 | 0 | 沿着行或列进行排序。取值： 0：行索引 1：列索引 |
| level | Cube.Object | 是 | 无 | null | 整数或字符串/整数列表或字符串列表。如果不为空，在指定级别的索引上排序 |
| ascending | Cube.Object | 是 | 无 | true | 当索引是多级索引的时候，可以通过布尔值列表分别控制每个级别的排序方向。 true：升序 false：降序 |
| inplace | Cube.Lang.Boolean | 是 | true | true | 是否在原对象上进行排序操作。 true：在原对象上排序 false：在新对象上排序(需要拿一个变量承接)。 |
| kind | Cube.Lang.String | 是 | 无 | "quicksort" | 排序方式。取值： quicksort：快速排序 mergesort：归并排序 heapsort：堆排序 stable：稳定排序 |
| naPosition | Cube.Lang.String | 是 | 无 | “last” | 排序后将NaN放置在开头还是末尾。取值： ‘first’：排序后将NaN放在开头 ‘last’：排序后将NaN放在末尾 |
| sortRemaining | Cube.Lang.Boolean | 是 | true | true | 如果为true且通过级别和索引的排序是多级的，在指定的级别排序完之后，也可通过其他的级别排序（按顺序） |
| ignoreIndex | Cube.Lang.Boolean | 是 | true | true | 排序完后是否忽略原索引。 true：忽略索引，结果的索引会变为1...n false：使用原始索引 |
# 返回参数
| 参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Result | Cube.System.DataFrame | 无 | 根据inplace参数决定返回的结果。 true：返回参数为null false：返回排序后的数据表对象沿着行或列进行排序 |
# 请求示例
<DataFrame object>.sortByIndex(0, null, true, true, "quicksort", “last”, true, true)
1
最近更新时间: {
"value": "2023-09-12",
"effect": true
}