Skip to content
Mog is in active development. The GitHub repo, SDK packages, and community channels are not yet available. Follow for launch updates

wb.slicerStyles

WorkbookSlicerStyles

9 methods

getDefault

Promise<string>
getDefault(): Promise<string>;

Get the workbook's default slicer style preset. Returns 'light1' if not explicitly set.

setDefault

Promise<void>
setDefault(style: string | null): Promise<void>;
ParameterTypeRequired
stylestring | nullrequired

Set the workbook's default slicer style preset. Pass null to reset to 'light1'.

getCount

Promise<number>
getCount(): Promise<number>;

Get the number of built-in slicer styles.

getItem

Promise<SlicerStyleInfo | null>
getItem(name: string): Promise<SlicerStyleInfo | null>;
ParameterTypeRequired
namestringrequired

Get a specific slicer style by name. Returns null if not found.

list

Promise<SlicerStyleInfo[]>
list(): Promise<SlicerStyleInfo[]>;

List all built-in slicer styles.

add

Promise<string>
add(name: string, style: SlicerCustomStyle, makeUniqueName?: boolean): Promise<string>;
ParameterTypeRequired
namestringrequired
styleSlicerCustomStylerequired
makeUniqueNamebooleanoptional

Add a new custom named slicer style. @param name - Desired style name. @param style - Custom style definition. @param makeUniqueName - When true, auto-appends a suffix if the name collides. Default: false. @returns The final name assigned to the style (may differ from `name` when `makeUniqueName` is true).

getItemOrNullObject

Promise<NamedSlicerStyle | null>
getItemOrNullObject(name: string): Promise<NamedSlicerStyle | null>;
ParameterTypeRequired
namestringrequired

Get a named slicer style by name, or null if not found. Null-safe lookup.

delete

Promise<void>
delete(name: string): Promise<void>;
ParameterTypeRequired
namestringrequired

Delete a custom named slicer style. @param name - The name of the style to delete.

duplicate

Promise<string>
duplicate(name: string): Promise<string>;
ParameterTypeRequired
namestringrequired

Duplicate an existing named slicer style. @param name - The name of the style to duplicate. @returns The name of the newly created copy.