Namespace: Pivot

GC.Spread.Pivot

Table of contents

Namespaces

• PivotTable

Enumerations

• CalcItemAggregation
• DisplayFields
• GrandTotalPosition
• PivotAreaAxisType
• PivotAreaReference
• PivotAreaType
• PivotPanelLayoutType
• PivotPanelSection
• PivotTableFieldType
• PivotTableLayoutType
• SubtotalsPosition

Classes

• CustomPivotTableThemeManager
• PivotPanel
• PivotTable
• PivotTableItemSlicer
• PivotTableStyle
• PivotTableTheme
• PivotTableThemes
• PivotTableTimelineSlicer

Interfaces

• IPivotItemInfo
• IPivotTableViewManager

Type aliases

• ICalcFieldInfo
• ICalcItemInfo
• IDateGroupInfo
• IDateGroupsInfo
• IFieldInfo
• INumberGroupInfo
• IPivotArea
• IPivotAreaOffset
• IPivotAreasCollection
• IPivotConditionFilterInfo
• IPivotNodeInfo
• IPivotOverwriteNodeInfo
• IPivotReference
• IPivotShowDataAsInfo
• IPivotStyle
• IPivotTableOption
• IPivotTablePosition
• IPivotTableRange
• IPivotTableView
• IPivotTextFilterInfo
• ISerializeFieldInfo
• ISerializeInfo
• ISerializeShowDataAsInfo
• ISourceFieldInfo
• ITextCollectionCondition
• ITextGroupInfo

Type aliases

ICalcFieldInfo

Ƭ ICalcFieldInfo: Object

property fieldName 计算字段的字段名

property formula 计算字段的公式

Type declaration

Name	Type
fieldName	string
formula	string

---

ICalcItemInfo

Ƭ ICalcItemInfo: Object

property sourceName 数据透视表源字段名称

property calcItemName 数据透视表源字段计算项名称

property formula 数据透视表源字段计算项公式

property priority 数据透视表源字段计算项优先级

Type declaration

Name	Type
calcItemName	string
formula	string
priority	number
sourceName	string

---

IDateGroupInfo

Ƭ IDateGroupInfo: Object

property by 日期分组信息的日期单位

property [start] 分组的开始日期（可选）

property [end] 分组的结束日期（可选）

Type declaration

Name	Type
by	DateGroupType
end?	Date
start?	Date

---

IDateGroupsInfo

Ƭ IDateGroupsInfo: Object

property originFieldName 源字段名称

property {GC.Spread.Pivot.IDateGroupInfo[]} dateGroups 日期分组信息数组

Type declaration

Name	Type
dateGroups	IDateGroupInfo[]
originFieldName	string

---

IFieldInfo

Ƭ IFieldInfo: Object

property fieldName 字段名称

property sourceName 源名称

property dataType 字段对应的源数据类型

property pivotArea 字段类型，影响字段在不同区域的表现

property pivotIndex 字段在区域中的索引

property {Date|number} [start] 数值型数据字段的最小值或日期型字段的最早日期（可选）

property {Date|number} [end] 数值型数据字段的最大值或日期型字段的最新日期（可选）

Type declaration

Name	Type
dataType	PivotDataType
end?	Date | number
fieldName	string
pivotArea	PivotTableFieldType
pivotIndex	number
sourceName	string
start?	Date | number

---

INumberGroupInfo

Ƭ INumberGroupInfo: Object

property originFieldName 源字段名称

property numberGroup 数值分组信息

property [numberGroup.start] 数值分组的起始值（可选）

property [numberGroup.end] 数值分组的结束值（可选）

property numberGroup.by 数值分组的步长

Type declaration

Name	Type
numberGroup	{ by: number ; end?: number ; start?: number }
numberGroup.by	number
numberGroup.end?	number
numberGroup.start?	number
originFieldName	string

---

IPivotArea

Ƭ IPivotArea: Object

property [type]

property [fieldName]

property [labelOnly]

property [dataOnly]

property [grandRow]

property [grandCol]

property {GC.Spread.Pivot.IPivotReference[]} [references]

property [offset]

Type declaration

Name	Type
dataOnly?	boolean
fieldName?	string
grandCol?	boolean
grandRow?	boolean
labelOnly?	boolean
references?	IPivotReference[]
type?	PivotAreaType

---

IPivotAreaOffset

Ƭ IPivotAreaOffset: Object

property row

property col

property [rowCount]

property [colCount]

Type declaration

Name	Type
col	number
colCount?	number
row	number
rowCount?	number

---

IPivotAreasCollection

Ƭ IPivotAreasCollection: Object

property {Object.<string, GC.Spread.Pivot.IPivotArea[]>} - key 表示透视表名称，value 表示选中的透视表区域。

Index signature

▪ [pivotTableName: string]: IPivotArea[]

---

IPivotConditionFilterInfo

Ƭ IPivotConditionFilterInfo: Object

property conditionByName

property {GC.Pivot.IPivotCaptionConditionFilterInfo | GC.Pivot.IPivotDateConditionFilterInfo | GC.Pivot.IPivotTop10ConditionFilterInfo | GC.Pivot.IPivotValueConditionInfo} condition

Type declaration

Name	Type
condition	IPivotCaptionConditionFilterInfo | IPivotDateConditionFilterInfo | IPivotTop10ConditionFilterInfo | IPivotValueConditionInfo
conditionByName	string

---

IPivotNodeInfo

Ƭ IPivotNodeInfo: Object

property {GC.Spread.Pivot.IPivotItemInfo[]} fieldInfos 节点的标签字段信息。

property valueInfo 节点的值字段信息。

Type declaration

Name	Type
fieldInfos	IPivotItemInfo[]
valueInfo	IValueInfo

---

IPivotOverwriteNodeInfo

Ƭ IPivotOverwriteNodeInfo: Object

property {GC.Spread.Pivot.IPivotItemInfo[]} fieldInfos 节点的标签字段信息。

property valueInfo 节点的值字段信息。

property value 节点的值。

Type declaration

Name	Type
fieldInfos	IPivotItemInfo[]
value	number
valueInfo	IValueInfo

---

IPivotReference

Ƭ IPivotReference: Object

property fieldName

property [subtotal]

property {string[]} [items]

Type declaration

Name	Type
fieldName	string
items?	string[]
subtotal?	boolean

---

IPivotShowDataAsInfo

Ƭ IPivotShowDataAsInfo: Object

property baseFieldName

property baseFieldItemType

property baseFieldItem

Type declaration

Name	Type
baseFieldItem?	string
baseFieldItemType?	PivotShowDataAsBaseItemType
baseFieldName?	string
showDataAs	PivotShowDataAs

---

IPivotStyle

Ƭ IPivotStyle: Object

property pivotArea 透视表中的透视表区域。

property style 用于透视表区域的样式。

Type declaration

Name	Type
pivotArea?	IPivotArea
style?	Style

---

IPivotTableOption

Ƭ IPivotTableOption: Object

property [allowMultipleFiltersPerField]

property [fillDownLabels]

property [insertBlankLineAfterEachItem]

property grandTotalPosition

property subtotalsPosition

property displayFieldsInPageFilterArea

property reportFilterFieldsPerColumn

property [bandRows]

property [bandColumns]

property [showRowHeader]

property [showColumnHeader]

property [showDrill]

property [showMissing]

property {string | number} missingCaption

property rowLabelIndent

property [printDrill]

property [itemPrintTitles]

property [fieldPrintTitles]

property [showFilter]

property [showToolTip]

property [mergeItem]

property [isShowErrorValue]

property [errorValueInfo]

property [rowHeaderCaption]

property [colHeaderCaption]

property [showHeaders]

property [calcItemAggregation]

property [enableDataValueEditing]

Type declaration

Name	Type
allowMultipleFiltersPerField?	boolean
bandColumns?	boolean
bandRows?	boolean
calcItemAggregation?	CalcItemAggregation
colHeaderCaption?	string
displayFieldsInPageFilterArea?	DisplayFields
enableDataValueEditing?	boolean
errorValueInfo?	string
fieldPrintTitles?	boolean
fillDownLabels?	boolean
grandTotalPosition?	GrandTotalPosition
insertBlankLineAfterEachItem?	boolean
isShowErrorValue?	boolean
itemPrintTitles?	boolean
mergeItem?	boolean
missingCaption?	string | number
printDrill?	boolean
reportFilterFieldsPerColumn?	number
rowHeaderCaption?	string
rowLabelIndent?	number
showColumnHeader?	boolean
showDrill?	boolean
showFilter?	boolean
showHeaders?	boolean
showMissing?	boolean
showRowHeader?	boolean
showToolTip?	boolean
subtotalsPosition?	SubtotalsPosition

---

IPivotTablePosition

Ƭ IPivotTablePosition: Object

property row 表示透视表开始的行

property col 表示透视表开始的列

property [sheetName] 表示透视表所在的sheet

Type declaration

Name	Type
col	number
row	number
sheetName?	string

---

IPivotTableRange

Ƭ IPivotTableRange: Object

property page 表示透视表的过滤区域范围

property content 表示透视表的内容区域范围

Type declaration

Name	Type
content	Range
page	Range

---

IPivotTableView

Ƭ IPivotTableView: Object

property name

property config

Type declaration

Name	Type
config	ISerializeInfo
name	string

---

IPivotTextFilterInfo

Ƭ IPivotTextFilterInfo: Object

property textItem

Type declaration

Name	Type
textItem	ITextCollectionCondition

---

ISerializeFieldInfo

Ƭ ISerializeFieldInfo: Object

property conditionBySourceName

property displayName

property [subtotal]

property {GC.Spread.Pivot.IPivotTextFilterInfo | GC.Spread.Pivot.IPivotConditionFilterInfo} [labelFilter]

property [valueFilter]

property [sortInfo]

Type declaration

Name	Type
displayName	string
labelFilter?	IPivotTextFilterInfo | IPivotConditionFilterInfo
sortInfo?	IPivotViewSortInfo
sourceName	string
subtotal?	SubtotalType
valueFilter?	IPivotConditionFilterInfo

---

ISerializeInfo

Ƭ ISerializeInfo: Object

property [layoutType]

property [options] 透视表的选项

property [theme] 透视表的主题

property [valuePosition] 透视表的值位置信息

property {number[]} [pivotTablePosition] 透视表的位置

property {GC.Spread.Pivot.ISerializeFieldInfo[][]} [fieldsInfo] 透视表的字段信息

property [styles] 透视表的区域样式

property [collapseItems] 透视表的折叠信息

property {GC.Spread.Pivot.ISerializeShowDataAsInfo[]} [showDataAsList] 透视表的显示数据信息

Type declaration

Name	Type
collapseItems?	object
fieldsInfo?	ISerializeFieldInfo[][]
layoutType?	PivotTableLayoutType
options?	object
pivotTablePosition?	number[]
showDataAsList?	ISerializeShowDataAsInfo[]
showNoDataInfo?	object
styles?	IPivotStyle[]
theme?	string
valuePosition?	IDataPosition

---

ISerializeShowDataAsInfo

Ƭ ISerializeShowDataAsInfo: Object

property valueFieldName

property showDataAsInfo

Type declaration

Name	Type
showDataAsInfo	IPivotShowDataAsInfo
valueFieldName	string

---

ISourceFieldInfo

Ƭ ISourceFieldInfo: Object

property name 源字段的名称

property [fieldType] 透视表字段类型是计算字段还是分组字段

Type declaration

Name	Type
fieldType?	PivotSourceFieldType
name	string

---

ITextCollectionCondition

Ƭ ITextCollectionCondition: Object

property {string[]} list

property isAll

Type declaration

Name	Type
isAll	boolean
list	string[]

---

ITextGroupInfo

Ƭ ITextGroupInfo: Object

property originFieldName 源字段的名称。

property textGroup 文本组信息

property textGroup.fieldName 组字段的名称。

property textGroup.groupItems 文本组项信息。

Type declaration

Name	Type
originFieldName	string
textGroup	{ fieldName: string ; groupItems: IStringGroupItems }
textGroup.fieldName	string
textGroup.groupItems	IStringGroupItems