UnitZ Property (FPScript)

07.02.2018
 Analyzing Data Mathematically > Reference > FPScript Properties > UnitZ

UnitZ Property (FPScript)

Read access to the unit of a data object's Z component. Read/write access to the unit of the current formula's Z component.

Syntax

[DataObject].UnitZ

or

.UnitZ = Unit

The syntax of the UnitZproperty 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.

Unit

The string to be assigned as the unit for the Z component of the current formula.

Remarks

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 the General tab of the Properties dialog box instead.

Available in

FlexPro Standard, Professional, Developer Suite

Examples

\DataSet.UnitZ

Returns a string with the physical unit of a data set's Z component in the root folder.

.UnitZ = "Hz"

Sets the unit of the current formula's Z component to "Hz" (only useful when the unit monitoring is disabled).

 

See Also

Unit Operator

UnitX Property

UnitY Property

Share article or send as email:

You might be interested in these articles