Skip to content

排序

Sort

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

Sort 对象,表示排序相关

语法

表达式.ActiveDBSheet.Sort

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

示例

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

  const app = instance.Application

  // Sort 对象,表示排序相关
  const Sort = await app.ActiveDBSheet.Sort
}

AddSort()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

设置自动排序

语法

表达式.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()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

删除排序条件

语法

表达式.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()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

通过索引获取排序条件

语法

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

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

参数

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

返回值

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

示例

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

  const app = instance.Application

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

GetConditionById()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

通过 fieldID 获取排序条件

语法

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

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

参数

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

返回值

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

示例

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

  const app = instance.Application

  // 通过 fieldID 获取排序条件
  await app.ActiveDBSheet.Sort.GetConditionById({
    Index: 1 // 索引
  })
}

SetIsAscending()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

获取排序条件数据

语法

表达式.ActiveDBSheet.Sort.SetIsAscending()

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

返回值

返回 Number 表示排序条件数据

示例

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

  const app = instance.Application

  // 获取排序条件数据
  const info = await app.ActiveDBSheet.Sort.SetIsAscending()
  console.log(info)
}

SetAutoSort()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

设置自动排序

语法

表达式.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()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

设置排序的优先级

图

语法

表达式.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()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

设置排序的升降序

语法

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

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

参数

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

示例

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

  const app = instance.Application

  // 设置排序的升降序
  await app.ActiveDBSheet.Sort.SetIsAscending({
    Index: 2, // 索引 Index,对应 DBSheet 中的列
    IsAscending: false // 升序、降序,true 为升序,false 为降序
  })
}