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


## DropDownCellEditor

Editor that can be modified as a list (dropdown editor)

**Signature:**

```typescript
export interface DropDownCellEditor extends TextCellEditor
```
**Extends:** [TextCellEditor](/refs/Interface/TextCellEditor)

## Remarks

Select and edit one value from the list specified by the [values](/refs/Interface/DropDownCellEditor#values) property of the dropdown editor.

You can specify texts to be displayed in the dropdown list instead of [values](/refs/Interface/DropDownCellEditor#values) in [labels](/refs/Interface/DropDownCellEditor#labels){/* */}.

Inherits [TextCellEditor](/refs/Interface/TextCellEditor).

\[Superclass\]

[CellEditor](/refs/Interface/CellEditor) - [TextCellEditor](/refs/Interface/TextCellEditor)

\[subclass\]

[SearchCellEditor](/refs/Interface/SearchCellEditor)

[MultiCheckCellEditor](/refs/Interface/MultiCheckCellEditor)

## Example


```js
//string type
column.editor = "list"

// object type
column.editor = {
      type: "list",
      values: ["VINET", "TOMSP", "VICTE"],
      labels: ['label1', 'label2', 'label3'],
      displayLabels: "valueLabel",
      textReadOnly: true
}
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [caseSensitive](/refs/Interface/DropDownCellEditor#casesensitive) | boolean | Case sensitive when entering keys |
| [commitOnSelect](/refs/Interface/DropDownCellEditor#commitonselect) | boolean | Whether to commit when selecting a list |
| [displayLabels](/refs/Interface/DropDownCellEditor#displaylabels) | [DropDownValueLabel](/refs/realgrid#dropdownvaluelabel) | How to display the label |
| [domainOnly](/refs/Interface/DropDownCellEditor#domainonly) | boolean | Whether only values in the list can be specified |
| [dropDownCount](/refs/Interface/DropDownCellEditor#dropdowncount) | number | Number of list items |
| [dropDownPosition](/refs/Interface/DropDownCellEditor#dropdownposition) | [DropDownPosition](/refs/realgrid#dropdownposition) | Position of list selection box |
| [dropDownWhenClick](/refs/Interface/DropDownCellEditor#dropdownwhenclick) | boolean | Whether to expand the list when a cell is clicked |
| [dropDownWhenEnter](/refs/Interface/DropDownCellEditor#dropdownwhenenter) | boolean | Whether to expand the list when enterKey is entered |
| [dropDownWhenTyping](/refs/Interface/DropDownCellEditor#dropdownwhentyping) | boolean | Whether to display the list when typing |
| [dropDownWidth](/refs/Interface/DropDownCellEditor#dropdownwidth) | number | Width of list selection box |
| [itemColumned](/refs/Interface/DropDownCellEditor#itemcolumned) | boolean | [displayLabels](/refs/Interface/DropDownCellEditor#displaylabels) has the property [DropDownValueLabel.VALUE\_LABEL](/refs/realgrid#dropdownvaluelabel){/* */}, [DropDownValueLabel.LABEL\_VALUE](/refs/realgrid# dropdownvaluelabel), whether to automatically adjust the margin between two values and then sort them |
| [itemSortStyle](/refs/Interface/DropDownCellEditor#itemsortstyle) | [DropDownSortStyle](/refs/realgrid#dropdownsortstyle) | How the list is sorted |
| [labels](/refs/Interface/DropDownCellEditor#labels) | any\[\] | Display values in list |
| [listCallback](/refs/Interface/DropDownCellEditor#listcallback) | [ListCallback](/refs/realgrid#listcallback) | Callback called when the dropdown button is clicked |
| [partialMatch](/refs/Interface/DropDownCellEditor#partialmatch) | boolean | Whether to move to the corresponding value when entering Korean initial consonants |
| [sameValueModified](/refs/Interface/DropDownCellEditor#samevaluemodified) | boolean | Whether to consider selecting the same value as a modification |
| [separator](/refs/Interface/DropDownCellEditor#separator) | string | [displayLabels](/refs/Interface/DropDownCellEditor#displaylabels) has the property [DropDownValueLabel.VALUE\_LABEL](/refs/realgrid#dropdownvaluelabel){/* */}, [DropDownValueLabel.LABEL\_VALUE](/refs/realgrid# dropdownvaluelabel), a separator between two values |
| [templateCallback](/refs/Interface/DropDownCellEditor#templatecallback) | [ListTemplateCallback](/refs/realgrid#listtemplatecallback) | Callback called when dropdownList is displayed |
| [textReadOnly](/refs/Interface/DropDownCellEditor#textreadonly) | boolean | Whether to prohibit input using the keyboard |
| [trimLabelText](/refs/Interface/DropDownCellEditor#trimlabeltext) | boolean | Whether to trim the text in the list |
| [type](/refs/Interface/DropDownCellEditor#type) | 'dropdown' \| 'list' | Cell editor type: dropdown |
| [values](/refs/Interface/DropDownCellEditor#values) | any\[\] | Actual values in list |

## Properties Desc

### caseSensitive

Case sensitivity when entering keys

`Type` - boolean

<hr/>

### commitOnSelect

Whether to commit when selecting the list

`Type` - boolean

<hr/>

### displayLabels

How to show the label

`Type` - [DropDownValueLabel](/refs/realgrid#dropdownvaluelabel)

<hr/>

### domainOnly

Whether only values in the list can be specified

`Type` - boolean

**Remarks:**

When set to `true`, values other than the list cannot be specified.

<hr/>

### dropDownCount

Number of list items

`Type` - number

<hr/>

### dropDownPosition

Location of the list selection box

`Type` - [DropDownPosition](/refs/realgrid#dropdownposition)

<hr/>

### dropDownWhenClick

Whether to expand the list when a cell is clicked

`Type` - boolean

<hr/>

### dropDownWhenEnter

Whether to expand the list when enterKey is entered

`Type` - boolean

<hr/>

### dropDownWhenTyping

Whether to display the list when typing.

`Type` - boolean

**Remarks:**

If `false`{/* */} is set, the list will only be displayed when the button is clicked.

<hr/>

### dropDownWidth

Width of list selection box

`Type` - number

<hr/>

### itemColumn

[displayLabels](/refs/Interface/DropDownCellEditor#displaylabels) has the property [DropDownValueLabel.VALUE\_LABEL](/refs/realgrid#dropdownvaluelabel){/* */}, [DropDownValueLabel.LABEL\_VALUE](/refs/realgrid# dropdownvaluelabel), whether to automatically adjust the margin between two values and then sort them.

`Type` - boolean

<hr/>

### itemSortStyle

How the list is sorted

`Type` - [DropDownSortStyle](/refs/realgrid#dropdownsortstyle)

<hr/>

### labels

Display values in list

`Type` - any\[\]

<hr/>

### listCallback

Callback called when the dropdown button is clicked

`Type` - [ListCallback](/refs/realgrid#listcallback)

**Remarks:**

Used to dynamically create the list displayed in dropdownList.

<hr/>

### partialMatch

Whether to move to the corresponding value when entering Korean initial consonants

`Type` - boolean

<hr/>

### sameValueModified

Whether to consider identical values as modified.

`Type` - boolean

<hr/>

### separator

[displayLabels](/refs/Interface/DropDownCellEditor#displaylabels) has the property [DropDownValueLabel.VALUE\_LABEL](/refs/realgrid#dropdownvaluelabel){/* */}, [DropDownValueLabel.LABEL\_VALUE](/refs/realgrid# dropdownvaluelabel), a separator between two values.

`Type` - string

<hr/>

### templateCallback

Callback called when dropdownList is displayed

`Type` - [ListTemplateCallback](/refs/realgrid#listtemplatecallback)

**Remarks:**

Used when the user directly writes the content displayed in the dropdownList.

<hr/>

### textReadOnly

Whether input using the keyboard is prohibited

`Type` - boolean

<hr/>

### trimLabelText

Whether to trim the text in the list

`Type` - boolean

<hr/>

### type

Cell editor type: dropdown

`Type` - 'dropdown' \| 'list'

**Remarks:**

If you want to specify it as a basic drop-down editor rather than an extended model such as [SearchCellEditor](/refs/Interface/SearchCellEditor), enter `'list'` or `'dropdown'`.

<hr/>

### values

actual values in list

`Type` - any\[\]

<hr/>