Annotation Template Parameters

Elevation Annotation


Name	Type	Value	Description
ElevationValue	Length	Computed	Value of the elevation (mm).
Horizontal orientation	String	left/right/auto Computed	Horizontal orientation of the annotation in terms of left/right flip as per position with regards to view or object centre.
RelativePositionX	Length	Computed	Relative position along X of the annotation with regards to its insertion point (mm).
RelativePositionY	Length	Computed	Relative position along Y of the annotation with regards to its insertion point (mm).

Parameters are computed and set as template input if parameter exists.

For example, to display the elevation value in an annotation, corresponding template has to include the following:

Length type parameter named ElevationValue under Parameters node.
Text annotation with link to this parameter.

Fluidic Annotation


Name	Type	Value	Description
ElevationValue	Length	Computed	Elevation from reference plane to selected node in direction of view looking direction, returned value can be positive and negative, depending if selected node is above or below reference plane.
Distance	Length	Computed	Shortest distance between reference and node.
Global_X	Length	Computed	Fluidic node point, x 3D value
Global_Y	Length	Computed	Fluidic node point, y 3D value
Global_Z	Length	Computed	Fluidic node point, z 3D value
Reference_X	Length	Computed	Fluidic point on reference plane, x 3D value
Reference_Y	Length	Computed	Fluidic point on reference plane, y 3D value
Reference_Z	Length	Computed	Fluidic point on reference plane, z 3D value

Coordinate Annotation


Name	Type	Value	Description
Global_X	Length	Computed	Coordinate X of selected node
Global_Y	Length	Computed	Coordinate Y of selected node
Global_Z	Length	Computed	Coordinate Z of selected node
Reference_X	Length	Computed	Origin coordinate X of reference object
Reference_Y	Length	Computed	Origin coordinate Y of reference object
Reference_Z	Length	Computed	Origin coordinate Z of reference object
Distance	Length	Computed	Distance between global and reference point
NodeRadius	Length	Computed	Radius of opening node if node represent curvature of opening
FirstAxisName	String	Defined by Geolocation services	Prefix of geolocation axis
SecondAxisName	String	Defined by Geolocation services	Prefix of geolocation axis
FirstAxisCoordinate	Length	Computed	Geolocation coordinate
SecondAxisCoordinate	Length	Computed	Geolocation coordinate
CRSName	String	Defined by Geolocation services	Name of CRS in use
CRSID	String	Defined by Geolocation services	ID of CRS in use

Slope Annotation


Name	Type	Value	Description
SlopeValue	Real	Computed	Value of the slope
ReferenceValue	Real	User Defined	Reference value which is applied to the slope value (also known as antecedent in case of ratio)
DeltaX	Real	Computed	Horizontal distance between any two points on the line
DeltaY	Real	Computed	Vertical distance or altitude change between any two points on the line
NbDecimals	Integer	User Defined	To control to number of decimals displayed in the slope value (optional)

Note: Some parameters are not mandatory (marked as optional). Their behavior can be duplicated by creating EKL rules in the template itself.

For example, to display the slope value in an annotation, the corresponding template must include the following:

Real type parameter named SlopeValue under Parameters node.
Text annotation with link to this parameter.

Compass Annotation


Name	Type	Value	Description
AxisOriginPoint_X	Length	Computed	Axis line origin point x, this is a 2d projected point representing center of viewpoint used to create selected view.
AxisOriginPoint_Y	Length	Computed	Axis line origin point y, this is a 2d projected point representing center of viewpoint used to create selected view.
AxisXPoint_X	Length	Computed	Axis line X end point X, with AxisOriginPoint and AxisXPoint this create a line in direction of axis X.
AxisXPoint_Y	Length	Computed	Axis line X end point Y, with AxisOriginPoint and AxisXPoint this create a line in direction of axis X.
AxisYPoint_X	Length	Computed	Axis line Y end point X, with AxisOriginPoint and AxisYPoint this create a line in direction of axis Y.
AxisYPoint_Y	Length	Computed	Axis line Y end point Y, with AxisOriginPoint and AxisYPoint this create a line in direction of axis Y.
AxisZPoint_X	Length	Computed	Axis line z end point X, with AxisOriginPoint and AxisZPoint this create a line in direction of axis Z.
AxisZPoint_Y	Length	Computed	Axis line z end point Y, with AxisOriginPoint and AxisZPoint this create a line in direction of axis Z.
Angle_X	Angle	Computed	Angle for rotation of compass arrow in direction of global X axis.
Angle_Y	Angle	Computed	Angle for rotation of compass arrow in direction of global Y axis.
Angle_Z	Angle	Computed	Angle for rotation of compass arrow in direction of global Z axis.

Multi-Object Annotation


Name	Type	Value	Description
X-Coordinate	Length	Computed	X co-ordinate of the sub-annotation along the main line.
Y-Coordinate	Length	Computed	Y co-ordinate of the sub-annotation along the main line.
CanSymbolExtend	Boolean	Optional	Parameter defined to determine if the sub-annotation is of constant size or if it has the capability to extend.
DistanceBwGenItems	Length	Computed	Distance between the gen items along the main line if a sub-annotation intersects more than one gen item. Required if the sub-annotation has the capability to extend.
SupportedTypes	String	Optional	Create symbols only for elements which adhere to the given type (";" can be used as delimiter to support multiple types) Example 1: "SldStiffener" => Only the generated items belonging to stiffener are annotated. Example 2: "SldStiffener;SldPlate" => Only the generated items belonging to stiffener and plate are annotated.

Grid Annotation


Name	Type	Value	Description
Name	String	Computed	Name of the plane related to the grid line.
Category	String	Computed	Category of the Space Reference System (SRS) plane or its name in case of a standard plane.
Number	Integer	Computed	Number of the grid line in the set.
NumberReference	Integer	Computed	Number of the reference grid line (Center line or mid ship for SRS planes, first plane in the set otherwise) in the set.
DistanceToReference	Length	Computed	Distance between the grid line and the reference one.
Angle	Angle	Computed	Orientation in degree of the grid line with regards to view X axis.
ParamStart	Length	Computed	Curvilinear abscissa of the grid line start point.
ParamEnd	Length	Computed	Curvilinear abscissa of the grid line end point.

ParamStart and ParamEnd are mainly used for Ruler line template to drive its length from first grid line to last one.

Angle is used to manage specific behaviors related to the orientation such as displaying information for particular angle or extending line for reference angles.

Ruler Line


Name	Type	Value	Description
RulerLine	String	Multiple Values	The following behaviors are associated to values:
		Free	Lets ruler line to move freely and associate a template using this keyword in the grid line template instance naming.
		<Category>	Lets ruler line to align on planes with this category and associate a particular template.

View Title Annotation


Name	Type	Value	Description
ViewPlaneOriginPoint_X	Real	Computed	View plane origin center point X value.
ViewPlaneOriginPoint_Y	Real	Computed	View plane origin center point Y value.
ViewPlaneOriginPoint_Z	Real	Computed	View plane origin center point Z value.
ViewTypeAsString	String	Computed	String representing type of a drafting view.

Useful EKL methods:

RepresentedProduct attribute contained by ASD view- It is a product occurrence of the represented product from which the view is generated. To extract a name from it, we can use name attribute on RepresentedProduct.
ViewPlaneOriginPoint parameters can be used with GetNearestSRSPlane to get a direction of a view to get SRS position.
ViewTypeAsString provides various types of views that can be used as logical operator and customize our annotation further for a specific view.

ViewTypeAsString will return one of the following strings:

DftBackgroundView
DftFrontView
DftLeftView
DftRightView
DftTopView
DftBottomView
DftRearView
DftAuxiliaryView
DftIsomView
DftSectionView
DftSectionCutView
DftDetailView
DftUntypedView
DftMainView
DftPureSketch
DftUnfoldedView
DftAxonometricView