DocumentPDFStyler

Prepares features for output to the DocumentPDF Writer by applying styling with PDF format-specific attributes.

Jump to Configuration

Typical Uses

Styling PDF output

How does it work?

The DocumentPDFStyler receives features and applies various styles to them for output via the DocumentPDF Writer.

Styles are available for:

Column Layout
Heading
Image
List
Page Break
Page Properties
Paragraph
Table
Table of Contents
Title

Markdown Styling and Links

Markdown can be used to apply additional styling or create links when the input is text, with the exception of Title.

Inline Styling

Syntax and Example	Description
bold	Use double asterisks to bold text.
__italic__	Use double underscores to italicize text.
--underline--	Use double hyphens to underline text.
~~strikethrough~~	Use double tildes to strikethrough text.
\bold\	Use backslashes (\) to escape a character sequence (for example, if it would be incorrectly interpreted as a formatting marker).

Links

Link Type	Syntax	Example
External URL	[link text](URL) Provide the text to display and the URL. Adding a URL without markdown syntax creates a clickable link; however, since the link text will not be colored blue or underlined, using markdown syntax is always recommended.	[Google](https://google.com) Google
Page in document	[link text](page number) Provide the text to display and the page number.	[Page 3](3) Page 3
Heading in document	[link text](#heading) Provide the text to display and the heading. The heading is case-sensitive and must contain all the characters of the heading, including spaces.	[Introduction](#Introduction) Introduction

Link Type

Syntax

Example

External URL

[link text](URL)

Provide the text to display and the URL.

Adding a URL without markdown syntax creates a clickable link; however, since the link text will not be colored blue or underlined, using markdown syntax is always recommended.

[Google](https://google.com)

Google

Page in document

[link text](page number)

Provide the text to display and the page number.

[Page 3](3)

Page 3

Heading in document

[link text](#heading)

Provide the text to display and the heading.

The heading is case-sensitive and must contain all the characters of the heading, including spaces.

[Introduction](#Introduction)

Introduction

Usage Notes

For more information regarding PDF styling, see DocumentPDF Format Attributes.
When creating a workspace with multiple stylers, it is important to set transformer flow. See Controlling Transformer Flow at Runtime.

Configuration

Parameters

Styling

Available Styling parameters vary according to Content Type selection.

Font

Specifies the typeface, size and emphasis (Bold, Italic, Underline, Strikeout) used for the text.

If a font cannot be found on the system, DocumentPDF will fallback to Helvetica.

Format attributes set:

documentpdf_font_family_[suffix]

documentpdf_font_size_[suffix]

documentpdf_font_emphasis_[suffix]

Font Size

Specifies the size of the text in points.

Format attribute set: documentpdf_font_size_[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).

In the case of (1,1,1) which is valid for both 24-bit and decimal, the decimal interpretation (white) is generally used when specifying colors*.

Hex codes are accepted with or without a hash sign (#).

24-bit RGB	Decimal RGB	Hex code
0,0,0	0,0,0	#000000
255,0,0	1,0,0	#FF0000
202,173,232	0.79,0.68,0.91	#CAADE8
255,255,255	1,1,1	#FFFFFF

* Color interpretation may vary in other contexts such as raster bands and palettes.

Format attribute set: documentpdf_font_color_[suffix]

Background 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).

In the case of (1,1,1) which is valid for both 24-bit and decimal, the decimal interpretation (white) is generally used when specifying colors*.

Hex codes are accepted with or without a hash sign (#).

24-bit RGB	Decimal RGB	Hex code
0,0,0	0,0,0	#000000
255,0,0	1,0,0	#FF0000
202,173,232	0.79,0.68,0.91	#CAADE8
255,255,255	1,1,1	#FFFFFF

* Color interpretation may vary in other contexts such as raster bands and palettes.

Format attribute set: documentpdf_background_color_[suffix]

Opacity

Specifies the opacity of the element as a number from 0 to 1. 0 is completely transparent, 1 is fully opaque.

Note: Only enabled for watermarks.

Format attribute set: documentpdf_opacity_watermark

Alignment

Specifies the alignment of the element:

Left: Aligns text to the left margin, with a ragged right edge
Center: Aligns text in the middle, with ragged left and right edges
Right: Aligns text to the right margin, with a ragged left edge
Justify: Aligns text evenly along both left and right margins, adjusting spacing between words

Format attribute set: documentpdf_align_[suffix]

Line Spacing

Defines the spacing between lines of text. Multiplier. 1 has no effect.

Format attribute set: documentpdf_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]

Border Layout

Specify which lines of the table are visible:

All: All lines
Horizontal Lines: Horizontal lines only
Internal: Internal lines only
Minimal: Internal vertical lines and single horizontal line
None: No cell borders
No Horizontal Lines: Outer border, vertical lines and single top line
Single Top Line: One line below the heading row Width in points of the outer border.

Outer Border Width

Width in points of the outer border.

Image

Image Filename	Specify the path and filename of the image. Format attribute set: documentpdf_image_filename
Image Width	This in conjunction with Width Unit specifies how large to scale the image. 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, Width Unit specifies the unit of the Image Width value. If Percent of Page or Column Width is chosen, then a value between 0 and 100 scales the image up to the page or column width. 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_image_caption_position
Link Type	Specifies the type of link for the image. External: To an external URL Page: To a page within the document Heading: To a heading in the document. Text must match the heading exactly 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_order

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_list_item_indent_level

Text

This parameter controls what text the list will show.

Format attribute set: documentpdf_text

Page Properties

Page Orientation	Specify the orientation of all following pages. Landscape Portrait Format attribute set: documentpdf_page_orientation
Page Size	Specify the page size of all following pages. A3 A4 A5 Custom Legal Letter If Custom, specify a Page Width, Page Height, and Page Size Unit. Format attribute set: documentpdf_page_size
Page Width	If Page Size is Custom, this parameter in conjunction with Page Size Unit specifies a custom width for all following pages.
Page Height	If Page Size is Custom, this parameter in conjunction with Page Size Unit specifies a custom height of all following pages.
Page Size Unit	If Page Size is Custom, this parameter in conjunction with Page Width and Page Height specifies a custom size for all following pages. Format attribute set: documentpdf_page_size_unit
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]
Watermark	Specify text to appear diagonally across the page. Format attribute set: documentpdf_watermark_text

Table Row

Column Header

The heading text for the particular column.

Format attribute set: documentpdf_table_row_headings

Column Value

The text value to place in a row under the particular column.

Format attribute set: documentpdf_table_row_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_row_widths

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.

Text Editor

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.

Arithmetic Editor

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

String Functions	These functions manipulate and format strings.
Special Characters	A set of control characters is available in the Text Editor.
Math Functions	Math functions are available in both editors.
Date/Time Functions	Date and time functions are available in the Text Editor.
Math Operators	These operators are available in the Arithmetic Editor.
FME Feature Functions	These return primarily feature-specific values.
FME Parameters	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:

Add a row
Remove a row
Move current row up one
Move current row down one
Move current row to top
Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

Cut a row - delete and copy to clipboard
Copy a row to the clipboard
Paste a row from the clipboard

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-Based
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.