Skip to end of metadata
Go to start of metadata

Description

Analysis Table component displays tabular data with drill down capabilities. This extends from the Table Component Component Table Icon that comes with Ignition.

Component Analysis Table

Analysis Table

When the user clicks on a row in the table, the drill down menu will appear. When an item in the drill down menu is clicked on, the drillDown event is fired. Script in the drillDown event is responsible for updating the Data property to change the results shown in the table. The drill down menu information is set through the Drill Down Options property. The Drill Down Options can be populated from the Analysis Controller, Analysis Selector, SQL Query, scripting, or it can be manually defined in the designer.


Component Palette



Component Properties

Properties are provided that can be set to affect the operation and look of the component. They can be set through the Property Editor in the Designer or through scripting.

Example
event.source.parent.getComponent('Analysis Table').previousDrillDownEnabled = False

 Data
NameScriptingProperty TypeDescription
allowExportAllow ExportbooleanAllows the user to export the table data
DatadataDatasetCollection of data in the table
Drill Down OptionsdrillDownOptionsDatasetDataset containing the analysis drill down options
Previous Drill Down EnabledpreviousDrillDownEnabledbooleanIf true, show previous in drill down menu
Column Attributes DatacolumnAttributesDataDatasetThe dataset describing the column attributes
Selected ColumnselectedColumnintThe index of the first selected column, or -1 if none
Selected RowselectedRowintThe index of the first selected row, or -1 if none
 Appearance
NameScriptingProperty TypeDescription
Auto Row Height EnabledautoRowHeightEnabledbooleanIf true, the row height of the downtime table and the equipment list will be adjusted automatically.
Header FontheaderFontFontFont to use for the table header.
Header Foreground ColorheaderForegroundColorThe foreground color of the table header.
Header Background ColorheaderBackgroundColorThe background color of the table header.
Row HeightrowHeightintThe height of each row, in pixels.
Selection Background ColorselectionBackgroundColorThe background color of a selected row in the table.
Selection Foreground ColorselectionForegroundColorThe foreground color of a selected row in the table.
Show Horizontal Grid Lines?showHorizontalLinesbooleanDisplays horizontal gridlines making it easier to read.
Show Vertical Grid Lines?showVerticalLinesbooleanDisplays vertical gridlines making it easier to read.
Table Background ColortableBackgroundColorThe background color of the table body.
Grid Line ColorgridColorColorThe color used to draw grid lines.
Vertical Scrollbar WidthverticalScrollbarWidthintThe width of a vertical scrollbar.

Along with the component properties, custom properties can also be added to this component. See Component Customizers in the Ignition Help Manual for more information.



Event Handlers

Event handlers provide the ability to add custom script when a user interacts with a component such as by clicking a mouse, selecting a menu item or when a component property changes.

 cell
 cellEdited

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.

PropertyDescription
.sourceThe component that fired this event.
.oldValueThe old value in the cell that changed.
.newValueThe new value in the cell that changed.
.rowThe row of the dataset this cell represents.
.columnThe column of the dataset this cell represents.
 drillDown
 drillDown

Is fired when drill down menu item is selected. Excludes the "Back" menu item.

PropertyDescription
.sourceThe component that fired this event.
.drillDownNameText of selected drill down option menu item.
.categoryValue of first column for the selected row.
drillDown Event Script
container = event.source.parent
container.getComponent('MES Analysis Selector').drillDown(event.getDrillDownName(), event.getCategory())
 back
PropertyDescription
.sourceThe component that fired this event.
.drillDownNameText of selected drill down option menu item.
.categoryValue of first column for the selected row.
back Event Script
container = event.source.parent
container.getComponent('MES Analysis Selector').prevDrillDown()
 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.

PropertyDescription
.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 vice versa.
 focusLost

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

PropertyDescription
.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 vice 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.

PropertyDescription
.sourceThe component that fired this event.
.keyCodeThe 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.
.keyLocationReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (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.

PropertyDescription
.sourceThe component that fired this event.
.keyCodeThe 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.
.keyLocationReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 keyTyped

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

PropertyDescription
.sourceThe component that fired this event.
.keyCodeThe 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.
.keyLocationReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (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.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (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.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (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.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (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.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (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.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (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.

PropertyDescription
.sourceThe component that fired this event.
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
.propertyNameThe 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.




Extension Functions

Extension functions allow the operation of a component to be altered. Extension functions cannot be called, they are event driven. See Component Extension Functions in the Ignition Help Manual for more information.

 configureHeaderStyle
  • Description

Provides a chance to configure the style of each column header. Return a dictionary of name-value pairs with the desired attributes. Available attributes include: 'font', 'foreground', 'background', 'border', 'toolTipText'.

  • Parameters

self - A reference to the component that is invoking this function.

colIndex - The index of the column in the underlying dataset.

colName - Name of the column in the underlying dataset.

  • Return

Nothing

  • Scope

Client

Code Example
from java.awt import Font
from java.awt import Color
from javax.swing.border import MatteBorder
return { 'font': Font('Dialog', Font.PLAIN, 12), 
	'foreground': Color.BLUE, 
	'background': Color.YELLOW, 
	'border': MatteBorder(1, 1, 1, 1, Color(238, 236, 232)), 
	'toolTipText': colName } 




Custom Methods

Custom methods allow you to add your own component functions to a component that can be called through scripting. This is a useful and clean method of re-using script that is specific to the component (say you want to update a visual aspect of the component in the same way whether a user clicks on the component or a window property value changes). See Component Custom Methods in the Ignition Help Manual for more information.




Customizers

Table Customizer shown below manages the data entered into the Analysis Table. It will allow you to modify the data which is stored inside the Analysis Table. Thus the formatting and alignments are made easy.

Column Configuration

Header - Provide a custom name to the column header.

Hide? - Hides the column.

Editable - Allows the editing of the cell pertaining to the column.

Sortable - To make a column filter the data on user's demand.

Sortable - Allows the user to sort the table according to the selected column.

Horiz Align - Aligns the contents of the column.

Vert Align - Aligns the contents of the column.

Wrap Text? - Data in the cell wraps to fit the column width. When you change the column width, data wrapping adjusts automatically.

Prefix - A custom text that proceeds the contents of each cell.

Suffix - A custom text that follows the contents of each cell.

Number Format - A format of the cell is the contents of the cell are number types.

Date Format -  Used if the contents of the cell are date types.

Boolean? - Changes the contents of the cell to reflect a 'check box' look and feel.



Component Functions

This component does not have functions associated with it.

  • No labels