排序(Sort)

Sort 对象，表示排序相关

方法列表

方法	说明
AddSort()	添加排序条件
DeleteSort()	删除排序条件
GetCondition()	通过索引获取排序条件
GetConditionById()	通过 fieldID 获取排序条件
GetConditionsCount()	获取排序条件数据
SetAutoSort()	设置自动排序
SetConditionPriority()	设置排序的优先级
SetIsAscending()	设置排序的升降序

AddSort()

添加排序条件

提示

不支持重复添加

语法

表达式.ActiveDBSheet.Sort.AddSort({ Index, IsAscending })

表达式：文档类型应用对象

参数

属性	数据类型	默认值	必填	说明
Index	Number		是	索引 Index，对应 DBSheet 中的列
IsAscending	Boolean		是	true 为升序，false 为降序

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 添加排序条件
  await app.ActiveDBSheet.Sort.AddSort({
    Index: 2, // 索引 Index，对应 DBSheet 中的列
    IsAscending: true // true 为升序，false 为降序
  })
}

DeleteSort()

删除排序条件

提示

不支持重复删除

语法

表达式.ActiveDBSheet.Sort.DeleteSort({ Index })

表达式：文档类型应用对象

参数

属性	数据类型	默认值	必填	说明
Index	Number		是	索引 Index，对应 DBSheet 中的列

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 删除排序条件
  await app.ActiveDBSheet.Sort.DeleteSort({
    Index: 2 // 索引 Index，对应 DBSheet 中的列
  })
}

GetCondition()

通过索引获取排序条件

语法

表达式.ActiveDBSheet.Sort.GetCondition({ Index })

表达式：文档类型应用对象

参数

属性	数据类型	默认值	必填	说明
Index	Number		是	索引

返回值

属性	数据类型	说明
FieldId	String	对应列的 FieldId
IsAscending	Boolean	对应列是否升序

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 通过索引获取排序条件
  const getCondition = await app.ActiveDBSheet.Sort.GetCondition({
    Index: 1 // 索引
  })
  console.log(getCondition)
}

GetConditionById()

通过 FieldId 获取排序条件

提示

前提条件：当前 FieldId 已具有排序条件

语法

表达式.ActiveDBSheet.Sort.GetConditionById(FieldId)

表达式：文档类型应用对象 FieldId，可通过 ActiveDBSheet.Field.GetFieldId() 获取

参数

属性	数据类型	默认值	必填	说明
FieldId	String		是	字段 id

返回值

属性	数据类型	说明
FieldId	String	对应列的 FieldId
IsAscending	Boolean	对应列是否升序

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  const fieldId = await app.ActiveDBSheet.Field.GetFieldId(1)

  // 通过 fieldId 获取排序条件
  const getConditionById = await app.ActiveDBSheet.Sort.GetConditionById(fieldId)
  console.log(getConditionById)
}

GetConditionsCount()

获取排序条件数量

语法

表达式.ActiveDBSheet.Sort.GetConditionsCount()

表达式：文档类型应用对象

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取排序条件数量
  const getConditionsCount = await app.ActiveDBSheet.Sort.GetConditionsCount()
  console.log(getConditionsCount)
}

SetAutoSort()

设置自动排序

语法

表达式.ActiveDBSheet.Sort.SetAutoSort({ IsAutoSort })

表达式：文档类型应用对象

参数

属性	数据类型	默认值	必填	说明
IsAutoSort	Boolean		是	true 自动，false 不自动

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 设置为自动排序
  await app.ActiveDBSheet.Sort.SetAutoSort({ IsAutoSort: true })
}

SetConditionPriority()

设置排序的优先级

语法

表达式.ActiveDBSheet.Sort.SetConditionPriority({ FieldIds })

表达式：文档类型应用对象

参数

属性	数据类型	默认值	必填	说明
FieldIds	Array.<Number>		是	索引清单，对应 DBSheet 中需要排序的列

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 设置排序的优先级
  await app.ActiveDBSheet.Sort.SetConditionPriority({
    FieldIds: [2, 1, 3] // 索引清单，对应 DBSheet 中需要排序的列
  })
}

SetIsAscending()

设置排序的升降序

语法

表达式.ActiveDBSheet.Sort.SetIsAscending({ Index, IsAscending })

表达式：文档类型应用对象

参数

属性	数据类型	默认值	必填	说明
Index	Number		是	索引 Index，对应 DBSheet 中的列
IsAscending	Boolean		是	true 为升序，false 为降序

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 设置排序的升降序
  const result = await app.ActiveDBSheet.Sort.SetIsAscending({
    Index: 1,
    IsAscending: true // true 为升序，false 为降序
  })
  console.log(result)
}