Class: CustomSlicerThemeManager

Sheets.Slicers.CustomSlicerThemeManager

Hierarchy

• CustomThemeManagerBase

  ↳ CustomSlicerThemeManager

Table of contents

Constructors

• constructor

Methods

• add
• all
• get
• remove
• update

Constructors

constructor

• new CustomSlicerThemeManager(workbook)

Represents a custom slicer theme manager that can manage all custom slicer themes.

Parameters

Overrides

CustomThemeManagerBase.constructor

Methods

add

▸ add(theme): undefined | SlicerStyle

add a new slicer theme.

example

// add a new slicer theme named "custom0"
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
let slicerStyle = spread.customSlicerThemes.add("custom0");
let wholeSlicerStyle = new GC.Spread.Sheets.Slicers.SlicerStyleInfo();
wholeSlicerStyle.backColor = "#0C66E4";
slicerStyle.wholeSlicerStyle(wholeSlicerStyle);

Parameters

Returns

undefined | SlicerStyle

return the newly added slicer theme, if the named slicer theme is existed, failed to add slicer theme and return undefined

all

▸ all(): SlicerStyle[]

get the slicer themes collection.

example

// get all slicer slicer themes
let slicerStylesCollection = spread.customSlicerThemes.all();

Returns

SlicerStyle[]

Array<GC.Spread.Sheets.Slicers.SlicerStyle>

get

▸ get(name): undefined | SlicerStyle

get the slicer theme by name.

example

// get slicer theme
slicerStyle = spread.customSlicerThemes.get("custom0");

Parameters

Returns

undefined | SlicerStyle

If the corresponding slicer theme with the spefic name is found, return the theme; otherwise, return undefined.

remove

▸ remove(name): void

remove the slicer theme by name.

example

// delete slicer theme
spread.customSlicerThemes.remove("custom0");

Parameters

Returns

void

update

▸ update(oldThemeName, newTheme): void

update the slicer theme.

example

// update slicer theme
slicerStyle = spread.customSlicerThemes.update("custom0", new GC.Spread.Sheets.Slicers.SlicerStyle());

Parameters

Returns

void