---
title: "SpotlightHandler | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/SpotlightHandler/"
---

# SpotlightHandler

> [`SpotlightHandler`](#spotlighthandler)

## Classes

### SpotlightHandler

#### Constructors

##### Constructor

```ts
new SpotlightHandler(handlerFactory): SpotlightHandler;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `handlerFactory` | [`HandlerFactoryByItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/HandlerFactoryByItem.md#handlerfactorybyitem) |

###### Returns

#### Methods

##### getSpotlightItems()

```ts
getSpotlightItems(): ISpotlightData[];
```

###### Returns

[`ISpotlightData`](#ispotlightdata)[]

##### hideSpotlight()

```ts
hideSpotlight(items?): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `items?` | `Item`[] |

###### Returns

`void`

##### showSpotlight()

```ts
showSpotlight(items, options): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `items` | `Item`[] |
| `options` | [`ISpotlightOptions`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ISpotlightOptions.md#ispotlightoptions) |

###### Returns

`void`

## Interfaces

### ISpotlightData

#### Properties

##### handler

```ts
handler: BaseRectangleItemHandler;
```

##### item

```ts
item: Item;
```

##### options

```ts
options: ISpotlightOptions;
```