# GC.Spread.Sheets.Slicers.CustomSlicerThemeManager

## Content

# Class: CustomSlicerThemeManager

[Sheets](../modules/GC.Spread.Sheets).[Slicers](../modules/GC.Spread.Sheets.Slicers).CustomSlicerThemeManager

## Hierarchy

- [`CustomThemeManagerBase`](GC.Spread.Sheets.CustomThemeManagerBase)

  ↳ **`CustomSlicerThemeManager`**

## Table of contents

### Constructors

- [constructor](GC.Spread.Sheets.Slicers.CustomSlicerThemeManager#constructor)

### Methods

- [add](GC.Spread.Sheets.Slicers.CustomSlicerThemeManager#add)
- [all](GC.Spread.Sheets.Slicers.CustomSlicerThemeManager#all)
- [get](GC.Spread.Sheets.Slicers.CustomSlicerThemeManager#get)
- [remove](GC.Spread.Sheets.Slicers.CustomSlicerThemeManager#remove)
- [update](GC.Spread.Sheets.Slicers.CustomSlicerThemeManager#update)

## Constructors

### <a id="constructor" name="constructor"></a> constructor

• **new CustomSlicerThemeManager**(`workbook`)

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

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `workbook` | [`Workbook`](GC.Spread.Sheets.Workbook) | The workbook. |

#### Overrides

[CustomThemeManagerBase](GC.Spread.Sheets.CustomThemeManagerBase).[constructor](GC.Spread.Sheets.CustomThemeManagerBase#constructor)

## Methods

### <a id="add" name="add"></a> add

▸ **add**(`theme`): `undefined` \| [`SlicerStyle`](GC.Spread.Sheets.Slicers.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

| Name | Type | Description |
| :------ | :------ | :------ |
| `theme` | `string` \| [`SlicerStyle`](GC.Spread.Sheets.Slicers.SlicerStyle) | the new slicer theme or just a new slicer theme name you want to add |

#### Returns

`undefined` \| [`SlicerStyle`](GC.Spread.Sheets.Slicers.SlicerStyle)

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

___

### <a id="all" name="all"></a> all

▸ **all**(): [`SlicerStyle`](GC.Spread.Sheets.Slicers.SlicerStyle)[]

get the slicer themes collection.

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

#### Returns

[`SlicerStyle`](GC.Spread.Sheets.Slicers.SlicerStyle)[]

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

___

### <a id="get" name="get"></a> get

▸ **get**(`name`): `undefined` \| [`SlicerStyle`](GC.Spread.Sheets.Slicers.SlicerStyle)

get the slicer theme by name.

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

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `name` | `string` | the specific name of the slicer theme to get |

#### Returns

`undefined` \| [`SlicerStyle`](GC.Spread.Sheets.Slicers.SlicerStyle)

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

___

### <a id="remove" name="remove"></a> remove

▸ **remove**(`name`): `void`

remove the slicer theme by name.

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

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `name` | `string` | the specific name of the slicer theme to remove |

#### Returns

`void`

___

### <a id="update" name="update"></a> 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

| Name | Type | Description |
| :------ | :------ | :------ |
| `oldThemeName` | `string` | the specific name of the slicer theme to update |
| `newTheme` | [`SlicerStyle`](GC.Spread.Sheets.Slicers.SlicerStyle) | the specific name of the slicer theme to update |

#### Returns

`void`