FME Transformers: 2025.0
FME Transformers: 2025.0
TextStroker
Converts text to aggregate line or area geometry according to a specific True Type font.
Typical Uses
- Creating non-text geometry from specific fonts and font properties
- Preparing text for rasterization
How does it work?
The TextStroker receives features with text geometry and outlines the characters, producing non-text aggregate geometry containing either lines or polygons.
The shape of the characters is determined by specifying a True Type font, along with any font properties (Bold, Italic, Underline, and such) and size, which is interpreted as ground units in the feature’s coordinate system (not points).
Extra width may be added between characters, and character width may be scaled.
The output aggregates are composed of straight segments and do not include arcs.
Stroked Geometry Type |
Description |
Output |
Detail with Nodes |
---|---|---|---|
Input Feature: Text |
|
||
Polygon Features |
Font: Comic Sans MS,250,BOLD |
|
|
Outline Features |
Font: Impact,250 |
|
|
Specifying a Font
Fonts can be selected from the font picker via the ellipsis button, or provided as a string. String syntax is:
<font name>,<font size>,<font style>,<font effects>
All components are comma-separated, as in these examples:
Arial,75
Arial,75,BOLD
Arial,75,BOLD,ITALIC
Arial,75,BOLD,ITALIC,UNDERLINE
Arial,75,UNDERLINE
Available font styles vary by font.
If Font Name is not specified, the transformer will attempt to retrieve that information from the fme_font_name and fme_text_size attributes. Note that these attributes are infrequently used and unrelated to any format-specific font attributes that may exist on the input features.
Examples
Example: Stroking text to embed in a raster
In this example, we have a set of text labels and want to style them and embed them in an orthophoto. Rasterization can be done with vector geometry, but not text.
Note the input features have text geometry, positioned at a point.
The text features are first routed into a TextStroker.
In the parameters dialog, polygon output is selected and a font, style, and size specified.
Features output from the TextStroker are aggregate areas.
A FeatureColorSetter applies color to the features, and a VectorOnRasterOverlayer embeds them in the provided orthophoto.
Note that the text has become part of the raster, and is no longer vector geometry.
Usage Notes
- Some formats may include font information as format-specific attributes - to access these, expose them on the reader or use an AttributeExposer.
- If a workspace is to be run on a different machine or platform, ensure the specified font is available there.
- If output does not appear as expected, ensure that the font exists and is True Type.
Creating and Modifying Point and Text Features
These transformers work with points, text, and labels in a variety of ways.
Points and Text Transformers Comparison
Transformer |
Use this to... |
Transformer Description |
---|---|---|
Create one or more new features with box geometry of a specific size and position (when Geometry Object is Point or Text). |
Creates features using the parameters supplied, and sends them into the workspace for processing. |
|
Replace a feature’s geometry with a point at a specified location. |
Creates a single vertex to replace, be appended to, or be inserted into existing geometry. |
|
Create points inside features or their bounding boxes. |
Replaces feature geometry with a point located within the feature, its bounding box, or at its center of mass. |
|
Extract the coordinates of a calculated point within the feature. |
Extracts the coordinates of a point located within the feature, its bounding box, or at its center of mass, and stores them as attributes. |
|
Create new regularly-spaced points in a specified location. |
Creates a regular grid of points or rectangular polygons of a specified size, position, and coordinate system. |
|
Create new regularly-spaced points over the extents of other features. |
Creates a regular grid of points or rectangular polygons that span the extents of all input features. |
|
Create points from every vertex of input line or area geometry. |
Chops line, arc, path, or area features into smaller features based on number of vertices or approximate length. |
|
Create points where features intersect. |
Computes intersections between all input features, breaking lines and polygons wherever an intersection occurs and creating nodes at those locations. |
|
Create points from point cloud features. |
Converts point clouds to point or multipoint geometries, optionally retaining attribute and component values. |
|
Label lines. |
Places labels along a linear feature, angled to the orientation of each labeled segment. |
|
Label points at an angle. |
Replaces any geometry with a single text label at the center of its bounding box. |
|
Label points and areas. |
Replaces point, line, or area geometry with a single text label. |
|
Convert text to geometry. |
Replaces text with its location geometry, usually a point. |
|
Extract text properties into attributes. |
Retrieves text property values from text geometry, adding them to the feature as attributes. |
|
Set or modify text properties. |
Modifies or creates text geometry according to new coordinates, text string, size, or rotation values. |
|
Convert text to non-text geometry. |
Converts text to aggregate line or area geometry according to a specific True Type font. |
|
Extract point properties into attributes. |
Extracts point orientation to feature attributes. |
|
Set or modify point properties. |
Adds or removes point orientation. |
Labelling and Geometry
Geometry |
Recommended Transformer |
Example |
---|---|---|
Point |
|
|
Line |
|
|
Area
|
Configuration
Input Ports
Input
Features with text geometry.
Output Ports
Stroked
Features with aggregate line or area geometry as specified in parameters.
<Rejected>
Features without valid text geometry are output via this port, as are any features received with a non-numeric value for Text Padding or Text Width Multiplier.
Rejected features will have an fme_rejection_code attribute with one of the following values:
INVALID_GEOMETRY_TYPE
INVALID_GEOMETRY_DEGENERATE
INVALID_PARAMETER_FONT_NAME
INVALID_PARAMETER_TEXT_WIDTH_MULTIPLIER
INVALID_PARAMETER_TEXT_PADDING
Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.
Parameters
Output
Stroked Geometry Type |
Select an output geometry type:
|
Font
Font Name |
Specify the font name, size, and any style or effects. See Specifying a Font above. Font names are case-insensitive. The character set index may be included but is generally not used. |
Text Padding |
Specify any desired additional spacing between characters, in ground units. Default is zero (0). |
Text Width Multiplier |
Specify any desired character width multiplier. Character height is unchanged. Default is 1.0. |
Editing Transformer Parameters
Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click beside the applicable parameter.
How to Set Parameter Values
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.
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.
Content Types
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
Table Tools
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.
For more information, see Transformer Parameter Menu Options.
Reference
Processing Behavior |
|
Feature Holding |
No |
Dependencies | None |
Aliases | |
History |
FME Community
The FME Community has a wealth of FME knowledge with over 20,000 active members worldwide. Get help with FME, share knowledge, and connect with users globally.
Search for all results about the TextStroker on the FME Community.
Examples may contain information licensed under the Open Government Licence – Vancouver, Open Government Licence - British Columbia, and/or Open Government Licence – Canada.