Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Plant SCADA

IPen​.SetVerticalAxisLabelValue [Method]

  • Last UpdatedJul 18, 2023
  • 1 minute read

This function can be used to display custom text for a particular value on the Vertical Axis.

Defined As

  • [VBA] SetVerticalAxisLabelValue(value As Double, label As String)

  • [Cicode] SetVerticalAxisLabelValue(REAL value, STRING label)

  • [C++] HRESULT SetVerticalAxisLabelValue(double value, BSTR label)

Parameters

value

[in] Indicates which value you want to replace with a custom label.

label

[in] Indicates the text that will be displayed instead of the specified value.

Execution Result

If the function succeeds the return value will be Success. If an argument is bad then the return value will be InvalidArgument. If the pen is deleted then the return value will be GeneralFailure.

Calling Syntax

Assumes you have passed a valid pen object into the function.

[VBA]

Sub Example(pen As Object)
` Change the vertical axis to display High High instead of 95
pen.SetVerticalAxisLabelValue 95, "High High"
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
// Change the vertical axis to display High High instead of 95
_ObjectCallMethod(hPen, "SetVerticalAxisLabelValue", 95, "High High");
END

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in