API 概览

Pivot 构造函数

new pivot.Pivot("#root", {
    // 配置参数
});

参数：

• HTML 容器（HTML 容器的 ID）
• 配置参数对象（请参阅此处）

Pivot 方法

名称	描述
getTable()	获取对 Pivot 表格中底层 Table widget 实例的访问权限
setConfig()	更新 Pivot widget 的当前配置
setLocale()	为 Pivot 应用新的语言环境
showConfigPanel()	显示或隐藏配置面板

Pivot 内部 API

Event Bus 方法

名称	描述
api.detach()	用于移除/解绑动作处理器
api.exec()	允许触发内部事件
api.intercept()	用于拦截并阻止内部事件
api.on()	允许为内部事件附加处理函数
api.setNext()	用于将某个操作添加到 Event Bus 的执行顺序中

状态方法

名称	描述
api.getReactiveState()	获取包含 Pivot 响应式属性的对象
api.getState()	获取包含 Pivot 的 StateStore 属性的对象
api.getStores()	获取包含 Pivot 的 DataStore 属性的对象

Pivot 事件

名称	描述
add-field	当新字段添加到行、列或值区域时触发
apply-filter	在筛选器被应用时触发
delete-field	移除字段时触发
move-field	当字段重新排序时触发
open-filter	当字段的过滤器被激活时触发
render-table	在处理完 widget 配置之后、渲染表格之前触发
show-config-panel	当配置面板的可见性发生变化时触发
update-config	通过 Pivot UI 修改行、列或聚合函数时触发
update-field	在更新字段时触发

Pivot 属性

名称	描述
columnShape	可选。配置 Pivot 列的外观和行为
config	可选。定义 Pivot 表格的结构以及数据的聚合方式
configPanel	可选。控制 UI 中配置面板的显示状态
data	可选。一个对象数组，包含 Pivot 表格的数据
fields	可选。包含 Pivot 表格字段对象的数组
headerShape	可选。配置 Pivot 表格中表头的外观与行为
limits	可选。定义最终数据集中行数和列数的最大限制
locale	可选。Pivot 自定义语言包对象
methods	可选。为数据聚合定义自定义数学方法
predicates	可选。为数据维度（行、列）提供自定义预处理函数
readonly	可选。启用/禁用只读模式
tableShape	可选。配置 Pivot 表格的外观