UnitY Property (FPScript)
Read access to the unit of a data object's Y component. Read/write access to the unit of the actual formula's Y component.
Syntax
[DataObject].UnitY
or
[this].UnitY = Unit
The syntax of the UnitY property consists of the following elements:
Element |
Description |
|---|---|
DataObject |
Optional. The data object being accessed. If you omit this element, then the current formula is accessed. In the case of embedded FPScript you have to use the This keyword. |
Unit |
The string to be assigned as the unit for the Y component of the current formula. |
Remarks
If the data set does not have an aggregate data structure, then this unit applies to the entire data set.
Write access to the header information of a data object is only allowed for the formula where the FPScript code is located. You should only use this option in embedded FPScript. For standard formula objects, you should edit the attribute on theGeneral tab of the Properties dialog box instead.
Available in
FlexPro Basic, Professional, Developer Suite
Examples
\DataSet.UnitY |
Returns a string with the physical unit of a data set's Y component in the root folder. |
.UnitY = "%" |
Sets the unit of the current formula's Y component to "%". (only useful when the unit monitoring is disabled) |