{/* Do not edit this file. It is automatically generated by API Documenter. */}


## StateBar

A configuration model that involves a status bar that displays the status of rows.

When using [GridBase.setStateBar()](/refs/Class/GridBase#setstatebar), you only need to enter the necessary information.

**Signature:**

```typescript
export interface StateBar
```

## Example


```js
gridView.setStateBar({errorVisible: true});
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [cellStyleCallback](/refs/Interface/StateBar#cellstylecallback) | [RowBarCellStyleCallback](/refs/realgrid#rowbarcellstylecallback) | Callbacks to style cells |
| [displayOrder](/refs/Interface/StateBar#displayorder) | number | Order of appearance among check bars, status bars, and indicators (index) |
| [errorVisible](/refs/Interface/StateBar#errorvisible) | boolean | Whether to apply the style corresponding to the error to the status bar when an error occurs |
| [footText](/refs/Interface/StateBar#foottext) | string | Text to display in foot area |
| [headText](/refs/Interface/StateBar#headtext) | string | Text to display in head area |
| [mark](/refs/Interface/StateBar#mark) | [StateMark](/refs/realgrid#statemark) | Type of status displayed on the status bar |
| [popupMenu](/refs/Interface/StateBar#popupmenu) | [PopupMenuItem](/refs/Interface/PopupMenuItem){/* */}\[\] \| string | pop-up menu |
| [showFocus](/refs/Interface/StateBar#showfocus) | boolean | Whether or not to apply the style to the cell corresponding to the focused row |
| [showSelection](/refs/Interface/StateBar#showselection) | boolean | Whether to apply styles to related cells according to the data selection area |
| [showTooltip](/refs/Interface/StateBar#showtooltip) | boolean | Whether to show the tooltip |
| [stateTexts](/refs/Interface/StateBar#statetexts) | [StateTexts](/refs/Interface/StateTexts) | Status texts to be displayed in status bar |
| [sumText](/refs/Interface/StateBar#sumtext) | string | Text to display in summary area |
| [visible](/refs/Interface/StateBar#visible) | boolean | Visibility |
| [width](/refs/Interface/StateBar#width) | number | width |

## Properties Desc

### cellStyleCallback

Callbacks to style cells

`Type` - [RowBarCellStyleCallback](/refs/realgrid#rowbarcellstylecallback)

<hr/>

### displayOrder

Order of appearance among check bars, status bars, and indicators (index)

`Type` - number

**Remarks:**

The smaller the number, the more left it is placed.

<hr/>

### errorVisible

Whether to apply the style corresponding to the error to the status bar when an error occurs.

`Type` - boolean

<hr/>

### footText

Text to display in the foot area

`Type` - string

<hr/>

### headText

Text to display in head area

`Type` - string

<hr/>

### mark

Type of status displayed in the status bar

`Type` - [StateMark](/refs/realgrid#statemark)

<hr/>

### popupMenu

pop-up menu

`Type` - [PopupMenuItem](/refs/Interface/PopupMenuItem){/* */}\[\] \| string

<hr/>

### showFocus

Whether to apply the style to the cell corresponding to the focused row

`Type` - boolean

**Remarks:**

If `true`{/* */}, the cell corresponding to the focused row is displayed in the `'rg-statebar-focus'` style.

<hr/>

### showSelection

Whether to apply styles to related cells according to the data selection area

`Type` - boolean

**Remarks:**

If `true`{/* */}, related cells are displayed in `'rg-statebar-select'` style according to the data selection area.

<hr/>

### showTooltip

Whether to display a tooltip

`Type` - boolean

<hr/>

### stateTexts

Status texts to be displayed in the status bar

`Type` - [StateTexts](/refs/Interface/StateTexts)

**Remarks:**

\[Default values see [RowState](/refs/realgrid#rowstate))\]

`'C'`{/* */}: stateTexts\[RowState.CREATED\] `'U'`{/* */}: stateTexts\[RowState.UPDATED\] `'D'`{/* */ }: stateTexts\[RowState.DELETED\] `'X'`{/* */}: stateTexts\[RowState.CREATE\_AND\_DELETED\]

**Example:**


```js
gridView.setStateBar({
    stateTexts :{
        "created": "new",
        "updated": "edited",
        "deleted": "Delete",
        "createAndDeleted": "Delete"
    }
})
```

<hr/>

### sumText

Text to display in summary area

`Type` - string

<hr/>

### visible

Visibility

`Type` - boolean

<hr/>

### width

width

`Type` - number

<hr/>