FME Transformers: 2024.2

Categories
Cartography and Reports

Cartography and Reports

Related Transformers
FeatureColorSetter
Categories
Cartography and Reports

Cartography and Reports

Related Transformers
FeatureColorSetter

GeometryColorSetter

Sets colors, via appearances, on geometries (such as surfaces) that support appearances, and match a Geometry XQuery.

For ease of reference, these geometries are called matching geometries. Existing appearances are removed from these matching geometries before new appearances are added.

When Color Generation is set to Random, this transformer creates uniformly spaced, random colors. The randomized colors are the same each time you run the workspace, facilitating visualization and demo creation.

For more information on appearance support in FME, see Appearances.

Example

Input

Output: Random

Output: Randomize by Trait

Configuration

Input Ports

This transformer accepts features with geometries that support appearances.

Output Ports

All input features that have gained new appearances are output here.

All input features where no geometry part matches the Geometry XQuery are output here.

All input features whose geometry types do not support appearances are output here.

Parameters

Geometry XQuery

Use this parameter to isolate only a portion of the input geometry.

If no criteria are specified, the action will apply to the entire geometry at all levels.

Selection can be based on structural location, geometry name, type, appearance information, traits, trait storage types, or definition reference. The syntax used is a restricted set of XQuery, where the return clause is fixed.

The basic Geometry XQuery dialog allows you to construct simple selection queries by automatically writing the necessary query based on specified test clauses. Clicking the Switch to Advanced button opens the Advanced Editor, which allows you to type a query free-form, for more expressive queries.

Note  Once you switch to Advanced mode, you will have to clear all parameters before you can return to Basic mode.

A hierarchical geometry is represented as nodes of type geometry, with attributes containing information about traits, type, and name for each geometry.

Color Generation

Fixed: Sets all matching geometries to a single color and a single alpha value.

Random: Sets all matching geometries to random colors and a single alpha value, subject to the Randomize By Trait parameter. The randomization algorithm is deterministic, so the set of output colors will be the same each time you run the workspace.

Side(s) To Color

For a matching geometry, this parameter specifies which side(s) of the geometry to color.

Fill Color

When Color Generation is set to Fixed, use this parameter to set a single color for all matching geometries.

Specifying Colors

Colors may be entered directly or chosen from the color picker via the ellipsis button.

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 (#).

 

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

Not Available

 #FFFFFF

Alpha

Specifies the transparency level of the appearance to be added: 0.0 is completely transparent and 1.0 is completely opaque.

Randomize By Trait

When Color Generation is set to Random, this parameter controls the scope of randomization. If this parameter is left blank, every matching geometry will receive a different color.

If a trait name is specified, all geometries with the same trait value will be given the same color, and geometries with different trait values will be given different colors.

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.

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.

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.

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.

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 GeometryColorSetter on the FME Community.