# FlashingCellDefinition

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

Flashes a cell, a row, or an aggregated cell when a rule matches.

`Scope` and `Rule` are required. `Type` is `'Change'` (this edit against the previous value) or `'Observable'` (change history such as `CHANGE_COUNT`). When `Type` is omitted it is treated as `'Change'`. Suspend with `IsSuspended`.

```ts title="TypeScript"
export interface FlashingCellDefinition extends AdaptableObject, SuspendableObject 
```

###### Extends

[`AdaptableObject`](https://www.adaptabletools.com/docs/reference/adaptableobject.md), [`SuspendableObject`](https://www.adaptabletools.com/docs/reference/suspendableobject.md)

## Properties

| Property | Type | Description | Default |
| --- | --- | --- | --- |
| [DownChangeStyle](https://www.adaptabletools.com/docs/reference/flashingcelldefinition.md#downchangestyle) | [`AdaptableStyle`](https://www.adaptabletools.com/docs/reference/adaptablestyle.md) | Style for &#39;Down&#39; value changes | Red BackColour |
| [FlashDuration](https://www.adaptabletools.com/docs/reference/flashingcelldefinition.md#flashduration) | `number \| 'always'` | Duration of Flash - can be number (in ms) or &#39;always&#39; | 500ms |
| [FlashTarget](https://www.adaptabletools.com/docs/reference/flashingcelldefinition.md#flashtarget) | [`FlashTargetTypes`](https://www.adaptabletools.com/docs/reference/flashtargettypes.md)` \| `[`FlashTargetTypes`](https://www.adaptabletools.com/docs/reference/flashtargettypes.md)`[]` | Should a cell or whole row flash | &#39;cell&#39; |
| [Name](https://www.adaptabletools.com/docs/reference/flashingcelldefinition.md#name) | `string` | Name of the Flashing Cell Definition |   |
| [NeutralChangeStyle](https://www.adaptabletools.com/docs/reference/flashingcelldefinition.md#neutralchangestyle) | [`AdaptableStyle`](https://www.adaptabletools.com/docs/reference/adaptablestyle.md) | Style for &#39;Neutral&#39; value changes | Gray BackColour |
| [Rule](https://www.adaptabletools.com/docs/reference/flashingcelldefinition.md#rule) | `string` | AdapTableQL boolean expression deciding when the Flashing Cell is triggered<br/>(evaluated per data change for Change; against live history for Observable),<br/>e.g. `ANY_CHANGE([price])` or `CHANGE_COUNT{[price], WITHIN(5m)} > 3` |   |
| [Scope](https://www.adaptabletools.com/docs/reference/flashingcelldefinition.md#scope) | [`ColumnScope`](https://www.adaptabletools.com/docs/reference/columnscope.md) | Which Columns, DataTypes or Column Types can Flash |   |
| [Type](https://www.adaptabletools.com/docs/reference/flashingcelldefinition.md#type) | [`FlashingCellType`](https://www.adaptabletools.com/docs/reference/flashingcelltype.md) | `'Change'` compares this edit with the previous value. `'Observable'` evaluates the rule against change history. When omitted, the definition is treated as `'Change'`. |   |
| [UpChangeStyle](https://www.adaptabletools.com/docs/reference/flashingcelldefinition.md#upchangestyle) | [`AdaptableStyle`](https://www.adaptabletools.com/docs/reference/adaptablestyle.md) | Style for &#39;Up&#39; value changes | Green BackColour |
| [IsReadOnly](https://www.adaptabletools.com/docs/reference/flashingcelldefinition.md#isreadonly) | `boolean` | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of &#39;Full&#39;) |   |
| [IsSuspended](https://www.adaptabletools.com/docs/reference/flashingcelldefinition.md#issuspended) | `boolean` | Suspends (i.e. turns off) an Adaptable Object |   |

## Property Details

### DownChangeStyle

Style for &#39;Down&#39; value changes

```ts title="TypeScript"
DownChangeStyle?: AdaptableStyle;
```

###### Default Value

Red BackColour

###### Property Value

[`AdaptableStyle`](https://www.adaptabletools.com/docs/reference/adaptablestyle.md)

### FlashDuration

Duration of Flash - can be number (in ms) or &#39;always&#39;

```ts title="TypeScript"
FlashDuration?: number | 'always';
```

###### Default Value

500ms

###### Property Value

`number | 'always'`

### FlashTarget

Should a cell or whole row flash

```ts title="TypeScript"
FlashTarget?: FlashTargetTypes | FlashTargetTypes[];
```

###### Default Value

&#39;cell&#39;

###### Property Value

[`FlashTargetTypes`](https://www.adaptabletools.com/docs/reference/flashtargettypes.md)` | `[`FlashTargetTypes`](https://www.adaptabletools.com/docs/reference/flashtargettypes.md)`[]`

### Name

Name of the Flashing Cell Definition

```ts title="TypeScript"
Name: string;
```

###### Property Value

`string`

### NeutralChangeStyle

Style for &#39;Neutral&#39; value changes

```ts title="TypeScript"
NeutralChangeStyle?: AdaptableStyle;
```

###### Default Value

Gray BackColour

###### Property Value

[`AdaptableStyle`](https://www.adaptabletools.com/docs/reference/adaptablestyle.md)

### Rule

AdapTableQL boolean expression deciding when the Flashing Cell is triggered
(evaluated per data change for Change; against live history for Observable),
e.g. `ANY_CHANGE([price])` or `CHANGE_COUNT{[price], WITHIN(5m)} > 3`

```ts title="TypeScript"
Rule: string;
```

###### Property Value

`string`

### Scope

Which Columns, DataTypes or Column Types can Flash

```ts title="TypeScript"
Scope: ColumnScope;
```

###### Property Value

[`ColumnScope`](https://www.adaptabletools.com/docs/reference/columnscope.md)

### Type

`'Change'` compares this edit with the previous value. `'Observable'` evaluates the rule against change history. When omitted, the definition is treated as `'Change'`.

```ts title="TypeScript"
Type?: FlashingCellType;
```

###### Property Value

[`FlashingCellType`](https://www.adaptabletools.com/docs/reference/flashingcelltype.md)

### UpChangeStyle

Style for &#39;Up&#39; value changes

```ts title="TypeScript"
UpChangeStyle?: AdaptableStyle;
```

###### Default Value

Green BackColour

###### Property Value

[`AdaptableStyle`](https://www.adaptabletools.com/docs/reference/adaptablestyle.md)

### IsReadOnly

> *Inherited from [AdaptableObject](https://www.adaptabletools.com/docs/reference/adaptableobject.md)*

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of &#39;Full&#39;)

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

###### Property Value

`boolean`

### IsSuspended

> *Inherited from [SuspendableObject](https://www.adaptabletools.com/docs/reference/suspendableobject.md)*

Suspends (i.e. turns off) an Adaptable Object

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

###### Property Value

`boolean`
