FME Transformers: 2024.1
Creates a common style for a group of features destined for the OGCKML writer.
Example
This screen capture shows a polygon that has had its color and fill color set by the KMLStyler.
Usage Notes
For more information regarding KML styling:
- See the FME OGCKML Writer chapter in the FME Readers and Writers manual (in FME Workbench, select Help > FME Readers and Writers Reference)
- See the KML documentation: https://developers.google.com/kml/documentation/kml_tut
Configuration
Parameters
General
|
Allow Unique Styles Per Feature |
This parameter specifies whether the first feature through the transformer defines the common style that will be used for all features that pass through the transformer, or whether each feature can supply a unique style. Unique styles per feature create larger output files but allow for different settings, such as color, per feature. |
Color
|
Color |
This parameter specifies the pen color of the feature used to render the feature in the set color. The pen color determines the color of lines, and area boundaries. 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 |
This parameter 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 |
Opacity specifies the opacity of the pen color of the feature. A value of 1.0 is fully opaque, and 0.0 is completely transparent. |
||||||||||||||||||||
|
Fill Opacity |
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. |
Icon
|
Name |
Icon Name specifies either the name of an icon selected from the icon picker, or a filename/URL of a valid image file. |
||||||||||||||||||||
|
Scale |
This parameter specifies the scale of the icon. The scale is a multiplying factor, where 1.0 is unscaled. The lower scaling bound is 0.0, and there is no upper bound. If the value is exactly 0.0, Google Earth will not display the icon. The actual display size of the icon will vary according to how each Google Earth renders the dataset at various altitudes. This value has no units. |
||||||||||||||||||||
|
Color |
This parameter allows the specification of a color that Google Earth will apply to the icon when it is displayed. This works best with white icons. Results may vary for icons which are already colored. 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 |
This parameter specifies the opacity of the icon. A value of 1.0 is fully opaque, while a value of 0.0 is completely transparent. |
Line Style
|
Line Width |
Line Width specifies the width of line geometries and boundaries of area geometries. |
|
Line Width Units |
Specifies the units for the previous parameter value. If the value of the parameter is ‘Pixels’, the line geometry will be a constant width at all zoom levels. As a result, it will appear narrower, relative to the ground when the view is zoomed in and wider when the view is zoomed out. If the value is ‘Meters’ the line width will be constant relative to the ground. As a result, it will be wider when the view is zoomed in, and narrower when the view is zoomed out. |
|
Create Labels on Lines |
If this parameter is set to ‘Yes’, the name of a KML feature (taken from the kml_name format attribute) will be displayed as a label along the length of the line. |
Label Style
|
Scale |
Label Style Scale specifies a unitless scaling factor that the KML Viewer applies to the default size of the label when rendered. Labels are rendered by KML Viewers, such as Google Earth, when the feature has both a KML name and a point geometry. The KML Writer will convert text features to KML points that have a name property. It is not possible to specify label size in terms of absolute units. |
||||||||||||||||||||
|
Color |
This parameter specifies the color in which the feature name will be displayed. This parameter is optional. If no value is given, the feature name will be displayed in white text. 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 |
This parameter specifies the opacity of the label. A value of 1.0 is fully opaque, while a value of 0.0 is completely transparent. |
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 KMLStyler on the FME Community.
Keywords: "Google Earth" KML