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


## EditMaskObject

Object type display format in the editor that can be applied to text or date fields.

**Signature:**

```typescript
export interface EditMaskObject
```

## Remarks

When applying [ValueColumn.editor](/refs/Interface/ValueColumn#editor), it is used in the editor's [mask](/refs/Interface/TextCellEditor#mask) property.

For numeric fields, use [NumberCellEditor.editFormat](/refs/Interface/NumberCellEditor#editformat).

The format applied to Marks is displayed only in the editor.

[dropDown](/refs/Interface/DropDownCellEditor){/* */}, [multiLine](/refs/Interface/MultiLineCellEditor){/* */}, [multiCheck](/refs/Interface/MultiCheckCellEditor){/* */}, does not work in [number Editor](/refs/Interface/NumberCellEditor).

## Example


```js
column.editor = {
      type: 'line',
      mask: {
          editMask: '9999-99-99',
          placeHolder: 'input...'
      }
}
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [allowEmpty](/refs/Interface/EditMaskObject#allowempty) | boolean | Whether to allow empty values `''`{/* */} when mask is set to 0 |
| [definitions](/refs/Interface/EditMaskObject#definitions) | any | Defined mask format |
| [editMask](/refs/Interface/EditMaskObject#editmask) | string | Format displayed as "0000-00-00", etc. |
| [includedFormat](/refs/Interface/EditMaskObject#includedformat) | boolean | Whether the content displayed in the editor is passed as the cell value as is |
| [invalidFormatMessage](/refs/Interface/EditMaskObject#invalidformatmessage) | string | Message to display when incorrect format is entered |
| [overWrite](/refs/Interface/EditMaskObject#overwrite) | boolean | Whether to overwrite existing characters when inputting |
| [placeHolder](/refs/Interface/EditMaskObject#placeholder) | string | editor's placeHolder |
| [restrictNull](/refs/Interface/EditMaskObject#restrictnull) | boolean | Whether to stop input in the middle |
| [showInvalidFormatMessage](/refs/Interface/EditMaskObject#showinvalidformatmessage) | boolean | Whether or not a message is displayed when an incorrect format is entered |

## Properties Desc

### allowEmpty

Whether empty values `''`{/* */} are allowed when mask is set to 0

`Type` - boolean

<hr/>

### definitions

Defined mask format

`Type` - any

**Remarks:**

Used when the developer wants to define additionally or modify it in addition to the default "9", "0", "a", and "\*".

**Example:**


```js
definitions: {"h": "[a-h]"} //"h" can be entered from a to h.
```

<hr/>

### editMask

Format displayed as "0000-00-00" etc.

`Type` - string

**Remarks:**

The format provided by default is the following regular expression.

`9`{/* */}: `new RegExp([0-9 ])`

`0`{/* */}: `new RegExp([0-9])`

`a`{/* */}: `new RegExp([A-Za-z])`

`*`{/* */}: `new RegExp([A-Za-z0-9])`

<hr/>

### includedFormat

Whether the content displayed in the editor is passed as the cell value as is.

`Type` - boolean

<hr/>

### invalidFormatMessage

Message to display when incorrect format is entered

`Type` - string

<hr/>

### overWrite

Whether to overwrite existing characters when inputting

`Type` - boolean

<hr/>

### placeHolder

editor's placeHolder

`Type` - string

<hr/>

### restrictNull

Whether to stop inputting in the middle

`Type` - boolean

<hr/>

### showInvalidFormatMessage

Is there a message displayed when an incorrect format is entered?

`Type` - boolean

<hr/>