LabelPointReplacer
Replaces the geometry of the feature with a label point.
The insertion point of the text is guaranteed to be inside (in case of polygons) or on (lines and points) the original object. Note that since the text itself may be larger than an input area feature, the bounds of the label may exceed the bounds of the area.
Input Ports
Input features must have the correct geometry: point, line or area.
Output Ports
The features with the replaced geometry are output via this port.
Invalid features are output via this port.
Rejected features will have an fme_rejection_code attribute with one of the following values: EXTRA_FEATURE, INVALID_GEOMETRY_TYPE, INVALID_GEOMETRY_VERTICES.
Results
- If the feature was already a point, it is simply turned into a text feature at the original location.
- If the feature was a line, it is turned into a point text feature at the midpoint of the line, with a rotation parallel to the line.
- If the feature was an area feature, the resulting point is somewhere in the interior of the feature (and outside of any holes in the area).
Parameters
The label to add to the geometry.
The label height is measured in ground units, and may either be entered as a number, or can be taken from the value of a feature attribute by selecting the attribute name from the pull-down list.
The label is rotated to prevent it from appearing upside down.
Example
Editing Transformer Parameters
Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click beside the applicable parameter. For more information, see Transformer Parameter Menu Options.
Defining Values
There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters. There are a number of tools and shortcuts that can assist in constructing values, generally available from the drop-down context menu adjacent to the value field.
Using the Text Editor
The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.
Using the Arithmetic Editor
The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.
Conditional Values
Set values depending on one or more test conditions that either pass or fail.
Parameter Condition Definition Dialog
Content
Expressions and strings can include a number of functions, characters, parameters, and more.
When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.
These functions manipulate and format strings. | |
Special Characters |
A set of control characters is available in the Text Editor. |
Math functions are available in both editors. | |
Date/Time Functions | Date and time functions are available in the Text Editor. |
These operators are available in the Arithmetic Editor. | |
These return primarily feature-specific values. | |
FME and workspace-specific parameters may be used. | |
Creating and Modifying User Parameters | Create your own editable parameters. |
Dialog Options - Tables
Transformers with table-style parameters have additional tools for populating and manipulating values.
Row Reordering
|
Enabled once you have clicked on a row item. Choices include:
|
Cut, Copy, and Paste
|
Enabled once you have clicked on a row item. Choices include:
Cut, copy, and paste may be used within a transformer, or between transformers. |
Filter
|
Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output. |
Import
|
Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers. |
Reset/Refresh
|
Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers. |
Note: Not all tools are available in all transformers.
Usage Notes
To generate a point that will be used as a centroid for polygons, use an CenterPointReplacer. This saves you the overhead of having a text object.
FME Licensing Level
FME Professional edition and above
FME Community
The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.
Search for samples and information about this transformer on the FME Community.
Keywords: LabelPointCreator TextReplacer