ws.slicers

add(config: SlicerConfig): Promise<string>;

Create a new slicer on this worksheet. @param config - Slicer configuration (table, column, position) @returns The ID of the created slicer

remove(slicerId: string): Promise<void>;

Remove a slicer from this worksheet. @param slicerId - ID of the slicer to remove

list(): Promise<SlicerInfo[]>;

List all slicers on this worksheet. @returns Array of slicer summary information

get(slicerId: string): Promise<Slicer | null>;

Get a slicer by ID, including full state. @param slicerId - ID of the slicer @returns Full slicer state, or null if not found

getItemAt(index: number): Promise<SlicerInfo | null>;

Get a slicer by its zero-based index in the list. @param index - Zero-based index of the slicer @returns Slicer summary information, or null if index is out of range

getItems(slicerId: string): Promise<SlicerItem[]>;

Get the items (values) available in a slicer. @param slicerId - ID of the slicer @returns Array of slicer items with selection state

getItem(slicerId: string, key: CellValue): Promise<SlicerItem>;

Get a slicer item by its string key. @param slicerId - ID of the slicer @param key - The value to look up (matched via string coercion) @returns The matching slicer item @throws KernelError if no item matches the key

getItemOrNullObject(slicerId: string, key: CellValue): Promise<SlicerItem | null>;

Get a slicer item by its string key, or null if not found. @param slicerId - ID of the slicer @param key - The value to look up (matched via string coercion) @returns The matching slicer item, or null if not found

setSelection(slicerId: string, selectedItems: CellValue[]): Promise<void>;

Set the selected items in a slicer, replacing any existing selection. @param slicerId - ID of the slicer @param selectedItems - Array of values to select

clearSelection(slicerId: string): Promise<void>;

Clear all selections in a slicer (show all items). @param slicerId - ID of the slicer

duplicate(slicerId: string, offset?: { x?: number; y?: number }): Promise<string>;

Duplicate a slicer with an optional position offset. @param slicerId - ID of the slicer to duplicate @param offset - Position offset in pixels (defaults to { x: 20, y: 20 }) @returns The ID of the newly created slicer

updateConfig(slicerId: string, updates: Partial<SlicerConfig>): Promise<void>;

Update a slicer's configuration. @param slicerId - ID of the slicer @param updates - Partial configuration updates

getState(slicerId: string): Promise<SlicerState>;

Get the enriched runtime state of a slicer. @param slicerId - ID of the slicer @returns Enriched slicer state including computed items and connection status