MES 2.0



MES Platform 2.0

Contents

Expand all   Collapse all

Sepasoft Resources

Sepasoft MES 2.0 Help Documentation
Sepasoft MES 3.0 Help Documentation
Knowledge Base Articles
Training Videos
Online Training (new)
Online Training (legacy)
Business Connector
Sepasoft Support
Module Updates

Inductive Resources

Ignition User Manual
Knowledge Base Articles
Inductive University
Forum
IA Support

Help Versions

MES Platform 3.0
MES Platform 2.0
MES Platform 1.0

  • Created by user-bff4c, last modified by Unknown User (peter.chrissanthis) on Feb 06, 2021

Descriptions

The XBar Standard Deviation (S) control chart is used to display SPC results that have multiple measurements for each sample. It does not retrieve SPC results from the SPC module so it must be used with either the SPC Selector or the SPC Controller components that do. Only SPC results with XBar and S SPC Data Format specified will be displayed.

XBar Standard Deviation Control Chart


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('Xbar and S Chart').enableHighlights = True

NameScriptingProperty TypeDescription
Calculated ValuescalcValuesStringCalculated value definitions.
Measurement CountmeasurementCountintNumber of measurements in the SPC results. Note that the max number of measurements is 500.
SPC DatasPCDataStringThe SPC data.
SPC ResultssPCResultsStringSPC results containing data, measurement count and calculated value information.
UseruserStringCurrent user. If this property is not set, then the currently logged in user will be used.
NameScriptingProperty TypeDescription
No Data FontnoDataFontFontThe font to use for the no data message.
No Data ForegroundnoDataForegroundColorThe foreground color of the no data message.
No Data MessagenoDataMessageStringThe message to show when there is no data.
NameScriptingProperty TypeDescription
Calc BackgroundcalcBackgroundColorThe background color of the calculated values.
CalcFontcalcFontFontThe font to use for the calculated values.
Calc ForegroundcalcForegroundColorThe foreground color of the calculated values.
Column WidthcolumnWidthintThe width of the table columns.
Data BackgrounddataBackgroundColorThe background color of the data values.
Data FontdataFontFontThe font to use for the data values.
Data ForegrounddataForegroundColorThe foreground color of the data values.
Date BackgrounddateBackgroundColorThe background color of the date row.
Date FontdateFontFontThe font to use for the date row.
Date ForegrounddateForegroundColorThe foreground color of the date row.
Date FormatdateFormatStringThe date formatting pattern used to display the date.
Enable HighlightsenableHighlightsbooleanEnables highlighting of signals and control limits in the table.
Label BackgroundlabelBackgroundColorThe background color of the labels.
Label FontlabelFontFontThe font to use for the labels.
Label ForegroundlabelForegroundColorThe foreground color of the labels.
Min Visible SamplesminVisibleSamplesStringThe minimum number of sample to show in the table.
Row HeightrowHeightintThe height of the table rows.
Scroll XscrollXStringThe scroll bar x position.
Show TableshowTablebooleanSet to true to display the sample values table.
Visible MeasurementsvisibleMeasurementsStringThe number of measurements to show in the table.
NameScriptingProperty TypeDescription
Edit Control Limit ImageeditControlLimitImagePathStringImage to show for editing control limits.
Enable Control Limit EditingenableControlLimitEditingbooleanIf true, allow users to change control limit values.
Enable Note EditingenableNoteEditingbooleanIf true, allow users to add and edit notes.
Enable Point DeletionenablePointDeletionbooleanIf true, allow users to delete points.
Enable Sample DeletionenableSampleDeletionbooleanIf true, allow users to delete samples.
Horizontal Grid Line ColorhorzGridLineColorColorThe color of horizontal grid lines.
Limit Dialog Horizontal OffsetlimitDialogOffsetXStringThe horizontal offset to display the control limit dialog box.
Limit Dialog Vertical OffsetlimitDialogOffsetYStringThe vertical offset to display the control limit dialog box.
Marker Image PathmarkerImagePathStringThe relative path of an image to display for markers.
Marker Label FontmarkerLabelFontFontThe font to use for the markers.
Note ImagenoteImagePathStringImage to show on the the charts when notes exist for a sample.
Primary Chart Axis TitleprimaryChartAxisTitleStringTitle to show for the primary chart axis.
Primary Chart BackgroundprimaryChartBackgroundColorThe background color of the primary chart.
Right Axis WidthrightAxisWidthintThe width of the right chart axis.
Secondary Chart Axis TitlesecondaryChartAxisTitleStringTitle to show for the secondary chart axis.
Secondary Chart BackgroundsecondaryChartBackgroundColorThe background color of the secondary chart.
Show Horizontal Grid LinesshowHorzGridLinesbooleanIf true, show horizontal grid lines on charts.
Show NotesshowNotesbooleanIf true, show notes on the chart.
Show Primary AverageshowPrimaryAveragebooleanSet to true to display the average line on the primary chart.
Show Primary ChartshowPrimaryChartbooleanSet to true to display the primary chart.
Show Secondary AverageshowSecondaryAveragebooleanSet to true to display the average line on the secondary chart.
Show Seconday ChartshowSecondaryChartbooleanSet to true to display the secondary chart.
Show Vertical Grid LinesshowVertGridLinesbooleanIf true, show vertical grid lines on charts.
Vertical Grid Line ColorvertGridLineColorColorThe color of vertical grid lines.


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.

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.

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.

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.

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.

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.

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.

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.

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

  • Description

Called when tool tip content is generated for a note symbol. The default tool tip is passed and can be modified or replaced.

  • Parameters

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

sampleUUID - The UUID of the sample that the tool tip is being generated for.

defaultToolTip - The default tool tip that can be modified or replaced.

  • Return

The default tool tip.

  • Scope

Client

  • Description

Called when tool tip content is generated for a sample. The default tool tip is passed and can be modified or replaced.

  • Parameters

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

sampleUUID - The UUID of the sample that the tool tip is being generated for.

valueInfo - The SPCCalcValueInfo object that holds information about the value.

defaultToolTip - The default tool tip that can be modified or replaced.

  • Return

The default tool tip.

  • Scope

Client

  • Description

Called before the sample be deleted. If return value is True, then the sample be deleted.

  • Parameters

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

sampleUUID - The UUID of the sample to be deleted.

  • Return

True

  • Scope

Client



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.



Translation Manager

Right clicking the control chart will give the pop up menu items like Delete Sample, Edit Note, Hide Point and Restore Hidden Points. SPC chart popup panel menu strings are localizable. The alternate strings can be added through the Ignition translation manager (not the component translation manager). Reopen the control chart page and right click on a point to manifest the changes.


Customizers

This component does not have any custom properties.


Component Functions

Control charts such as C-Chart, Individual and Range, Median and Range, NP-Chart, Pareto Chart, P-Chart, U-Chart, Xbar and R Chart, Xbar and S Chart inherit these script functions.

Script Functions:


Description

Exports the control charts values.

Syntax

export(locale, csvSeparator)

 

  • Parameters

String locale - Locale used for parsing.

String csvSeparator - The csv delimiter used.

  • Returns

A XML string value representing the SPC control chart values.

  • Scope

Client

Description

Exports the control charts values.

Syntax

export(locale, csvSeparator, filter)

 

  • Parameters

String locale - Locale used for parsing.

String csvSeparator - The csv delimiter used.

String filter - The string value to filter results.

  • Returns

A XML string value representing the SPC control chart values.

  • Scope

Client

Description

Exports and saves the results to file.

Syntax

exportWithSave(locale, csvSeparator)

 

  • Parameters

String locale - Locale used for parsing.

String csvSeparator - The csv delimiter used.

  • Returns

A XML string value representing the SPC control chart values.

  • Scope

Client

Description

Exports and saves the results to a file.

Syntax

exportWithSave(locale, csvSeparator, filter)

 

  • Parameters

String locale - Locale used for parsing.

String csvSeparator - The csv delimiter used.

String filter - The string value to filter results.

  • Returns

A XML string value representing the SPC control chart values.

  • Scope

Client

  • No labels