Skip to end of metadata
Go to start of metadata

Description

A component that allows selections of SPC data. As the user makes selections, this component will query the server for results. These results can be accessed through the SPC Results and SPC Data and can be linked with any of the SPC control charts.

SPC Selector

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 as shown below. To minimize the number of filter options, reduce the date range defined by the Start Date and End Date properties and the associated filter values will be shown. Because values collected from different locations being shown together does not make sense, a location must be added to the Filter By section.

 

Component Palette

Filter By List


Sample definitions can have more than one attribute. At the time sample data is recorded, each attribute will have a value associated with it. For example, when collecting viscosity reading it may also be important to know the temperature. But, showing and making calculations on a viscosity value of 10000 with a temperature value of 75.2 does not make sense. The SPC Selector allow selecting a single attribute as shown below.

If an attribute type of sample definition is selected, then the Attribute section will not appear. This is because with attribute charts, all attributes are included as shown. For example, if a sample definition has an attribute for Torn, Discolored, Pitted, etc. then all will show in the table and is included for calculations.

Attribute Selection


Similar to filters, control limits and signals can be added to the SPC results. Any selected control limits, and signals that depend on them, will not appear on the control chart until the control limit value has been set.

Selections can be removed by selecting the ProductionAnalysisSelectorDelete link to the left of the selection.

To display the SPC results of this component in a control charts, bind the SPC Results property of the control chart to the SPC Results property of this component.


 

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('SPC Selector').supressWarnings = True

 Common
NameScriptingProperty TypeDescription
BordersettingsBorderBorderBorder for main settings panel.
 Data
NameScriptingProperty TypeDescription
Start DatestartDateDateTimeStart Date to filter SPC results.
End DateendDateDateTimeEnd Date to filter SPC results.
Auto RefreshautoRefreshbooleanIf true, refresh data when sample or definition information changes.
SPC ResultssPCResultsSPCResultsSPC Results including data, measurement count and calculated value information.
SPC DatasPCDataDatasetThe SPC data.
Measurement CountmeasurementCountintNumber of measurements in the SPC results. Note that the max number of measurements is 500.
Calculated ValuescalcValuesSPCCalcValueCollectionCalculated value definitions.
MessagemessageStringError or warning message associated with the SPC results.
Suppress WarningssuppressWarningsbooleanIf true, hide warning message dialog popup.
Suppress ErrorssuppressErrorsbooleanIf true, hide error message dialog popup.
Include Disabled AttributesincludeDisabledAttributesbooleanIf true, sample attributes that are disabled will be included.
Filter Selection SummaryfilterSummaryStringSummarizes your filter selections in a string.
Control Limit SummarycontrolLimitSummaryStringSummarizes your control limit selections in a string.
Row LimitrowLimitIntegerThe maximum number of samples to return in the results.
Signal SummarysignalSummaryStringSummarizes your signal selections in a string.
Attribute NameattributeNameStringThe name of the current sample attribute.
Attribute UnitsattributeUnitsStringThe units label of the current sample attribute.
Attribute Default ChartattributeDefaultChartStringThe default chart of the current sample attribute.
Use Default Chart TypeuseDefaultChartTypebooleanIf true, uses the default chart type from the attribute definition.
Definition NamedefinitionNameStringThe current definition name.
 Appearance
NameScriptingProperty TypeDescription
Slide Out Background ColorslideOutBackgroundColorThe background color of the slide out pane.
Slide Out BorderslideOutBorderBorderBorder for slide out panel.
Min Slide Out WidthminSlideOutWidthintThe minimum width of the slide out pane.
Max Slide Out WidthmaxSlideOutWidthintThe maximum width of the slide out pane.
PaddingpaddingintThe amount of padding between the notes.
Header Background ColorheaderBackgroundColorThe color for the header backgrounds.
 Histogram
NameScriptingProperty TypeDescription
Auto Bar CountautoBarCountbooleanIf true, the number of data bars to include in the histogram results will be automatically calculated.
Data Bar CountdataBarCountInt4If Auto Bar Count is false, the number of data bars to include in the histogram results.
Padding Bar CountpaddingBarCountInt4The number of bars prior to and following the data bars to include in the histogram results.

 

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.

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

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('SPC Selector').refreshInfo().

 refreshInfo()
  • Description

Force refresh of the SPC results.

  • Parameters

None

  • Return

Nothing

  • Scope

Client

 setSpcDataFormat(spcDataFormat)
  • Description

Change to format if the SPC data to return.

  • Parameters

spcDataFormat - Format of the SPC data to return.


Data Typeint
None0
XBarR1
XBarS2
Individual3
Median4
U5
C6
P7
NP8
Histogram9
Pareto10

 

  • Return

Nothing

  • Scope

Client

 setRowLimit(rowLimit)
  • Description

Change the default number of samples to return to the value specified in the rowLimit parameter. By default only 500 samples are returned in the SPC results. This is done to unburden the database, network bandwidth and memory.

  • Parameters

int rowLimit - New row limit.

  • Return

Nothing

  • Scope

Client

 getRowLimit()
  • Description

Returns the current row limit value.

  • Parameters

None

  • Return

Nothing

  • Scope

Client

  • No labels