AddPen

AddPen

This function adds a pen to a trend object with the specified parameters. This function has nine ways to be used:

Function Definition:

void AddPen(string tagName, string description);

void AddPen(string tagName, string description, bool showSpc);

void AddPen(string tagName, string description, bool showSpcMin, bool showSpcMax, bool showSpcAvg, bool showSpcDev, int spcDevSigma);

void AddPen(string tagName, string description, string penColor);

void AddPen(string tagName, string description, string penColor, bool showSpc);

void AddPen(string tagName, string description, string penColor, bool showSpcMin, bool showSpcMax, bool showSpcAvg, bool showSpcDev, int spcDevSigma);

void AddPen(string tagName, string description, int lineStyle, double thickness, string penColor, bool interpol, int marker, bool showLegend);

void AddPen(string tagName, string description, int lineStyle, double thickness, string penColor, bool interpol, int marker, bool showLegend, bool showSpc);

void AddPen(string tagName, string description, int lineStyle, double thickness, string penColor, bool interpol, int marker, bool showLegend, bool showSpcMin, bool showSpcMax, bool showSpcAvg, bool showSpcDev, int spcDevSigma);

.     String tagName: A string parameter containing the pen tag name that will be tracked.

.     String description: A string parameter containing a desciption of the pen.

.     String penColor: A string parameter containing the color of pen.

.     Integer lineStyle: An int indicating the pen line style. The values can be: 0 - Solid, 1 - Dash, 2 - DashDot, 3 - DashDotDot, 4 - Dot

.     double thickness: A double parameter indicating the pen line thickness.

.     bool interpol: A bool parameter indicating the pen is interpolated or not.

.     int marker: An int indicating the pen marker. The values can be: 0 - None, 1 - Circle, 2 - Triangle

.     bool showLegend: A bool parameter indicating if the pen will show legend or not.

.     bool showSpc: A bool parameter indicating if the pen will show SPC or not.

.     bool showSpcMin: A bool parameter indicating if the pen will show SPCmin or not.

.     bool showSpcMax: A bool parameter indicating if the pen will show SPCmax or not.

.     bool showSpcAvg: A bool parameter indicating if the pen will show SPCavg or not.

.     bool showSpcDev: A bool parameter indicating if the pen will show SPCdev or not.

.     int spcDevSigma: An int parameter indicating the pen SPCdevSigma.

To configure this property, follow the steps below:

1.   In an object event, configure the AddPen function: TrendObjectName.AddPen(tagName, description, penColor);

2.   During the execution of RunTime, run the configured event.

Example with AddPen(string tagName, string description, string penColor):

In the graphic document, the user has one Trend object (named as Trend1). In a Button object (named as Button1) the user configures the MouseUp event with the following event:

Trend1.AddPen("NewTag1","Pen for NewTag1","Red");

In this event, a pen will be added to the trend object.