S2

简介

组内排序 代表只影响一个分组内部的排序，例如下图中 笔-价格 选择 组内升序 时，省份 的排序方式不会更改，只会更改每个 省份 内部 城市 的顺序。

注意

行头/列头 只存在单一状态，当前状态会覆盖前一状态，如上图所示，当对 笔 进行排序时，纸张 的排序状态消失，行头 + 列头 可同时存在自身状态。

group-sort

在 `@antv/s2` 中使用

@antv/s2 提供组内排序的能力（对于明细表来说即全局排序)，可以自行实现 Tooltip 排序菜单后 (查看示例)，然后调用相关 API.

const meta = cell.getMeta()

// 升序
s2.groupSortByMethod('asc', meta)

// 降序
s2.groupSortByMethod('desc', meta)

// 不排序
s2.groupSortByMethod('none', meta)

监听排序事件

s2.on(S2Event.RANGE_SORT, (sortParams) => {
  console.log('sortParams:', sortParams)
});

示例 1: 点击列头自定义排序菜单

示例 2: 点击列头排序 icon 自定义排序菜单 (了解更多)

在 `@antv/s2-react` 中使用

@antv/s2-react 基于 @antv/s2 的基础排序能力，搭配任意菜单组件（如 antd 的 Menu 组件）, 提供了默认的组内排序功能，排序菜单通过 Tooltip 承载（开启 tooltip 即可），主要根据数值对 行头/列头 进行排序，查看更多排序示例

使用 @antv/s2-react 的组件 SheetComponent 默认在数值头显示 icon ，点击后选择，有 升序、降序、不排序 三种方式，可在 options 中配置显示，如下：

INFO

在 2.0 版本后，内部排序菜单和操作项依赖的 antd Menu 组件移除，现在需要通过 render 显式声明 UI 组件，最终效果相同，默认提供菜单配置 (props), 可以根据项目中实际使用的 antd@v4 或 antd@v5 不同版本进行调整。

import { Menu } from 'antd'

const s2Options = {
  width: 600,
  height: 600,
  // 打开操作 icon（默认开启）
  showDefaultHeaderActionIcon: true,
  // 展示 tooltip（默认开启）
  tooltip: {
    operation: {
      // 开启组内排序 （默认开启）
      sort: true,
      menu: {
        render: (props) => {
          return <Menu {...props} />;
        },
      }
    },
  },
};

监听排序事件

function onRangeSort(sortParams) {
  console.log('sortParams:', sortParams);
}

<SheetComponents onRangeSort={onRangeSort} />