Positions a label for a 2D curve at the view margin relative to the position of the curve.
The 2D geometry of the 3D object must have one or more curves.
Usage in Label Template XML
<posSettings>
<posModulesSets>
<posModulesSet>
<connectPoint>4</connectPoint>
<positioningPoint>4</positioningPoint>
<posModules>
<posModule value="ISDwgPositionByCurve2DAtMargin">
<top>1</top>
<bottom>1</bottom>
<left>1</left>
<right>1</right>
<angle>3</angle>
<anchor>0</anchor>
<connectPoint>3</connectPoint>
<maxOffset>0.05</maxOffset>
<minOffset>0.01</minOffset>
<defaultOffset>0.01</defaultOffset>
<marginDefinition>1</marginDefinition>
<useClearSpace>1</useClearSpace>
<perimeterOffset>0.01</perimeterOffset>
<granularity>1</granularity>
</posModule>
</posModules>
</posModulesSet>
</posModulesSets>
</posSettings>
Customization
top, bottom, left, right
Sides of the view that you can use to locate the curve label. You can only locate labels in the margins of the specified sides. For each side, select to allow a label in the margin (the .xml value is 1) or clear if no label in the margin is needed (the .xml value is 0).
1 - Top |
angle
Orientation of the label.
XML value |
||
---|---|---|
Tangent Tangent to a curve |
0 |
|
Normal Out Along outward normal |
1 |
|
Normal In Along inward normal |
2 |
|
Horizontal |
3 |
|
Vertical |
4 |
|
Default Orientation |
5 |
|
Uses the orientation from the content module |
anchor
The point on the label used for positioning.
|
XML value |
|
---|---|---|
Treat as Label |
0 |
|
Uses a key point on the bounding box of the label, as specified by the connect point property in posModulesSet. |
||
Treat as Symbol |
1 |
|
Uses the origin of the symbol. |
||
Use Connect Point Similar to 0 (Treat as Label) but uses a key point specified by the connect point property defined directly in this module. |
2 |
connectPoint
Specifies the position of the label relative to the key point on the text bounding box and used with the anchor property. The default value is 4 (Middle Middle).
Key Points |
|
---|---|
0 |
Top Left |
1 |
Top Middle |
2 |
Top Right |
3 |
Middle Left |
4 |
Middle Middle |
5 |
Middle Right |
6 |
Bottom Left |
7 |
Bottom Middle |
8 |
Bottom Right |
-
Use the connect point in this module in the same way that you use the positioning point in the posModuleSet positioning module.
-
You can use the value of the connect point defined in the posModulesSet positioning module by using 0 (Treat as Label) for anchor or define the value directly in this module by using 2 (Use Connect Point) for anchor.
-
positioningPoint in the posModulesSet positioning module is not used by this module even when you have defined that parameter.
marginDefinition
Specifies the relationship of the grid axes to the drawing view for measuring the margin offset of the axes.
XML value |
||
---|---|---|
At View Frame Measures the margin offset for each axis from the edges of the view SmartFrame, shown as dashed lines in the example. |
0 |
|
At Drawing Area Measures the margin offset for each axis from the edges of the drawing area, shown as solid lines in the example. |
1 |
If you set the frame behavior to Frame resizes to drawing area, then the view frame and the drawing area are the same size, and both values provide the same result, as shown in the following example.
For more information, see Area Tab (Edit Ruleset View Style Dialog Box) in the Drawings and Reports Reference Data Guide.
maxOffset
Defines the maximum distance from a connection point that you can place a label.
1 – Perimeter Offset |
minOffset
Defines the minimum distance from a connection point that you can place a label.
1 - Minimum Offset |
defaultOffset
Defines the default distance from a connection point that you can place a label if the software cannot find clear space between the minOffset and maxOffset values.
useClearSpace
Specifies whether the software uses clear space to avoid overlap with other labels. Use 0 to ignore clear space or 1 to use clear space.
perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance from the edge of the view to the edge of the label that is closest to the view.
1 - Perimeter offset distance |
granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear space in which to position the label.
-
Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an increment of exactly one width and height of the existing label in order to find clear space in which to place the new label.
-
Type 1 to specify a Medium setting. With a Medium setting, the software searches an increment of exactly one-half the width and height of the existing label.
-
Type 2 to specify a Fine setting. With a Fine setting, the software searches an increment of exactly one-third the width and height of the existing label.
1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting
Example
The label is placed in the view margin instead of on the profile geometry.
Although a content module creates the annotation output, this example shows how this module affects the output.