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


## DataOutputOptions

A configuration model for how to return data when outputting

**Signature:**

```typescript
export interface DataOutputOptions
```

## Remarks

Specifies the conversion format for datetime, boolean, and number fields.

Used in [LocalDataProvider.getOutputRow()](/refs/Class/LocalDataProvider#getoutputrow){/* */}, [LocalDataProvider.getOutputRows()](/refs/Class/LocalDataProvider#getoutputrows).

Used in [LocalTreeDataProvider.getOutputRow()](/refs/Class/LocalTreeDataProvider#getoutputrow){/* */}, [LocalTreeDataProvider.getOutputRows()](/refs/Class/LocalTreeDataProvider#getoutputrows).

## Example


```js
let opt = {
      nullText: 'empty value'
}
let row = dataProvider.getOutputRow(opt, 4);
```

## Events

| Property | Type | Description |
| --- | --- | --- |
| [booleanCallback](/refs/Interface/DataOutputOptions#booleancallback) | [BooleanOutputCallback](/refs/realgrid#booleanoutputcallback) | Callback to be performed when converting boolean field |
| [datetimeCallback](/refs/Interface/DataOutputOptions#datetimecallback) | [DatetimeOutputCallback](/refs/realgrid#datetimeoutputcallback) | Callback to be performed when converting datetime field |
| [numberCallback](/refs/Interface/DataOutputOptions#numbercallback) | [NumberOutputCallback](/refs/realgrid#numberoutputcallback) | Callback to be performed when converting number field |

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [booleanFormat](/refs/Interface/DataOutputOptions#booleanformat) | string | When the value is of type Boolean, Format |
| [datetimeFormat](/refs/Interface/DataOutputOptions#datetimeformat) | string | When the value is in date format, Format |
| [nanText](/refs/Interface/DataOutputOptions#nantext) | string | The value expressed when the value of the number field is `null` |
| [nullDateText](/refs/Interface/DataOutputOptions#nulldatetext) | string | Value expressed when the value of the DateTime field is null |
| [nullText](/refs/Interface/DataOutputOptions#nulltext) | string | Value expressed when the value of the text field is `null` |
| [numberFormat](/refs/Interface/DataOutputOptions#numberformat) | string | When the value is in numeric format, Format |
| [rowState](/refs/Interface/DataOutputOptions#rowstate) | boolean | If `true`{/* */}, the row status value is added to the return value. |

## Events Desc

### booleanCallback

Callback to be performed when converting a boolean field

`Type` - [BooleanOutputCallback](/refs/realgrid#booleanoutputcallback)

**Remarks:**

The format is [BooleanOutputCallback](/refs/realgrid#booleanoutputcallback).

<hr/>

### datetimeCallback

Callback to be performed when converting a datetime field

`Type` - [DatetimeOutputCallback](/refs/realgrid#datetimeoutputcallback)

**Remarks:**

The format is [DatetimeOutputCallback](/refs/realgrid#datetimeoutputcallback).

<hr/>

### numberCallback

Callback to be performed when converting the number field

`Type` - [NumberOutputCallback](/refs/realgrid#numberoutputcallback)

**Remarks:**

The format is [NumberOutputCallback](/refs/realgrid#numberoutputcallback).

<hr/>

## Properties Desc

### booleanFormat

Formatting when the value is of type Boolean

`Type` - string

**Remarks:**

If this value is specified, it is used as a conversion format when outputting the value of a boolean field.

Separated with a colon (:) or semicolon (;), the left side is `false`{/* */}, and the right side is `true`{/* */}.

Example) `'Nub: Yub'`

<hr/>

### datetimeFormat

Format when the value is in date format

`Type` - string

**Remarks:**

If this value is specified, it is used as a conversion format when outputting the value of a datetime field.

To output in standard time zone, enter `yyyy-MM-dd HH:mm:ssZ`{/* */}.

To output in a specific time zone, enter `yyyy-MM-dd HH:mm:ss+` or `yyyy-MM-dd HH:mm:ss+08:00`{/* */}.

Example) `'yyyy-MM-dd'`

<hr/>

### nanText

Value expressed when the value of the number field is `null`

`Type` - string

<hr/>

### nullDateText

Value expressed when the value of the DateTime field is null

`Type` - string

<hr/>

### nullText

Value displayed when the value of the text field is `null`

`Type` - string

<hr/>

### numberFormat

Format when the value is in numeric format

`Type` - string

**Remarks:**

Example) `' #,##0.### '`

<hr/>

### rowState

If `true`{/* */}, the row status value is added to the return value.

`Type` - boolean

<hr/>