PlotAddPen Function

Help Contents

Introduction

Adds a pen to the current Temporary Plot definition.

Syntax

Informal Syntax:

PlotAddPen( TagName, Label )

Formal Syntax:

PlotAddPen( TagName:=Expression, Label:=Expression )

Parameters

Parameter Type Description
Source ANY_STRING The data source of the pen. Use one of the following:
  • The full name of a Data Point Tag which has historic storage enabled.
  • The full name of a Time Series Tag which has historic storage enabled.
  • An SQL query that returns exactly 2 columns. The first column must be a timestamp. The second column must be a value.
Label ANY_STRING The label displayed against the pen.

Return Value

None.

Remarks

Use this function to add a pen to the current Temporary Plot definition.

If the Label parameter is an empty string, the Source parameter is displayed in the trend key.

Plots a limited to 8 pens. If an Operator Action tries to add more than 8 pens to a trend, a runtime error will be reported.

Examples

  1. Adds a pen using the tag 'Measurements.Flow Rate' as the data source.
    PlotAddPen( 'Measurements.Flow Rate', 'Flow Rate' );

Further Information

Operator Actions

To learn where you can use this function.

IEC 61131-3 Expressions

To learn about the different types of expression to use as function parameters.

Glossary

For the meaning of terms used in Fernhill SCADA.