KMLStyler

Categories

Cartography and Reports

Format Specific

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:

Configuration

Parameters

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

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. To edit this parameter, click the browse button to the right of the text field.

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. To edit this parameter, click the browse button to the right of the text field.

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.

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.

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

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. The color value may be selected using the button next to the field, or may be manually entered. The color must be specified as <red>,<green>,<blue> where each of <red>, <green>, and <blue> is a number between 0 and 1.

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

Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click beside the applicable parameter. For more information, see Transformer Parameter Menu Options.

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. There are a number of tools and shortcuts that can assist in constructing values, generally available from the drop-down context menu adjacent to the value field.

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.

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

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.

 

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 samples and information about this transformer on the FME Community.

Keywords: "Google Earth" KML