---
title: "List"
description: "The list component displays a list of options, allowing freeform selection of the items."
---

# List

> The list component displays a list of options, allowing freeform selection of the items.

![](list0.png)

**Component Palette Icon**:  

![](list1.png)

## Description

The List component displays a list of options, allowing freeform selection of the items. It is powered by a Dataset, from which it displays the first column.

## Properties
| Name                  | Description                                                                                     | Property Type | Scripting            | Category   |
| --------------------- | ----------------------------------------------------------------------------------------------- | ------------- | -------------------- | ---------- |
| Antialias             | Draw with antialias on? Makes text smoother.                                                    | boolean       | .antialias           | Appearance |
| Background Color      | The background color of the component.                                                          | Color         | .background          | Appearance |
| Border                | The border surrounding this component. NOTE that the border is unaffected by rotation.          | Border        | .border              | Common     |
| Cursor                | The mouse cursor to use when hovering over this component.                                      | int           | .cursorCode          | Common     |
| Data                  | The data for the list. If multiple columns exist, the first will be used.                       | Dataset       | .data                | Data       |
| Data Quality          | The data quality code for any tag bindings on this component.                                   | int           | .dataQuality         | Data       |
| Enabled               | If disabled, a component cannot be used.                                                        | boolean       | .componentEnabled    | Common     |
| Font                  | Font of text on this component.                                                                 | Font          | .font                | Appearance |
| Foreground Color      | The foreground color of the component.                                                          | Color         | .foreground          | Appearance |
| Layout Orientation    | This property defines the orientation of the list elements.                                     | int           | .layoutOrientation   | Appearance |
| Mouseover Text        | The text that is displayed in the tooltip which pops up on mouseover of this component.         | String        | .toolTipText         | Common     |
| Name                  | The name of this component.                                                                     | String        | .name                | Common     |
| Opaque                | If false, backgrounds are not drawn. If true, backgrounds are drawn.                            | boolean       | .opaque              | Common     |
| Row Height            | An integer specifying the row height, or -1 for automatic row height.                           | int           | .rowHeight           | Appearance |
| Selected Background   | The color of the background for the selected cell(s).                                           | Color         | .selectedBackground  | Appearance |
| Selected Focus Border | The border for the selected, focused cell.                                                      | Border        | .selectedFocusBorder | Appearance |
| Selected Foreground   | The color of the foreground for the selected cell(s).                                           | Color         | .selectedForeground  | Appearance |
| Selected Index        | The index of the selected cell, or -1 if none.                                                  | int           | .selectedIndex       | Data       |
| Selection Mode        | This mode determines if only one cell can be selected at once, or single or multiple intervals. | int           | .selectionMode       | Behavior   |
| Styles                | Contains the component's styles.                                                                | Dataset       | .styles              | Appearance |
| Visible               | If disabled, the component will be hidden.                                                      | boolean       | .visible             | Common     |
| Visible Row Count     | An integer specifying the preferred number of rows to display without requiring scrolling.      | int           | .visibleRowCount     | Appearance |

## Scripting
See the [List Scripting Functions](list-scripting-functions.md) page for the full list of scripting functions available for this component.

### Event Handlers
Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the [Component Events](scripting\scripting-in-ignition\component-and-window-scripting\component-events.md) page.

## Customizers
* [Component Customizers](visualization-and-dashboards/understanding-components/component-customizers/component-customizers.md)
* [Style Customizer](visualization-and-dashboards/understanding-components/component-customizers/component-customizers.md#style-customizer)

## Example
```py title="Code Snippet"
#The following code will print the selected value to the console when called on the 'mouseClicked' event handler.
value = event.source.getSelectedValue()
print value
```