ExcelConditionalFormatter

Sets conditional rules and styles on features destined for Excel formats.

Typical Uses

Preparing data for presentation in Excel.

How does it work?

The ExcelConditionalFormatter creates a Conditional Formatting rule that can be managed in Excel using the Conditional Formatting Rules Manager dialog.

Multiple rules can be added by chaining additional transformers together.

When adding multiple attributes to the rule, values such as average, rank, unique or duplicate values are evaluated across the entire combined range and not just the single attribute column.

Usage Notes

Excel formulas that return an error will not apply the style. Testing formulas in Excel is recommended.
For more information regarding Excel styling, see the FME Readers and Writers help topic Microsoft Excel Writer Parameters. In particular, see the Formatting section under Usage Notes.

Configuration

Parameters

Range

Apply to

Select the range to apply this rule to:

All Attributes as One Combined Range
Selected Attributes as One Combined Range

The entire combined range is used to compute the values of the conditional format rule.

Selected Attributes

When Apply to is Selected Attributes as One Combined Range, select one or more attributes to apply the conditional rule.

If a header row is written it will be automatically excluded from the rule.

Rule

Type

Select a rule type to define:

Format Selected Range Based on Values	Style cells using either a 2-color or 3-color scale to apply a color gradation to the data. These rules do not have a style but use configured colors to apply a gradient.
Format Only Cells That Contain	Use either numeric, text or date based comparison operators to apply the style. Also styles attributes with blanks, no blanks, errors and no errors.
Format Only Top or Bottom Ranked Values in Selected Range	Style only the highest or lowest values for all combined attributes in the range based on a cutoff value or percentage.
Format Only Values Above or Below Range Average	Calculate the average for all combined attributes and style those above or below the average or one, two or three standard deviations.
Format Only Unique or Duplicate Values in Selected Range	Style only unique or duplicate values in the combined selected range.

Rule > Format Selected Range Based on Values

Format Style

Select a style:

2-Color Scale: Apply a two-color gradation based on values.
3-Color Scale: Apply a three-color gradation based on values, including a midpoint value.

Selected

Select the range to apply this

Format

Specify values and colors for each point in the gradient - Minimum, Maximum, and Midpoint (when Format Style is 3-Color Scale).

Type

Lowest Value	Applies the selected color gradient starting at the lowest value in the combined range.
Highest Value	End the color gradient at the highest value in the combined range.
Formula	Use an excel formula that evaluates to the value. The formula must return a number, date, or time value and begin with a ‘=’.
Constant Value	Specify a constant value.
Percentage	Style values based on a proportional value percent. Values must be between 0 and 100.
Percentile	Style values based on the lowest or highest percentile of values. Value must be between 0 and 100.

Value

Formula

As applicable, provide a value or Excel formula.

Color

For each point, select a 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).

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.

Rule > Format Only Cells That Contain

Format Only Cells With

Value Matching a Comparison Condition

Highlight cell values using a numeric comparison operator.

Comparison Operator

Select an operator to compare cells based on their values:

Between: Highlight values between the given values.
Not Between: Highlight values not between the given values.
Equal: Highlight values equal to the given value.
Not Equal: Highlight values not equal to the given value.
Greater Than: Highlight values greater than the given value.
Less Than: Highlight values that are less than the given value.
Greater Than or Equal: Highlight values greater or equal to the given value.
Less Than or Equal: Highlight values less than or equal to the given value.

Comparison Value A

Specify the value to use in the comparison operation.

Numeric values can be a number, date, or time. A formula that returns a number, date or time value can also be used.

Formulas must begin with an equal sign (=). Invalid formulas result in no formatting applied.

Comparison Value B

When Comparison Operator is Between or Not Between, provide a second value.

Text Matching a Comparison Condition

Highlighting based on specific text.

Comparison Operator

Select an operator to compare cells based on their values:

Containing: Matches values containing the given text value.
Not Containing: Matches values that do not contain any of the text values.
Begins with: Matches values that begin with the given text.
Ends with: Matches values end with the given text.

Comparison Text

Enter in the text value to use in the comparison operation.

Quotes used in the text value are included in the search string. Maximum text length is 255 characters.

A formula can be used that returns text. Wildcard characters can be used in the search string:

Asterisk (*) Any value zero or more.
Question mark (?) Any single character.
Tilde (~) escape for an actual asterisk, question or tilde.

Dates Occurring

Highlight cells based on a relative date range.

Date Range

Enter in the text value to use in the comparison operation.

Select a date comparison to apply a style to.

Yesterday: Values with a date equal to the previous day.
Today: Values with a date equal to the current date.
Tomorrow: Values with a date equal to the next day.
In the Last 7 Days: Values with a date between today and 7 days in the past.
Last week: Values with a date occurring since the 1st day of the current week. The first day of the week depends on your specific locale settings. In Windows this can be found under Language & region settings.
This week: Values with a date occurring between the first and last day of the current week.
Next week: Values with a date occurring between the first and last day of the next week.
Last Month: Values with a date occurring since the 1st day of the current month.
This Month: Values with a date occurring between the first and last day of the current month.
Next Month: Values with a date in the next calendar month.

Blanks

Style cells that are empty.

No Blanks

Style cells that are not empty.

Errors

Style cells containing an error. Error values include: #####, #VALUE!, #DIV/0!, #NAME?, #N/A, #REF!, #NUM!, and #NULL!.

No Errors

Style cells that do not contain an error.

Rule > Format Only Top or Bottom Ranked Values in Selected Range

Format Values Ranked In

Select the type of ranking:

Top
Bottom

Rank Value

Specify the top or bottom number. Valid values are between 1 and 1000 as items, between 1 and 100 for percentage.

Rank By

Select a ranking method:

Items: Style the number of items in the top or bottom Rank Value.
Percentage: Style the percentage of cells in the top or bottom Rank Value.

Number

Custom

Defines a custom number format string for the cell. This value will override any format string in the cell for an existing sheet or template sheet.

The custom format string can be created using Microsoft's rules for creating a custom number format.

Custom number string examples:

To display:	as:	use the code:
1234.59	1234.6	###.#
12 1234.568	12.0 1234.57	#.0#
January 2, 2015	2015/01/02	yyyy/mm/dd
1000 -1000	$1,000 ($1,000)	$#,##0_);[Red]($#,##0)

The Custom field also supports a set of commonly used standard formats used in Excel.

Note that these common values may display with a prefix resembling [$-409] and/or a suffix resembling ;@. These additions exist to ensure that these number formats are properly recognized as standard formats once written to Excel, instead of custom format strings.

Font

Style

Select a font style to apply:

Blank: Do not change the font style.
Regular: Change the font to regular text by removing bold or italic style.
Italic: Change the font to italic text.
Bold: Change the font to bold text.
Bold and Italic: Change the font to bold and italic.

Underline

Select an underlining style to apply:

Blank: Do not change the underline style.
None: Remove any underline style.
Single: Underline the value with a single line.
Double: Underline the value with a double line.

Strikethrough

Select a strikethrough style to apply:

Blank: Do not change the strikethrough style.
No: Remove the strikethrough style from the values.
Single: Add a strikethrough style to the values.

Color

Select a text color to apply.

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.

Border

Border Style

Select a border pattern to apply.

Border Color

Select a border color to apply.

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.

Fill

Background Color

Specify the background color of the Pattern Style selected.

To set the background color of the cell, set the Background Color and the Pattern Style to Solid.

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.

Pattern Color

Specify the foreground color of the pattern.

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.

Pattern Style

Specify the pattern used to fill the cell, using the colors from Pattern Color and Background Color.

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