# ColourPickerOptions

Canonical page: https://www.adaptabletools.com/docs/reference/colourpickeroptions

Options for the Colour Picker.

```ts title="TypeScript"
export interface ColourPickerOptions 
```

## Properties

| Property | Type | Description | Default |
| --- | --- | --- | --- |
| [filterColours](https://www.adaptabletools.com/docs/reference/colourpickeroptions.md#filtercolours) | `(context: `[`ColourPickerFilterContext`](https://www.adaptabletools.com/docs/reference/colourpickerfiltercontext.md)`) => `[`ColourPickerFilterResult`](https://www.adaptabletools.com/docs/reference/colourpickerfilterresult.md)` \| void` | Chooses which of the supplied colours (theme & colour palette) the Palette tab shows |   |
| [orderPaletteColours](https://www.adaptabletools.com/docs/reference/colourpickeroptions.md#orderpalettecolours) | `boolean` | Orders Palette swatches around the colour wheel; if `false`, each colour stays the order supplied | true |
| [removeDuplicates](https://www.adaptabletools.com/docs/reference/colourpickeroptions.md#removeduplicates) | `boolean` | Leave out duplicates of swatches already displayed | true |
| [showGroupLabels](https://www.adaptabletools.com/docs/reference/colourpickeroptions.md#showgrouplabels) | `boolean` | Show **Theme** and **Palette** headings on the Palette tab (if both have colours) | false |
| [tabs](https://www.adaptabletools.com/docs/reference/colourpickeroptions.md#tabs) | [`ColourPickerTab`](https://www.adaptabletools.com/docs/reference/colourpickertab.md)`[]` | Colour Picker tabs to display in order provided; `Custom`, `Palette`, or both | ['Custom', 'Palette'] |

## Property Details

### filterColours

Chooses which of the supplied colours (theme & colour palette) the Palette tab shows

```ts title="TypeScript"
filterColours?: (context: ColourPickerFilterContext) => ColourPickerFilterResult | void;
```

###### Property Value

`(context: `[`ColourPickerFilterContext`](https://www.adaptabletools.com/docs/reference/colourpickerfiltercontext.md)`) => `[`ColourPickerFilterResult`](https://www.adaptabletools.com/docs/reference/colourpickerfilterresult.md)` | void`

### orderPaletteColours

Orders Palette swatches around the colour wheel; if `false`, each colour stays the order supplied

```ts title="TypeScript"
orderPaletteColours?: boolean;
```

###### Default Value

true

###### Property Value

`boolean`

### removeDuplicates

Leave out duplicates of swatches already displayed

```ts title="TypeScript"
removeDuplicates?: boolean;
```

###### Default Value

true

###### Property Value

`boolean`

### showGroupLabels

Show **Theme** and **Palette** headings on the Palette tab (if both have colours)

```ts title="TypeScript"
showGroupLabels?: boolean;
```

###### Default Value

false

###### Property Value

`boolean`

### tabs

Colour Picker tabs to display in order provided; `Custom`, `Palette`, or both

```ts title="TypeScript"
tabs?: ColourPickerTab[];
```

###### Default Value

['Custom', 'Palette']

###### Property Value

[`ColourPickerTab`](https://www.adaptabletools.com/docs/reference/colourpickertab.md)`[]`