Class: PivotPanel

Spread.Pivot.PivotPanel

Table of contents

Constructors

• constructor

Methods

• attach
• destroy
• detach
• panelLayout
• sectionVisibility
• findControl

Constructors

constructor

• new PivotPanel(name, pivotTable, host)

Represents the pivot panel of pivot table.

example

//This example creates a pivot panel.
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
var sourceSheet = spread.getSheet(0);
var sheet = spread.getSheet(1);
var sourceData = [["Date","Buyer","Type","Amount"],
                  ["01-Jan","Mom","Fuel",74],
                  ["15-Jan","Mom","Food",235],
                  ["17-Jan","Dad","Sports",20],
                  ["21-Jan","Kelly","Books",125]];
sourceSheet.setArray(0, 0, sourceData );
sourceSheet.tables.add('sourceData', 0, 0, 5, 4);
var layout = GC.Spread.Pivot.PivotTableLayoutType.compact;
var theme = GC.Spread.Pivot.PivotTableThemes.medium2;
var options = {showRowHeader: true, showColumnHeader: true};
var pivotTable = sheet.pivotTables.add("pivotTable_1", 'sourceData', 1, 1, layout, theme, options);
pivotTable.suspendLayout();
pivotTable.options.showRowHeader =true;
pivotTable.options.showColumnHeader =true;
pivotTable.add("Buyer", "Buyer", GC.Spread.Pivot.PivotTableFieldType.columnField);
pivotTable.add("Type", "Type", GC.Spread.Pivot.PivotTableFieldType.rowField);
pivotTable.add("Amount", "Sum of Amount",   GC.Spread.Pivot.PivotTableFieldType.valueField, GC.Pivot.SubtotalType.sum);
var panel = new GC.Spread.Pivot.PivotPanel("myPivotPanel", pivotTable, document.getElementById("panel"));
pivotTable.resumeLayout();

Parameters

Methods

attach

▸ attach(pivotTable): any

description attach to a pivot table for pivot panel, then the pivot panel can control the bound pivot table.

Parameters

Returns

any

void

destroy

▸ destroy(): any

description destroy the PivotPanel.

Returns

any

detach

▸ detach(): void

description detach the pivot table for pivot panel, stop the pivot panel control bound pivot table.

Returns

void

void

panelLayout

▸ panelLayout(value?): void | PivotPanelLayoutType

description set or get the panelLayout type.

Parameters

Returns

void | PivotPanelLayoutType

GC.Spread.Pivot.PivotPanelLayoutType | void

sectionVisibility

▸ sectionVisibility(value?): number | void

description get or set which sections are visible.

example

 var visibility = pivotPanel.sectionVisibility() // 7;
 visibility = visibility & ~GC.Spread.Pivot.PivotPanelSection.viewList; // 3
 pivotPanel.sectionVisibility(visibility);

Parameters

Returns

number | void

The visibility value.

findControl

▸ Static findControl(host): PivotPanel

Gets the PivotPanel instance by the host element.

example

var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
var sourceSheet = spread.getSheet(0)
var sheet = spread.getSheet(1);
var sourceData = [["Date","Buyer","Type","Amount"],
                 ["01-Jan","Mom","Fuel",74],
                 ["15-Jan","Mom","Food",235],
                 ["17-Jan","Dad","Sports",20],
                 ["21-Jan","Kelly","Books",125]];
sourceSheet.setArray(0, 0, sourceData);
sourceSheet.tables.add('sourceData', 0, 0, 5, 4);
var layout = GC.Spread.Pivot.PivotTableLayoutType.compact;
var theme = GC.Spread.Pivot.PivotTableThemes.medium2;
var options = {showRowHeader: true, showColumnHeader: true};
sheet.pivotTables.add("pivotTable_1", 'sourceData', 1, 1, layout, theme, options);
var pivotTable = sheet.pivotTables.get("pivotTable_1");
var panel = new GC.Spread.Pivot.PivotPanel("sourceData", pivotTable, document.getElementById("pivotPanel"));
var pivotPanel = GC.Spread.Pivot.PivotPanel.findControl("pivotPanel");

Parameters

Returns

PivotPanel

The PivotPanel instance.