Advanced Sort
Previous
Switcher
Next
Export
Loading...
The props
of the AdvancedSort
component
parameter | illustrate | type | required | Defaults |
---|---|---|---|---|
sheet | current table instance | SpreadSheet | ✓ | |
open | whether to display | boolean | ✓ | |
className | class class name | string | ||
icon | sort button icon | React.ReactNode | ||
text | sort button name | string | ||
ruleText | Rule description | string | ||
dimensions | list of optional fields | Dimension [] | ||
ruleOptions | Rule configuration list | RuleOption [] | ||
sortParams | There are already sort rules by default | SortParams | ||
onSortOpen | Callback for opening sort popup | () => void | ||
onSortConfirm | Callback for processing sorting results after closing the popup window | (ruleValues: RuleValue [] , sortParams: SortParams ) => void |
Configure the props
of advancedSort
in the header
parameter | illustrate | type | required | Defaults |
---|---|---|---|---|
open | whether to display | boolean | false | |
className | class class name | string | ||
icon | sort button icon | React.ReactNode | ||
text | sort button name | ReactNode | ||
ruleText | Rule description | string | ||
dimensions | list of optional fields | Dimension [] | ||
ruleOptions | Rule configuration list | RuleOption [] | ||
sortParams | There are already sort rules by default | SortParams | ||
onSortOpen | Callback for opening sort popup | () => void | ||
onSortConfirm | Callback for processing sorting results after closing the popup window | (ruleValues: RuleValue [] , sortParams: SortParams ) => void |
Optional field list, if not configured, the default is:行头+列头+数值
parameter | illustrate | type | Defaults | required |
---|---|---|---|---|
field | dimension id | string | ✓ | |
name | dimension name | string | ✓ | |
list | dimension list | string[] | ✓ |
Rule configuration list, if not configured, the default is:首字母、手动排序、其他字段
parameter | illustrate | type | Defaults | required |
---|---|---|---|---|
label | rule name | string | ✓ | |
value | rule value | `'sortMethod' | 'sortBy' | 'sortByMeasure'` |
children | rule sublist | RuleOption[] | ✓ |
The first parameter of the callback function that processes the sorting results after closing the pop-up window: the obtained sorting information
parameter | illustrate | type | Defaults | required |
---|---|---|---|---|
field | dimension id | string | ✓ | |
name | dimension name | string | ✓ | |
sortMethod | Sort By (Ascending/Descending) | ASC | DESC | asc | desc | ||
sortBy | custom sorted list | string[] | ||
sortByMeasure | kind | string |
In development, please look forward to