FME Transformers: 2024.1
FME Transformers: 2024.1
PDFStyler
Sets the common PDF style attributes for a group of features destined for the GeoSpatial PDF Writer.
For more information regarding PDF styling, see the "GeoSpatial PDF Writer" in the FME Readers and Writers manual.
Configuration
Output Ports
Note Feature order may change in relation to other output ports. Feature order per port is maintained.
<Rejected> (Dynamic)
The dynamic <Rejected> port appears when a parameter is set to a non-literal value that might make processing impossible.
For example, if a numeric parameter such as Line Width, Count Start, or Decimal Places is set to an expression, attribute value, or user parameter, it is possible to pass in a non-numeric value that cannot be used. Decimal Places = Cat cannot be processed, so the feature will be output via this port.
Rejected features will have an fme_rejection_code attribute explaining the reason for rejection.
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
Identity
Name |
Determines the name of the structure element associated with the incoming feature. Name must be set to a unique value per feature thus it is recommended this be set to an attribute containing unique string values. |
Color
Color |
Specifies the pen color of the feature used to render the feature in the set color. The pen color determines the color of points, lines, arcs, area boundaries, and annotations. Specifying Colors Colors may be entered directly or chosen from the color picker via the ellipsis button. Syntax
Colors can be specified by RGB values or hex codes. RGB values may be either 24-bit or decimal (0 - 1). If the value type is unclear, as in (1,1,1), the 24-bit interpretation is used. Hex codes are accepted with or without a hash sign (#).
|
||||||||||||||||||||
Fill Color |
Specifies the fill color for an area geometry on a feature used to render the interior feature in the set color. Specifying Colors Colors may be entered directly or chosen from the color picker via the ellipsis button. Syntax
Colors can be specified by RGB values or hex codes. RGB values may be either 24-bit or decimal (0 - 1). If the value type is unclear, as in (1,1,1), the 24-bit interpretation is used. Hex codes are accepted with or without a hash sign (#).
|
||||||||||||||||||||
Opacity |
Specifies the opacity of the stroking color of the feature. A value of 1.0 is fully opaque, and 0.0 is completely transparent. |
||||||||||||||||||||
Fill Opacity |
Specifies the opacity of the fill color of the feature. A value of 1.0 is fully opaque, and 0.0 is completely transparent. |
Line Style
Line Width |
Specifies the line width in typographical points of line geometries and boundaries of area geometries. Points within half the line width perpendicular distance from the line path will be painted. |
Line Cap Style |
Specifies the cap style for the ends of lines. Valid values are:
|
Line Join Style |
Specifies the shape of corners between segments of paths. Valid values are:
|
Line Miter Limit |
Specifies a maximum on the ratio of the miter length to the line width. For example, a miter limit of 1.414 will bevel the ends of two segments meeting at an angle less than 90 degrees (the far corner will be at a distance sqrt(1^2+1^2)=sqrt(2) from the line). |
Line Dash Array/Line Dash Phase |
The Line Dash Array and Line Dash Phase control the pattern of dashes and gaps used to stroke lines. The elements of both the dash array and the dash phase are expressed in user space units. An empty dash array and zero phase can be used to draw a solid line. The Line Dash Array’s elements are numbers that specify the lengths of alternating dashes and gaps. The numbers must be nonnegative and not all zero. The Line Dash Phase specifies the distance into the dash pattern at which to start the dash. When drawing paths consisting of several subpaths, the dash pattern is applied independently to each subpath. |
Text
Font |
Refers to any valid TrueType font name, which you can choose from the dialog or enter directly in the parameter field. The font name is case-insensitive, and can also include optional style parameters according to the syntax: <fontname>[,<fontsize>][,BOLD][,ITALIC][,STRIKEOUT][,UNDERLINE] The brackets [ ] enclose optional items. |
Interactivity
Tooltip |
Specifies the string that will be displayed when an user hovers over the feature with the mouse cursor in a PDF viewer application. |
URL |
Specifies the destination address to be resolved when a user clicks on the feature in a PDF viewer application that supports URI actions. In the common case of a URL, Adobe Acrobat Reader will open a web browser to resolve the address specified. |
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.
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 all results about the PDFStyler on the FME Community.