PlotPenSetFixedAnalogScale Function

Help Contents

Introduction

Configures a pen to have an analog scale with a fixed range.

Syntax

Informal Syntax:

PlotPenSetFixedAnalogScale( PenIndex, Units, MaximumScale, MinimumScale, DisplayDigits )

Formal Syntax:

PlotPenSetFixedAnalogScale(
        PenIndex:=Expression,
        Units:=Expression,
        MaximumScale:=Expression,
        MinimumScale:=Expression,
        DisplayDigits:=Expression )
    

Parameters

Parameter Type Description
PenIndex ANY_INT The 1-based index of the pen to change. The first pen in a plot is number 1, the second pen is number 2, and so on.
Units ANY_STRING The units to display above the Y axis.
MinimumScale ANY_NUM The minimum scale of the Y Axis.
MaximumScale ANY_NUM The maximum scale of the Y Axis.
DisplayDigits ANY_INT The number of significant digits to display for data associated with the pen. The value of this parameter is limited to the range 2 to 10. Values less than 2 are rounded up to 2. Values greater than 10 are rounded down to 10.

Return Value

None.

Remarks

Use this function to set a pen to display an analog value with a fixed range.

An error will be reported if any of these conditions are true:

Examples

  1. Sets the first pen in a plot to have an analog scale with a fixed range.
    PlotPenSetFixedAnalogScale( 1, 'Metres', 0, 5, 3 );
    The units displayed above the Y Axis is 'Metres'. The scale of the Y Axis is 0 to 5. When a data value is displayed, the number of significant digits shown is 3.

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.