初探PivotTable.js(二)
PivotTable.js的参数
PivotTable主要有两个调用函数:pivot() 和pivotUI() ,注意,这两个函数接收的参数并不完全一样。
pivot() 的参数:input [,options [,locale]]
pivot()可以在input对象中根据options选项生成一个html表格。
- input:包含对象的数组、包含数组的数组、jquery的dom对象、或者function。
- locale:本地化语言包配置。
- options:配置项,具体如下。
key | 类型 | 默认值 | 描述 |
rows | [ "string" ] | [] | 设置为行的字段 |
cols | [ "string" ] | [] | 设置为列的字段 |
aggregator | function | $.pivotUtilities .aggregators["Count"]() | 总计的计算方法 |
aggregatorName | string | "Count" | 总计的名称 |
renderer | function | table() | 生成表格的方法 |
rowOrder | string | "key_a_to_z" | 行的排列方式: "key_a_to_z"、 "value_a_to_z"、 "value_z_to_a" |
colOrder | string | "key_a_to_z" | 列的排列方式,同上。 |
derivedAttributes | object of functions | {} | 派生属性 |
dataClass | function | $.pivotUtilities.PivotData | 不祥,待完善 |
filter | function | function(){return true;} | 自定义的过滤方法 |
sorters | object or function | {} | 自定义排序名称和排序方式 |
rendererOptions | object | {} | 渲染表格配置 |
localeStrings | string | en |
本地化(语言包)配置 |
pivotUI() 的参数:input [,options [,overwrite [,locale]]]
- input:同上。
- locale:同上。
- overwrite:布尔值,控制数据更新时UI状态是否改变,true-覆盖当前状态,false-UI状态保持不变,默认false。
- options:配置项,具体如下。
key | 类型 | 默认值 | 描述 |
rows | array of strings | [] | 同上 |
cols | array of strings | [] | 同上 |
vals | array of strings | [] | 值区域中预先填充的字段 |
aggregators | object of functions | $.pivotUtilities.aggregators | 同上 |
aggregatorName | string | aggregators的第一个key |
同上 |
renderers | object of functions | $.pivotUtilities.renderers | 表格渲染方法的集合 |
rendererName | string | renderers的第一个key | 渲染选项的下拉列表 |
rowOrder | string | "key_a_to_z" | 同上 |
colOrder | string | "key_a_to_z" | 同上 |
derivedAttributes | object of functions | {} | 同上 |
dataClass | function | $.pivotUtilities.PivotData | 不详,待完善 |
filter | function | function(){return true;} | 同上 |
inclusions | object of arrays of strings | {} | 不详,待完善 |
exclusions | object of arrays of strings | {} | 不详,待完善 |
hiddenAttributes | array of strings | [] | 忽略的字段 |
hiddenFromAggregators | array of strings | [] | 忽略的总计的计算方法 |
hiddenFromDragDrop | array of strings | [] | 拖拽时的忽略的字段 |
sorters | object or function | {} | 同上 |
onRefresh | function | function(){} | UI更新时触发的方法 |
menuLimit | integer | 50 | 双击菜单的最大菜单数量 |
autoSortUnusedAttrs | boolean | false | 是否在UI中保留未使用的属性 |
unusedAttrsVertical | boolean or integer | 85 | 垂直显示/水平显示 |
showUI | boolean | true | 控制是否显示拖放UI |
rendererOptions | object | {} | 同上 |
localeStrings | object | en | 同上 |