# JSInsetList

## Overview

This class is the representation of a mobile list component/form.

## Property Summary

| Type                                                                         | Name                                          | Summary                                                                                                                    |
| ---------------------------------------------------------------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| [String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string) | [headerDataProviderID](#headerdataproviderid) | The text of this data-provider will appear on top of the inset list; if not specified, 'headerText' will be used instead.. |
| [String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string) | [headerStyleClass](#headerstyleclass)         | The styleClass of the list header..                                                                                        |
| [String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string) | [headerText](#headertext)                     | This text will appear on top of the inset list if 'headerDataProviderID' is not set..                                      |
| [String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string) | [name](#name)                                 | The name of this inset list..                                                                                              |
| [String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string) | [relationName](#relationname)                 | Name of the relation to be used by the inset list..                                                                        |
| [Number](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/number) | [x](#x)                                       | The x coordinate of the component on the form..                                                                            |
| [Number](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/number) | [y](#y)                                       | The y coordinate of the component on the form..                                                                            |

## Properties Details

### headerDataProviderID

The text of this data-provider will appear on top of the inset list; if not specified, 'headerText' will be used instead.

**Returns**\
[String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string)

**Sample**

```javascript
var insetList = jsform.getInsetList('il1');

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.name = 'il2';
```

### headerStyleClass

The styleClass of the list header. Can have values from 'a' to 'e'.

**Returns**\
[String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string)

**Sample**

```javascript
var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.headerStyleClass = 'e';
```

### headerText

This text will appear on top of the inset list if 'headerDataProviderID' is not set.

**Returns**\
[String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string)

**Sample**

```javascript
var insetList = jsform.getInsetList('il1');

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.name = 'il2';
```

### name

The name of this inset list.

**Returns**\
[String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string)

**Sample**

```javascript
var insetList = jsform.getInsetList('il1');

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.name = 'il2';
```

### relationName

Name of the relation to be used by the inset list.

**Returns**\
[String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string)

**Sample**

```javascript
var insetList = jsform.getInsetList('il1');

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.name = 'il2';
```

### x

The x coordinate of the component on the form.

**Returns**\
[Number](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/number)

**Sample**

```javascript
var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.x = 90;
newInsetList.y = 90;
application.output('location of newInsetList: ' + newInsetList.x + ', ' + newInsetList.y);
```

### y

The y coordinate of the component on the form.

**Returns**\
[Number](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/number)

**Sample**

```javascript
var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.x = 90;
newInsetList.y = 90;
application.output('location of newInsetList: ' + newInsetList.x + ', ' + newInsetList.y);
```