Skip to end of metadata
Go to start of metadata


General

Component Palette Icon:



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
NameDescriptionProperty TypeScriptingCategory
Background ColorThe background color of the component. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.Color.backgroundAppearance
Border

The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Button Border, Field Border, Line Border, and Other Border.

Note: The border is unaffected by rotation.

Border.borderCommon
CursorThe mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize.int.cursorCodeCommon
DataThe data for the list. If multiple columns exist, the first will be used.Dataset.dataData
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
FontFont of text on this component.Font.fontAppearance
Foreground ColorThe foreground color of the component. See Color Selector.Color.foregroundAppearance
Layout OrientationThis property defines the orientation of the list elements.int.layoutOrientationAppearance
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
OpaqueIf false, backgrounds are not drawn. If true, backgrounds are drawn.boolean.opaqueCommon
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
Row HeightAn integer specifying the row height, or -1 for automatic row height.int.rowHeightAppearance
Selected BackgroundThe color of the background for the selected cell(s).Color.selectedBackgroundAppearance
Selected Focus BorderThe border for the selected, focused cell.Border.selectedFocusBorderAppearance
Selected ForegroundThe color of the foreground for the selected cell(s). See Color Selector.Color.selectedForegroundAppearance
Selected IndexThe index of the selected cell, or -1 if none.int.selectedIndexData
Selection ModeThis mode determines if only one cell can be selected at once, or single or multiple intervals.int.selectionModeBehavior
StylesContains the component's styles.Dataset.stylesAppearance
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Visible Row CountAn integer specifying the preferred number of rows to display without requiring scrolling.int.visibleRowCountAppearance
Deprecated Properties
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityDeprecated
Scripting
Scripting Functions
 .addSelectionInterval(start, end)
  • Description

Adds the options at indexes start through end (inclusive) to the selected options.

  • Parameters

int start - The first index (stating at 0) to add to the selection.

int end - The last index (stating at 0) to add to the selection.

  • Return

Nothing

  • Scope

Client

 .clearSelection()
  • Description

Clears the current selection, making nothing selected.

  • Parameters

Nothing

  • Return

Nothing

  • Scope

Client

 .getSelectedIndices()
  • Description

Returns a list of the selected indices in increasing order. Returns an empty list if nothing is selected.

  • Parameters

Nothing

  • Return

List of Integers

  • Scope

Client

 .getSelectedValue()
  • Description

Returns the currently selected value, or None if the selection is empty.

  • Parameters

Nothing

  • Return

Object

  • Scope

Client

 .getSelectedValues()
  • Description

Returns a list of the currently selected values. Returns an empty list if the selection is empty.

  • Parameters

Nothing

  • Return

Object[]

  • Scope

Client

 .isSelectedIndex(index)
  • Description

Checks whether or not the given index is currently selected.

  • Parameters

int index

  • Return

boolean

  • Scope

Client

 .isSelectionEmpty()
  • Description

Checks to see if anything is selected in the list or not.

  • Parameters

Nothing

  • Return

boolean

  • Scope

Client

 .setSelectedValue(value)
  • Description

Sets the currently selected value to the argument, if found in the list.

  • Parameters

Object value

  • Return

Nothing

  • Scope

Client

This feature is new in Ignition version 8.1.0
Click here to check out the other new features

 .setSelectedValues(valueList)
  • Description

Sets the currently selected values in the component, selecting multiple options. The options selected are determined by the valueList parameter, which is expected to be a list of literal values that map to options in the list.   

  • Parameters

valueList Python list containing values that should map to options in the component.

  • Return

Nothing

  • Scope

Client

Extension Functions

This component does not have extension functions associated with it.

Event Handlers
 focus
 focusGained

This event occurs when a component that can receive input, such as a text box, receives the input focus. This usually occurs when a user clicks on the component or tabs over to it.

.source

The component that fired this event.       

.oppositeComponent

The other component involved in this focus change. That is, the component that lost focus in order for this one to gain it, or vise versa.       

 focusLost

This event occurs when a component that had the input focus lost it to another component.

.sourceThe component that fired this event
.oppositeComponentThe other component involved in this focus change. That is, the component that lost focus in order for this one to gain it, or vise versa.       
 key
 keyPressed

An integer that indicates whether the state was changed to "Selected" (on) or "Deselected" (off). Compare this to the event object's constants to determine what the new state is.

.source

The component that fired this event.       

.keyCode

The key code for this event. Used with the keyPressed and keyReleased events. See below for the key code constants.       

.keyCharThe character that was typed. Used with the keyTyped event.       
.keyLocation

Returns the location of the key that originated this key event. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This provides a way of distinguishing such keys. See the KEY_LOCATION constants, the keyTyped event always has a location of KEY_LOCATION_UNKNOWN.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.    

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.  

 keyReleased

Fires when a key is released and the source component has the input focus. Works for all characters, including non-printable ones, such as SHIFT and F3.

.source

The component that fired this event.       

.keyCode

The key code for this event. Used with the keyPressed and keyReleased events. See below for the key code constants.       

.keyCharThe character that was typed. Used with the keyTyped event.       
.keyLocation

Returns the location of the key that originated this key event. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This provides a way of distinguishing such keys. See the KEY_LOCATION constants in the documentation, the keyTyped event always has a location of KEY_LOCATION_UNKNOWN.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.    

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.  

 keyTyped

Fires when a key is pressed and then released when source component has the input focus. Only works for characters that can be printed on the screen.

.source

The component that fired this event.       

.keyCode

The key code for this event. Used with the keyPressed and keyReleased events. See below for the key code constants.       

.keyCharThe character that was typed. Used with the keyTyped event.       
.keyLocation

Returns the location of the key that originated this key event. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This provides a way of distinguishing such keys. See the KEY_LOCATION constants in the documentation, the keyTyped event always has a location of KEY_LOCATION_UNKNOWN.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.    

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.  

 mouse
 mouseClicked

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseEntered

This event fires when the mouse enters the space over the source component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseExited

 This event fires when the mouse leaves the space over the source component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mousePressed

  This event fires when a mouse button is pressed down on the source component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseReleased

This event fires when a mouse button is released, if that mouse button's press happened over this component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseMotion
 mouseDragged

Fires when the mouse moves over a component after a button has been pushed.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseMoved

Fires when the mouse moves over a component, but no buttons are pushed.


.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 propertyChange
 propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

.sourceThe component that fired this event.  
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed.
.propertyName

The name of the property that changed.      

Note: Remember to always filter out these events for the property that you are looking for. Components often have many properties that change. 

Examples

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
Code Snippet
# The following code uses setSelectedValues in an attempt to set the selection on the component. 
# Assuming the list contains string values of either "Thing 1" or "Thing 2", both items will be selected. 

# Build a list of things
valueList = ["Thing 1", "Thing 2"]

# Locate the List component in the window, and call setSelectedValues, passing the valueList as an  argument. 
event.source.setSelectedValues(valueList)
  • No labels