logo

S2

  • Manual
  • API
  • Examples
  • Playground
  • ChangeLog
  • Productsantv logo arrow
  • 2.x
  • Common Configuration
    • S2DataConfig
    • S2Options
      Updated
    • S2Theme
      Updated
    • S2Event
  • Basic Class
    • SpreadSheet
    • Interaction
      Updated
    • Store
    • BaseCell
      Updated
    • BaseDataSet
    • Node
    • BaseTooltip
    • BaseFacet
      Updated
    • Hierarchy
      New
    • BaseBBox
      New
    • CellData
      New
  • Components
    • table component
    • DrillDown
    • Switcher
    • Advanced Sort
    • Export
      Updated
  • Graphic style
  • 透视组合图拓展 S2Options

Advanced Sort

Previous
Switcher
Next
Export

Resources

Ant Design
Galacea Effects
Umi-React Application Framework
Dumi-Component doc generator
ahooks-React Hooks Library

Community

Ant Financial Experience Tech
seeconfSEE Conf-Experience Tech Conference

Help

GitHub
StackOverflow

more productsMore Productions

Ant DesignAnt Design-Enterprise UI design language
yuqueYuque-Knowledge creation and Sharing tool
EggEgg-Enterprise-class Node development framework
kitchenKitchen-Sketch Tool set
GalaceanGalacean-互动图形解决方案
xtechLiven Experience technology
© Copyright 2025 Ant Group Co., Ltd..备案号:京ICP备15032932号-38

Loading...

React Advanced Sorting Component

AdvancedSortProps

The props of the AdvancedSort component

parameterillustratetyperequiredDefaults
sheetcurrent table instanceSpreadSheet✓
openwhether to displayboolean✓
classNameclass class namestring
iconsort button iconReact.ReactNode
textsort button namestring
ruleTextRule descriptionstring
dimensionslist of optional fieldsDimension []
ruleOptionsRule configuration listRuleOption []
sortParamsThere are already sort rules by defaultSortParams
onSortOpenCallback for opening sort popup() => void
onSortConfirmCallback for processing sorting results after closing the popup window(ruleValues: RuleValue [] , sortParams: SortParams ) => void

AdvancedSortCfgProps

Configure the props of advancedSort in the header

parameterillustratetyperequiredDefaults
openwhether to displaybooleanfalse
classNameclass class namestring
iconsort button iconReact.ReactNode
textsort button nameReactNode
ruleTextRule descriptionstring
dimensionslist of optional fieldsDimension []
ruleOptionsRule configuration listRuleOption []
sortParamsThere are already sort rules by defaultSortParams
onSortOpenCallback for opening sort popup() => void
onSortConfirmCallback for processing sorting results after closing the popup window(ruleValues: RuleValue [] , sortParams: SortParams ) => void

Dimension

Optional field list, if not configured, the default is:行头+列头+数值

parameterillustratetypeDefaultsrequired
fielddimension idstring✓
namedimension namestring✓
listdimension liststring[]✓

RuleOption

Rule configuration list, if not configured, the default is:首字母、手动排序、其他字段

parameterillustratetypeDefaultsrequired
labelrule namestring✓
valuerule value`'sortMethod''sortBy''sortByMeasure'`
childrenrule sublistRuleOption[]✓

RuleValue

The first parameter of the callback function that processes the sorting results after closing the pop-up window: the obtained sorting information

parameterillustratetypeDefaultsrequired
fielddimension idstring✓
namedimension namestring✓
sortMethodSort By (Ascending/Descending)ASC | DESC | asc | desc
sortBycustom sorted liststring[]
sortByMeasurekindstring

Vue Advanced Sorting Component

In development, please look forward to