[]
        
(Showing Draft Content)

GC.Spread.Pivot.PivotTableTheme

Class: PivotTableTheme

Spread.Pivot.PivotTableTheme

Table of contents

Constructors

Methods

Constructors

constructor

new PivotTableTheme()

Represents a PivotTableTheme class.

Methods

blankRowStyle

blankRowStyle(value?): any

description get or set the blankRowStyle of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


columnSubheading1Style

columnSubheading1Style(value?): any

description get or set the columnSubheading1Style of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


columnSubheading2Style

columnSubheading2Style(value?): any

description get or set the columnSubheading2Style of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


columnSubheading3Style

columnSubheading3Style(value?): any

description get or set the columnSubheading3Style of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


firstColumnStripSize

firstColumnStripSize(value?): any

description get or set the firstColumnStripSize of pivot table theme

Parameters

Name Type
value? number

Returns

any

If no value is set, returns the size of the size of the first alternating column; otherwise, returns the pivot table theme.


firstColumnStripeStyle

firstColumnStripeStyle(value?): any

description get or set the firstColumnStripeStyle of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


firstColumnStyle

firstColumnStyle(value?): any

description get or set the firstColumnStyle of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


firstHeaderCellStyle

firstHeaderCellStyle(value?): any

description get or set the firstHeaderCellStyle of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


firstRowStripSize

firstRowStripSize(value?): any

description get or set the firstRowStripSize of pivot table theme

Parameters

Name Type
value? number

Returns

any

If no value is set, returns the size of the first alternating row; otherwise, returns the pivot table theme.


firstRowStripeStyle

firstRowStripeStyle(value?): any

description get or set the firstRowStripeStyle of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


fromJSON

fromJSON(data): void

Loads the object state from the specified JSON string.

example

//This example uses the fromJSON method.
const light1 = GC.Spread.Pivot.PivotTableThemes.light1;
//export
const jsonStr = JSON.stringify(light1.toJSON());
//import
const newTheme = new GC.Spread.Pivot.PivotTableTheme();
newTheme.fromJSON(JSON.parse(jsonStr));
newTheme.name('custom1');
alert(jsonStr);

Parameters

Name Type Description
data Object The pivot table theme data from deserialization.

Returns

void


grandTotalColumnStyle

grandTotalColumnStyle(value?): any

description get or set the grandTotalColumnStyle of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


grandTotalRowStyle

grandTotalRowStyle(value?): any

description get or set the grandTotalRowStyle of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


headerRowStyle

headerRowStyle(value?): any

description get or set the headerRowStyle of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


name

name(value?): any

description get or set the name of pivot table theme

Parameters

Name Type
value? string

Returns

any

If no value is set, returns the name of the style; otherwise, returns the table theme.


reportFilterLabelsStyle

reportFilterLabelsStyle(value?): any

description get or set the reportFilterLabelsStyle of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


reportFilterValuesStyle

reportFilterValuesStyle(value?): any

description get or set the reportFilterValuesStyle of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


rowSubheading1Style

rowSubheading1Style(value?): any

description get or set the rowSubheading1Style of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


rowSubheading2Style

rowSubheading2Style(value?): any

description get or set the rowSubheading2Style of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


rowSubheading3Style

rowSubheading3Style(value?): any

description get or set the rowSubheading3Style of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


secondColumnStripSize

secondColumnStripSize(value?): any

description get or set the secondColumnStripSize of pivot table theme

Parameters

Name Type
value? number

Returns

any

If no value is set, returns the size of the second alternating column; otherwise, returns the pivot table theme.


secondColumnStripeStyle

secondColumnStripeStyle(value?): any

description get or set the secondColumnStripeStyle of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


secondRowStripSize

secondRowStripSize(value?): any

description get or set the secondRowStripSize of pivot table theme

Parameters

Name Type
value? number

Returns

any

If no value is set, returns the size of the second alternating row; otherwise, returns the pivot table theme.


secondRowStripeStyle

secondRowStripeStyle(value?): any

description get or set the secondRowStripeStyle of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


subtotalColumn1Style

subtotalColumn1Style(value?): any

description get or set the subtotalColumn1Style of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


subtotalColumn2Style

subtotalColumn2Style(value?): any

description get or set the subtotalColumn2Style of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


subtotalColumn3Style

subtotalColumn3Style(value?): any

description get or set the subtotalColumn3Style of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


subtotalRow1Style

subtotalRow1Style(value?): any

description get or set the subtotalRow1Style of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


subtotalRow2Style

subtotalRow2Style(value?): any

description get or set the subtotalRow2Style of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


subtotalRow3Style

subtotalRow3Style(value?): any

description get or set the subtotalRow3Style of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.


toJSON

toJSON(): Object

Saves the object state to a JSON string.

example

//This example uses the toJSON method.
const light1 = GC.Spread.Pivot.PivotTableThemes.light1;
//export
const jsonStr = JSON.stringify(light1.toJSON());
//import
const newTheme = new GC.Spread.Pivot.PivotTableTheme();
newTheme.fromJSON(JSON.parse(jsonStr));
newTheme.name('custom1');
alert(jsonStr);

Returns

Object

The pivot table theme data.


wholeTableStyle

wholeTableStyle(value?): any

description get or set the wholeTableStyle of pivot table theme

Parameters

Name Type
value? PivotTableStyle

Returns

any

If no value is set, returns the default style of the data area; otherwise, returns the pivot table theme.