Script Methods for Area Formats
The following are basic methods provided for an area format
A scripting component that can be used to retrieve the values of an area's formatting and positioning properties. for a layer area.
Tip: For general information about layers or information about adding a layer area A type of area that contains a reference to either an existing layer object or to a data ref that resolves to the path to a layer object. A layer area can be added to the Label view of a label template. to a label template, see Using Layers. For information about creating a layer object A type of object that can contain fields appropriate for the Label view of label template. To be used by a label template, a layer object must be referenced by a layer area in the label template., see Create a Layer Object.
Tip: If using these script methods in a business rule, select the Rhino script engine.
Tip: Script methods with names beginning with get or is retrieve the current value for a property. Script methods with names beginning with set or move configure a value for the property.
|
Method |
Value |
Description |
|---|---|---|
|
getTop() |
Integer |
The location of the top coordinate at 0 degrees rotation. Units: Thousandths of an inch (mil) Example var top = areaFormat.getTop(); |
|
getBottom() |
Integer |
The location of the bottom coordinate at 0 degrees rotation. Units: Thousandths of an inch (mil) Example var bottom = areaFormat.getBottom(); |
|
getLeft() |
Integer |
The location of the left coordinate at 0 degrees rotation. Units: Thousandths of an inch (mil) Example var left = areaFormat.getLeft(); |
|
getRight() |
Integer |
The location of the right coordinate in 1/1000 of an inch at 0 degrees rotation. Units: Thousandths of an inch (mil) Example var right = areaFormat.getRight(); |
|
getHeight() |
Integer |
The height of the area. Units: Thousandths of an inch (mil) Example var height = areaFormat.getHeight(); |
|
getWidth() |
Integer |
The width of the area. Units: Thousandths of an inch (mil) Example var width = areaFormat.getWidth(); |
|
getRotation() |
Integer |
The rotational position of the area. Units: Degrees, 0 to 359 Example var rotation = areaFormat.getRotation(); |
|
getCenterX() |
Integer |
The horizontal center of the area. Units: Thousandths of an inch (mil) |
|
getCenterY() |
Integer |
The vertical center of the area. Units: Thousandths of an inch (mil) |
|
getZorder() |
Integer |
The position of the layer area within the stacking order of layer areas for the label template. |
|
isVisible() setVisible(Boolean) |
Boolean |
Whether the layer area is visible. true: The layer area is visible. false: The layer area is hidden. Example var visible = areaFormat.isVisible(); |