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


## CheckBar

Settings related to the checkbar Model

**Signature:**

```typescript
export interface CheckBar 
```

## Remarks

While holding down shift in the checkbar area, move to the previous row or row. When you click on the next row, you only need to enter the information required to use batch check

[GridBase.setCheckBar()](/refs/Class/GridBase#setcheckbar).

## Example


```js
gridView.setCheckBar({exclusive: true });
```

## Events

| Property | Type | Description |
| --- | --- | --- |
| [checkableCallback](/refs/Interface/CheckBar#checkablecallback) | [CheckableCallback](/refs/realgrid#checkablecallback) | A callback that determines whether a check is possible |

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [cellStyleCallback](/refs/Interface/CheckBar#cellstylecallback) | [RowBarCellStyleCallback](/refs/realgrid#rowbarcellstylecallback) | Callbacks to style cells |
| [checkableExpression](/refs/Interface/CheckBar#checkableexpression) | string | Formula for check availability |
| [checkableOnly](/refs/Interface/CheckBar#checkableonly) | boolean | Whether only checkable rows can be checked |
| [checkLocation](/refs/Interface/CheckBar#checklocation) | [ColumnHeaderItemLocation](/refs/realgrid#columnheaderitemlocation) | Specifies the location of the checkBox. |
| [displayOrder](/refs/Interface/CheckBar#displayorder) | number | Order of appearance among check bars, status bars, and indicators (index) |
| [exclusive](/refs/Interface/CheckBar#exclusive) | boolean | Whether only one row can be checked |
| [fieldName](/refs/Interface/CheckBar#fieldname) | string | Connect the checked status of checkBar with dataField. |
| [focusMove](/refs/Interface/CheckBar#focusmove) | boolean | Whether to move focus to the clicked row when the checkBox is clicked |
| [footText](/refs/Interface/CheckBar#foottext) | string | Text to display in foot area |
| [headText](/refs/Interface/CheckBar#headtext) | string | Text to display in head area |
| [headThreeStates](/refs/Interface/CheckBar#headthreestates) | | boolean | Whether to display some selections in the checkbox of the head area when only some are checked |
| [itemGap](/refs/Interface/CheckBar#itemgap) | number | Specifies the spacing between checkBox and headText. |
| [mergeRule](/refs/Interface/CheckBar#mergerule) | string | CheckBox merge rule |
| [popupMenu](/refs/Interface/CheckBar#popupmenu) | [PopupMenuItem](/refs/Interface/PopupMenuItem){/* */}\[\] \| string | pop-up menu |
| [showAll](/refs/Interface/CheckBar#showall) | boolean | Whether to display “v” in check bar head |
| [showFocus](/refs/Interface/CheckBar#showfocus) | boolean | Whether or not to apply the style to the cell corresponding to the focused row |
| [showGroup](/refs/Interface/CheckBar#showgroup) | boolean | Whether to display a checkbox in the group header area when grouping rows |
| [showGroupFooter](/refs/Interface/CheckBar#showgroupfooter) | boolean | Whether to display a checkbox in the group footer area when grouping rows |
| [showSelection](/refs/Interface/CheckBar#showselection) | boolean | Whether to apply styles to related cells according to the data selection area |
| [showTooltip](/refs/Interface/CheckBar#showtooltip) | boolean | Whether to show the tooltip |
| [sumText](/refs/Interface/CheckBar#sumtext) | string | Text to display in summary area |
| [syncHeadCheck](/refs/Interface/CheckBar#syncheadcheck) | boolean | Check status of all items in the data area and whether the head of the check bar is linked |
| [threeStates](/refs/Interface/CheckBar#threestates) | boolean | Whether to display some selections when only some are checked |
| [toggleRadio](/refs/Interface/CheckBar#toggleradio) | boolean | When exclusive is `true`{/* */}, the radio's check state is switched. |
| [useImages](/refs/Interface/CheckBar#useimages) | boolean | Displays the check of checkBar using an image. |
| [visible](/refs/Interface/CheckBar#visible) | boolean | Visibility |
| [visibleOnly](/refs/Interface/CheckBar#visibleonly) | boolean | Whether to check only visible rows when selecting all by checking the check bar head |
| [width](/refs/Interface/CheckBar#width) | number | width |

## Events Desc
### checkableCallback

A callback that determines whether a check is possible.

`Type` - [CheckableCallback](/refs/realgrid#checkablecallback)

**Remarks:**

Checking is not possible when `false` is returned.

**Example:**


```js
const f = function(dataSource, item) {
 if (item.value) {
 return item.value !== 'doNotCheck';
 }
 else {
 return false;
 }
}

gridView.setCheckBar({checkableCallback: f});
```

<hr/>

## Properties Desc

### cellStyleCallback

Callbacks to style cells

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

<hr/>

### checkableExpression

Formula for check availability

`Type` - string

<hr/>

### checkableOnly

Whether only checkable rows can be checked

`Type` - boolean

**Remarks:**

You can specify whether checkability is possible in checkableExpression.

<hr/>

### checkLocation

Specifies the location of the checkBox.

`Type` - [ColumnHeaderItemLocation](/refs/realgrid#columnheaderitemlocation)

**Remarks:**

Specifies the position of the checkBox when the headText is displayed. You must change the width or height of checkBar [GridHeader.height](/refs/Interface/GridHeader#height) appropriately.

<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/>

### exclusive

Whether only one row can be checked

`Type` - boolean

<hr/>

### fieldName

Connect the checked status of checkBar with dataField.

`Type` - string

<hr/>

### focusMove

Whether to move focus to the clicked row when the checkBox is clicked

`Type` - boolean

<hr/>

### footText

Text to display in the foot area

`Type` - string

<hr/>

### headText

Text to display in head area

`Type` - string

<hr/>

### headThreeStates

Whether to display some selections in the checkbox in the head area when only some are checked

`Type` - boolean

<hr/>

### itemGap

Specifies the spacing between checkBox and headText.

`Type` - number

<hr/>

### mergeRule

CheckBox Merge Rules

`Type` - string

**Remarks:**

The CheckBoxes of rows with the same value in the specified field are displayed together.

**Example:**


```js
gridView.checkBar.mergeRule = "values['fieldName']";
gridView.checkBar.mergeRule = "values['field1'] + values['field2']";
```

<hr/>

### popupMenu

pop-up menu

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

<hr/>

### showAll

Whether to display “v” in the check bar head

`Type` - boolean

**Remarks:**

When checking after displaying, check all

<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 `'rg-checkbar-focus'` style.

<hr/>

### showGroup

Whether to display a checkbox in the group header area when rows are grouped

`Type` - boolean

<hr/>

### showGroupFooter

Whether to display a checkbox in the group footer area when rows are grouped

`Type` - boolean

**Remarks:**

If [CheckBar.showGroup](/refs/Interface/CheckBar#showgroup){/* */} is `false`{/* */}, it will not be displayed even if the value is `true`{/* */}.

<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-checkbar-select'` style according to the data selection area.

<hr/>

### showTooltip

Whether to display a tooltip

`Type` - boolean

<hr/>

### sumText

Text to display in summary area

`Type` - string

<hr/>

### syncHeadCheck

Check status of all items in the data area and whether the head of the check bar is linked

`Type` - boolean

**Remarks:**

When all items in a data row are checked, they are automatically checked in the Head area.

<hr/>

### toggleRadio

When exclusive is `true`{/* */}, the radio's check state is switched.

`Type` - boolean

<hr/>

### useImages

Displays the check of checkBar using an image.

`Type` - boolean

<hr/>

### visible

Visibility

`Type` - boolean

<hr/>

### visibleOnly

Whether to check only visible rows when selecting all by checking the check bar head

`Type` - boolean

<hr/>

### width

width

`Type` - number

<hr/>