Placement object
The Placement object holds information that is used as arguments in functions to define the preferred placement of a newly opened display in DeltaV Live. The Placement object can be used to define the placement for both pop-up windows and displays within display frames.
Functions that accept Placement object(s) as arguments generally accept an array of Placement objects, which define the preferred placement alternatives in decreasing preference order. You may want to define placement alternatives (an array of Placement objects) in case DeltaV Live is unable to use the information in the first, second, and so forth array element. For example, it may happen that the name of a display frame cannot be resolved in 'this' layout, or a placement alternative would cause the pop-up windows to not be entirely within a layout screen.
If DeltaV Live cannot use the information in the first array element, it attempts to use the next Placement array element, then the next, and so on, until it finds one that works. If the array of preferred placements is exhausted, DeltaV Live minimally adjusts placement for the 'last resort' Placement object to open the pop-up window within a screen's boundaries. If this adjustment does not work, Deltav Live uses the default placement rules.
| Value type | Name | Description |
|---|---|---|
| enum (see PlacementOption enum) |
.Option |
Determines the use of the other Placement object properties. |
| string | .ReferenceName |
When .Option is .DisplayFrame or .FullDisplayFrame, this value is the name of the target display frame in the layout. If undefined or empty, this value refers to the display frame where the script is running. The .FullDisplayFrame PlacementOption supports a comma delimited list of display names. |
| region (see Region object) |
.Region |
Used with the .Option and .xxxRegion choices to designate the rectangular area that the pop-up is adjacent to but does not obscure. |
| enum (see PlacementAlignment enum) |
.Alignment |
Used with the .Option choices to specify the preferred position of pop-up windows relative to the display frame, screen, or region. |
| measurement | .HorzOffset |
Holds the final horizontal (X) offset applied to the preferred pop-up window placement. If undefined or null, 0 is assumed. May be a negative number. |
| measurement | .VertOffset | This value is typically a
measurement. Holds the final vertical (Y) offset applied to the preferred pop-up window placement. If undefined or null, 0 is assumed. May be a negative number. |
| Boolean | .UseCachedPosition |
When false, this value participates in determining the pop-up window's preferred position and causes any cached position information to be ignored. When true, this value is ignored when applicable cached position information is present in this instance of DeltaV Live. |
| constructor | .Placement |
Creates a new Placement object. |