Skip to end of metadata
Go to start of metadata

Description

The analysis selector component allows for ad hoc selection of analysis data. 

 

Component Palette


 

Adding Filter By, Compare By and Data Points

A filter can be added by selecting the ProductionAnalysisSelectorAddlink to the right of Filter By. A window panel will open and filter categories will be displayed. Click theProductionAnalysisSelectorExpandCategorylink by the filter category and specific filter items will be displayed. When selected they will be added to the filters. To minimize the number of filter options, only the options for the selected date range defined by the Start Date and End Date properties will be shown. Compare By and Data Points work similarly to Filter By except there are no categories for these selections, just items. Selections can be removed by selecting the ProductionAnalysisSelectorDelete link to the left of the selection.


 

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('Production Analysis Selector').previousDrillDownEnabled = True

 Common
NameScriptingProperty TypeDescription
BordersettingsBorderBorderBorder for main settings panel.
Slide Out BorderslideOutBorderBorderBorder for slide out panel.
 Behavior
NameScriptingProperty TypeDescription
Min Slide Out WidthminSlideOutWidthintMaximum width of the slide out pane.
Max Slide Out WidthmaxSlideOutWidthintMaximum width of the slide out pane.
 Data
NameScriptingProperty TypeDescription
Start DatestartDateDateTimeStart date to filter the results.
End DateendDateDateTimeEnd date to filter the results.
Use Start and End TimeuseEnteredTimebooleanWhen true, allows start and end times to be exactly as entered, false (default) times revert to midnight.
Refresh on Property ChangerefreshOnPropertyChangebooleanIf true, automatically refresh when property values change.
Clear Data on Property ChangeclearDataOnPropertyChangebooleanIf true, existing data is cleared when a property values change. Used primarily when refresh on Property Change is false.
ProviderproviderStringName of the provider. Options are Downtime, Run, TEEP, Comments.
FilterfilterStringThe filter section allows you to limit the data that is included in the analysis.
Compare BycompareByStringCompare Bys are the factors used to compare the analysis data. 
Data PointsdataPointsStringData points are the individual pieces of information that will be present in the analysis.
Table DatatableDataDatasetAnalysis results in table format.
Chart DatachartDataDatasetAnalysis results in chart format.
Line Chart DatalineChartDataDatasetAnalysis results in line chart format.
Drill Down OptionsdrillDownOptionsDatasetDataset containing drill down options.
Previous Drill Down EnabledpreviousDrillDownEnabledbooleanIf true, then prevDrillDown() can be called.
Filter Selection SummaryfilterSummaryStringSummarizes your filter selections in a string.
Comparisons Selection SummarycomparisonsSummaryStringSummarizes your compare by selections in a string.
Data Points Selection SummarydataPointsSummaryStringSummarizes your data points selections in a string.
Verbose processing outputverboseintWhen set to 1, logs verbose processing data. Do not use for production.
 Appearance
NameScriptingProperty TypeDescription
Slide Out Background ColorslideOutBackgroundColorBackground color of the slide out pane.
Header Background ColorheaderBackgroundColorColor for the header background.
PaddingpaddingintAmount of padding between the notes.

 

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.

 analysisUpdate
 progressStart

Is fired when this component begins to process property changes. Useful for displaying an "in progress" message during processing.

PropertyDescription
.sourceThe component that fired this event.
 beforeUpdate
PropertyDescription
.sourceThe component that fired this event.
 afterUpdate
PropertyDescription
.sourceThe component that fired this event.
 progressEnd

Is fired when this component completes property changes. Useful for displaying an "in progress" message during processing.

PropertyDescription
.sourceThe component that fired this event.
 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.
 mouseMotion
 mouseDragged

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

 

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.
 mouseMoved

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

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.
.propertyNameName 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

This component does not have extension functions associated with it. 

 


 

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

This component does not have any custom properties.


 

Component Functions

This component provide the following functions that can be called on it. If this component has been dropped onto the windows root container, the path and an example call would be event.source.parent.getComponent('Production Analysis Selector').prevDrillDown().

 drillDown(drillDownName, item)
  • Description

Sets all the analysis selections to new state dictated by the drill down definition.

  • Parameters

String drillDownName - A drill down definition name. This is typically supplied by the drill down event of one of the display components.

String item - A drill down category. This is typically supplied by the drill down event of one of the display components.

  • Return

Nothing

  • Scope

Client

 prevDrillDown()
  • Description

Sets all the analysis selections to the previous state before the last drill down.

  • Parameters

None

  • Return

Nothing

  • Scope

Client

 changeLocalizationString(key, string)
  • Description

Changes the localization string.

  • Parameters

String key - The key to set for.

String string - The new string.

  • Return

Nothing

  • Scope

Client

 update()
  • Description

This script function will fire the analysis update event.

  • Parameters

None

  • Return

Nothing

  • Scope

Client

  • No labels