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


## MultiCheckCellRenderer

Renderer that selects one or more than one value

**Signature:**

```typescript
export interface MultiCheckCellRenderer extends CellRenderer
```
**Extends:** [CellRenderer](/refs/Interface/CellRenderer)

## Remarks

Select one or several values specified in `values` or [DataColumn.values](/refs/Interface/DataColumn#values).

\[Superclass\]

[CellRenderer](/refs/Interface/CellRenderer)

## Example


```js
//string type
column.renderer = 'multicheck';

//object type
column.renderer = {
 "type": "multicheck",
 "values": ["Apple","Pear","Grape"],
 "labels": ["apple","pear","grape"],
 "multiSelect": true
}
```

## Events

| Property | Type | Description |
| --- | --- | --- |
| [disabledCallback](/refs/Interface/MultiCheckCellRenderer#disabledcallback) | [MultiCheckDisabledCallback](/refs/realgrid#multicheckdisabledcallback) | A callback that determines whether to disable |
| [keyToValueCallback](/refs/Interface/MultiCheckCellRenderer#keytovaluecallback) | [MultiCheckKeydownCallback](/refs/realgrid#multicheckkeydowncallback) | A callback that retrieves the value to select or deselect on keydown |

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [direction](/refs/Interface/MultiCheckCellRenderer#direction) | [LayoutDirection](/refs/realgrid#layoutdirection) | Arrange the list horizontally or vertically. |
| [gap](/refs/Interface/MultiCheckCellRenderer#gap) | number | Spacing between items |
| [itemDirection](/refs/Interface/MultiCheckCellRenderer#itemdirection) | [LayoutDirection](/refs/realgrid#layoutdirection) | Arrange the selection box and label horizontally or vertically. |
| [itemGap](/refs/Interface/MultiCheckCellRenderer#itemgap) | number | Spacing between input element and label element |
| [itemReverse](/refs/Interface/MultiCheckCellRenderer#itemreverse) | boolean | Change the order of selection boxes and labels. |
| [labels](/refs/Interface/MultiCheckCellRenderer#labels) | string\[\] | Display values in list |
| [multiSelect](/refs/Interface/MultiCheckCellRenderer#multiselect) | boolean | Multiple selection |
| [type](/refs/Interface/MultiCheckCellRenderer#type) | "multicheck" | Type: Multiple Select |
| [useCtrlNumber](/refs/Interface/MultiCheckCellRenderer#usectrlnumber) | boolean | Whether to select when Ctrl + number is entered |
| [useImages](/refs/Interface/MultiCheckCellRenderer#useimages) | boolean | Display the selection box using an image. |
| [values](/refs/Interface/MultiCheckCellRenderer#values) | string\[\] | Actual values in list |
| [wrap](/refs/Interface/MultiCheckCellRenderer#wrap) | boolean | Whether to wrap a line if the total width of the item is larger than the width of the cell |

## Event Desk

### disabledCallback

A callback that determines whether to disable it or not.

`Type` - [MultiCheckDisabledCallback](/refs/realgrid#multicheckdisabledcallback)

**Remarks:**

If `true`{/* */} is returned from the callback, it becomes disabled.

<hr/>

### keyToValueCallback

A callback that retrieves the value to select or deselect on keydown

`Type` - [MultiCheckKeydownCallback](/refs/realgrid#multicheckkeydowncallback)

<hr/>

## Properties Desc

### direction

Arrange the list horizontally or vertically.

`Type` - [LayoutDirection](/refs/realgrid#layoutdirection)

<hr/>

### gap

Spacing between items

`Type` - number

<hr/>

### itemDirection

Arrange the selection box and label horizontally or vertically.

`Type` - [LayoutDirection](/refs/realgrid#layoutdirection)

<hr/>

### itemGap

Spacing between input element and label element

`Type` - number

<hr/>

### itemReverse

Change the order of selection boxes and labels.

`Type` - boolean

<hr/>

### labels

Display values in list

`Type` - string\[\]

<hr/>

### multiSelect

Multiple selection?

`Type` - boolean

<hr/>

### type

Type: Multiple Select

`Type` - "multicheck"

<hr/>

### useCtrlNumber

Whether to select when Ctrl + number is entered

`Type` - boolean

**Remarks:**

When changing the shortcut key, use [MultiCheckCellRenderer.keyToValueCallback](/refs/Interface/MultiCheckCellRenderer#keytovaluecallback){/* */}.

<hr/>

### useImages

Display the selection box using an image.

`Type` - boolean

<hr/>

### values

actual values in list

`Type` - string\[\]

<hr/>

### wrap

Whether to wrap a line if the total width of the item is greater than the width of the cell

`Type` - boolean

<hr/>