FME Transformers: 2025.1 BETA
Categories and Related Transformers
Categories
Cartography and Reports
Prepares features for output to the PDF Writer by providing a convenient interface to set a variety of PDF format-specific attributes.
For more information regarding PDF styling, see the PDF Writer chapter in the FME Readers and Writers help. (In FME Workbench, select Help > FME Readers and Writers.)
When creating a workspace with multiple stylers, it is important to set Transformer flow. See Controlling Transformer Flow at Runtime.
Configuration
Parameters
General
|
Content Type |
This parameter specifies what kind of PDF content this feature will add into a document. Based on this parameter the rest of the parameter dialog will change. Format attribute set: documentpdf_type |
Styling
Available Styling parameters vary according to Content Type selection.
|
Font |
Specifies the typeface used for the text. If a font cannot be found on the system, DocumentPDF will fallback to Helvetica. Format attribute set: documentpdf_font_family_[suffix] |
||||||||||||||||||||
|
Font Size |
Specifies the size of the text in points. Format attribute set: documentpdf_font_size_[suffix] |
||||||||||||||||||||
|
Emphasis |
Select text effects:
Format attributes set: documentpdf_font_emphasis_bold_[suffix] documentpdf_font_emphasis_italic_[suffix] documentpdf_font_emphasis_underline_[suffix] |
||||||||||||||||||||
|
Font Color |
The color of the text foreground. 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 (#).
Format attribute set: documentpdf_font_color_[suffix] |
||||||||||||||||||||
|
Font Highlight Color |
The color of the text background. 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 (#).
Format attribute set: documentpdf_font_highlight_color_[suffix] |
||||||||||||||||||||
|
Alignment |
Specifies the alignment of the element:
Format attribute set: documentpdf_align_[suffix] |
||||||||||||||||||||
|
Line Spacing |
Defines the spacing between lines of text. Multiplier. 1 has no effect. Format attribute set: documentpdf_font_line_spacing_[suffix] |
||||||||||||||||||||
|
Top Padding |
The amount of padding at the top of the element in points. Format attribute set: documentpdf_padding_top_[suffix] |
||||||||||||||||||||
|
Bottom Padding |
The amount of padding at the bottom of the element in points. Format attribute set: documentpdf_padding_bottom_[suffix] |
||||||||||||||||||||
|
Left Padding |
The amount of padding at the left of the element in points. Format attribute set: documentpdf_padding_left_[suffix] |
||||||||||||||||||||
|
Right Padding |
The amount of padding at the right of the element in points. Format attribute set: documentpdf_padding_right_[suffix] |
Heading
|
Heading Level |
Headings have different levels. Example: Heading 3 is a subheading of Heading 2, and if you collapse a heading of heading level 2, the entire document under it until the next heading level 2 or heading level 1 will be hidden, even if there are headings of level 3 or greater among the hidden text. Format attribute set: documentpdf_heading_level |
|
Text |
This parameter controls what text the heading will show Format attribute set: documentpdf_text |
Image
|
Image Filename |
Specify the path and filename of the image. Format attribute set: documentpdf_image_filename |
|
Image Width |
This in conjunction with Width Units specifies how large to scale the image. If Percentage of Page Width was chosen for Width Units, then 100 means the entire page width, while 1 means only one percent. Format attribute set: documentpdf_image_width |
|
Width Unit |
This in conjunction with Image Width specifies how large to scale the image. If Image Width is not empty, Image Width specifies the unit of the Image Width value. If Percentage of Page Width is chosen, then it means the percent of page within the left and right margins. Format attribute set: documentpdf_image_width_unit |
|
Caption |
Specifies the image caption. Format attribute set: documentpdf_text |
|
Caption Position |
If Caption is not empty, Caption Position specifies the position of the caption, Top or Bottom. Format attribute set: documentpdf_caption_position |
|
Link Type |
Specifies the type of link for the image.
Format attribute set: documentpdf_image_link |
List Item
|
Ordering |
A list can either be Ordered or Unordered. An ordered list is prefixed with a number, and an unordered list with a black dot. Format attribute set: documentpdf_list_item_ordering |
|
Indent Level |
How much indent to place left of the list item. If the list is an ordered list, and the indent level changes, then the list item counter will reset to 1. Format attribute set: documentpdf_indent_level |
|
Text |
This parameter controls what text the list will show. Format attribute set: documentpdf_text |
Page Break
Page Break inserts a page break and has no parameters.
Page Properties
|
Header |
The header text to insert at that alignment. Format attribute set: documentpdf_header_[left|center|right] |
|
Footer |
The footer text to insert at that alignment. Format attribute set: documentpdf_footer_[left|center|right] |
Paragraph
|
Text |
The text of the paragraph. Format attribute set: documentpdf_text |
Table Of Contents
The Table of Contents is generated from headings and has no additional parameters.
Table Row
|
Column Header |
The header text for the particular column. Format attribute set: documentpdf_table_col_headers |
|
Column Value |
The text value to place in a row under the particular column. Format attribute set: documentpdf_table_col_values |
|
Column Width |
Any positive number in [0, 100], or the word Stretch. Columns with the width Stretch will all share any leftover space after columns with specified sizes are given their space. If a numeric value was chosen, then 100 means the entire effective page width, while 1 means one percent. Format attribute set: documentpdf_table_col_widths |
Title
|
Text |
This parameter controls what text the title will show Format attribute set: documentpdf_text |
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 DocumentPDFStyler 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.