FME Transformers: 2024.1
FME Transformers: 2024.1
KMLPropertySetter
Sets common properties for groups of vector and raster features destined for the OGCKML Writer.
Usage Notes
For more information regarding KML:
- 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 documentation for KML: https://developers.google.com/kml/documentation
Configuration
Parameters
Navigation Tree
Name |
Name specifies the text that will be displayed in the navigation tree of a KML Viewer such as Google Earth. If the feature has a point geometry, it will also be used as the label text. |
Summary |
Summary specifies the text that will be displayed below the feature's name in the navigation tree of a KML Viewer such as Google Earth. |
Visible |
Visibility specifies whether or not the feature will be visible by default when the user first opens the dataset. If the visibility is set to No, the feature will not be displayed. However, the visibility may still be toggled in the navigation tree of a KML Viewer such as Google Earth. |
Description Balloon
Content Type |
Content Type specifies the type of the feature's balloon content. If the type is Text, the contents will be XML entity-encoded when written to the KML file. If the type is HTML, the contents will not be XML entity-encoded, but preserved in such a way that the content will be displayed as valid HTML. |
Content |
Content specifies the text or HTML description to be displayed in the feature's Balloon. |
Include Attribute Table |
Include Attribute Table specifies whether or not a table of the features attributes should be included in the Balloon Content. |
Attribute Table Title |
If the Include Attribute Table parameter is set to Yes, the value of this parameter will be used as the title of the attribute table. |
Additional Files |
If the description contains HTML content, the HTML may require additional files in order to be rendered correctly. Common examples are images, CSS stylesheets and javascript files. The Additional Files parameter may be used to specify the files which are required by the HTML in a feature. The required files should be listed in the “Source File” column. The “Path in Dataset” column may be used to specify where the file should be located within the output KML dataset. Typically, the value in the “path in Dataset” column should just be set to the same path as is given in the HTML. For example, if the HTML contains the following: <img src=”images/pic.jpg”/> The “Path in Dataset” cell would be set to “images/pic.jpg”. If a cell is empty, the corresponding source file will be copied into the root folder of the dataset. If an absolute path is given (for example, /images/pic.jpg), the path will be resolved relative to the root file of the dataset. If a relative path (for example, images/pic.jpg) is given, the path will be resolved relative to the KML file which contains the current feature. |
Geometry
Geometry Type |
Geometry Type specifies the type of geometry properties to apply to the feature. |
Altitude Mode |
Altitude Mode specifies how KML Viewers, such as Google Earth, should interpret the z value of features with vector geometry, or the altitude setting for features with raster geometry. |
Draw Order |
The draw order determines the order in which features are displayed. Features with a higher value will be displayed over features with a lower value. This applies to overlay features and features with line geometries. |
Raster Altitude |
Raster Altitude specifies the altitude, in meters, at which the raster tile should be displayed. This option is not commonly required. |
Raster Opacity |
Raster Opacity specifies the opacity of raster tile when displayed in a KML Viewer, such as Google Earth. This value is a display directive only, and has no effect on the underlying raster geometry. |
Extrude |
Extrude specifies whether or not to connect the geometry of vectors to the ground. KML Viewers, such as Google Earth, will not display extruded geometry unless the Altitude Mode is Absolute, Relative To Ground, or Relative to Sea Floor. |
Follow Terrain |
This option only applies to linear geometries, not points or polygons. While the Altitude Mode parameter sets the behavior of the line vertices, this parameter sets the behavior of the line segments between the vertices. If Follow Terrain is set to Yes, the line segments between vertices will conform to the terrain. If Follow Terrain is set to No, the line segments will be a straight line from one vertex to the next. This will cause the line to hover above low terrain, and be buried underneath higher terrain. KML Viewers, such as Google Earth, will not enable terrain following unless the Altitude Mode is Clamp To Ground or Clamp To Sea Floor. |
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 KMLPropertySetter on the FME Community.
Keywords: "Google Earth" KML