# RangeBarStyle

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

Configures a Range Bar Styled Column.

A Range Bar shows where a row's value sits inside a per-row (or
column-wide) numeric range. The range endpoints (`Min` / `Max`) are
resolved per row — they can be hard-coded numbers, the value of another
column on the same row, or a column-wide aggregate (`Col-Min`, `Col-Max`,
`Col-Avg`, `Col-Median`).

Common scenarios:
 - Stock price relative to its 52-week low / 52-week high
 - Today's value relative to bid / ask quotes
 - Forecast within an upper / lower confidence interval
 - Measured value within an SLA `[lowerBound, upperBound]`

Visually the cell renders as a thin track between `Min` and `Max`, with
a marker at the cell value. An optional `Reference` value renders as a
second marker (e.g. previous close, target, midpoint).

Background bands (`CellRanges`) are drawn behind the track using the same
conventions as Bullet Chart, and are useful for qualitative scales such
as poor / acceptable / good (or red / amber / green SLA bands).

```ts title="TypeScript"
export interface RangeBarStyle extends NumericStyledColumn 
```

###### Extends

[`NumericStyledColumn`](https://www.adaptabletools.com/docs/reference/numericstyledcolumn.md)

## Properties

| Property | Type | Description | Default |
| --- | --- | --- | --- |
| [BackColor](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#backcolor) | `string` | Background colour for the chart area when no `CellRanges` are supplied. |   |
| [CellTextProperties](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#celltextproperties) | [`BarStyleCellTextProperties`](https://www.adaptabletools.com/docs/reference/barstylecelltextproperties.md) | Optional cell-text overlay configuration. |   |
| [Marker](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#marker) | [`BarStyleMarker`](https://www.adaptabletools.com/docs/reference/barstylemarker.md) | Visual style of the cell-value marker. | `{ Shape: 'Diamond', Color: 'var(--ab-color-accent)', Size: 8 }` |
| [Max](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#max) | [`RangeBarBound`](https://www.adaptabletools.com/docs/reference/rangebarbound.md) | Upper bound of the track for each row.<br/><br/>See `Min` for the supported value forms. |   |
| [Min](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#min) | [`RangeBarBound`](https://www.adaptabletools.com/docs/reference/rangebarbound.md) | Lower bound of the track for each row.<br/><br/>Can be:<br/> - `number` — a fixed lower bound shared by every row<br/> - `string` — a column id; the row&#39;s value in that column is used<br/> - `'Col-Min' \| 'Col-Max' \| 'Col-Avg' \| 'Col-Median'` — a column-wide<br/> aggregate computed across the visible rows |   |
| [Orientation](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#orientation) | `'Horizontal' \| 'Vertical'` | Orientation of the range bar. | `'Horizontal'` |
| [OutOfRange](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#outofrange) | [`RangeBarOutOfRangeProperties`](https://www.adaptabletools.com/docs/reference/rangebaroutofrangeproperties.md) | Behaviour when the cell value falls outside `[Min, Max]`, plus the<br/>optional marker colour override used by `Mode: 'Clamp'`.<br/><br/>Defaults to `{ Mode: 'Clamp' }` when omitted. |   |
| [Reference](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#reference) | [`RangeBarReferenceProperties`](https://www.adaptabletools.com/docs/reference/rangebarreferenceproperties.md) | Optional reference value (e.g. previous close, target, midpoint) drawn<br/>as a *second* marker on the track, together with its marker styling.<br/>Leave unset to draw only the cell-value marker. |   |
| [ToolTipText](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#tooltiptext) | [`CellTextOptions`](https://www.adaptabletools.com/docs/reference/celltextoptions.md) | Tooltip content — same tokens (`'CellValue'`, `'PercentageValue'`)<br/>as Percent Bar / Bullet Chart. |   |
| [Track](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#track) | [`RangeBarTrackProperties`](https://www.adaptabletools.com/docs/reference/rangebartrackproperties.md) | Visual properties of the track (the line representing the `[Min, Max]`<br/>interval). |   |

## Property Details

### BackColor

Background colour for the chart area when no `CellRanges` are supplied.

```ts title="TypeScript"
BackColor?: string;
```

###### Property Value

`string`

### CellTextProperties

Optional cell-text overlay configuration.

```ts title="TypeScript"
CellTextProperties?: BarStyleCellTextProperties;
```

###### Property Value

[`BarStyleCellTextProperties`](https://www.adaptabletools.com/docs/reference/barstylecelltextproperties.md)

### Marker

Visual style of the cell-value marker.

```ts title="TypeScript"
Marker?: BarStyleMarker;
```

###### Default Value

`{ Shape: 'Diamond', Color: 'var(--ab-color-accent)', Size: 8 }`

###### Property Value

[`BarStyleMarker`](https://www.adaptabletools.com/docs/reference/barstylemarker.md)

### Max

Upper bound of the track for each row.

See `Min` for the supported value forms.

```ts title="TypeScript"
Max: RangeBarBound;
```

###### Property Value

[`RangeBarBound`](https://www.adaptabletools.com/docs/reference/rangebarbound.md)

### Min

Lower bound of the track for each row.

Can be:
 - `number` — a fixed lower bound shared by every row
 - `string` — a column id; the row&#39;s value in that column is used
 - `'Col-Min' | 'Col-Max' | 'Col-Avg' | 'Col-Median'` — a column-wide
 aggregate computed across the visible rows

```ts title="TypeScript"
Min: RangeBarBound;
```

###### Property Value

[`RangeBarBound`](https://www.adaptabletools.com/docs/reference/rangebarbound.md)

### Orientation

Orientation of the range bar.

```ts title="TypeScript"
Orientation?: 'Horizontal' | 'Vertical';
```

###### Default Value

`'Horizontal'`

###### Property Value

`'Horizontal' | 'Vertical'`

### OutOfRange

Behaviour when the cell value falls outside `[Min, Max]`, plus the
optional marker colour override used by `Mode: 'Clamp'`.

Defaults to `{ Mode: 'Clamp' }` when omitted.

```ts title="TypeScript"
OutOfRange?: RangeBarOutOfRangeProperties;
```

###### Property Value

[`RangeBarOutOfRangeProperties`](https://www.adaptabletools.com/docs/reference/rangebaroutofrangeproperties.md)

### Reference

Optional reference value (e.g. previous close, target, midpoint) drawn
as a *second* marker on the track, together with its marker styling.
Leave unset to draw only the cell-value marker.

```ts title="TypeScript"
Reference?: RangeBarReferenceProperties;
```

###### Property Value

[`RangeBarReferenceProperties`](https://www.adaptabletools.com/docs/reference/rangebarreferenceproperties.md)

### ToolTipText

Tooltip content — same tokens (`'CellValue'`, `'PercentageValue'`)
as Percent Bar / Bullet Chart.

```ts title="TypeScript"
ToolTipText?: CellTextOptions;
```

###### Property Value

[`CellTextOptions`](https://www.adaptabletools.com/docs/reference/celltextoptions.md)

### Track

Visual properties of the track (the line representing the `[Min, Max]`
interval).

```ts title="TypeScript"
Track?: RangeBarTrackProperties;
```

###### Property Value

[`RangeBarTrackProperties`](https://www.adaptabletools.com/docs/reference/rangebartrackproperties.md)