Creating group options

note

Two options exist for creating a group: 1) Auto group generation, and 2) Manually defined groups. Option 1 is recommended for most implementations.

Option 1 (Auto groups): tm.group.{group_name}

Description: Defines each group – where {group_name} is a unique name used internally to reference the group option, and the value of the parameter defines the group option.

Value: {value_name}[;{override_list}]|{AUTO_ENUM_LIST}

{value_name}	Any attribute from “CSV_DataTypes.cells” that has ENUM properties.
{override_list}	Optional: Additional tags that override the default group parameters. See the “Group Override Table” below for list and format of overrides.
{AUTO_ENUM_LIST}	Must be included exactly as written, including curly braces, so that groups are automatically generated.

Group Override Table

An optional section of the group definition.

The format for listing multiple group overrides is: {tag1}={value1},{tag2}={value2},...,{tagN}={valueN}

Property	Tag	Value	Parameter it overrides
Group background color	c	hexadecimal color value	tm.group.bg.color.default
Label font	lf	any font defined by one of the tm.font.size.{font_name} parameters	tm.group.label.font.default

Example: "tm.group.Sales_ManagerGRP": "Sales_Manager|{AUTO_ENUM_LIST}", "tm.group.Sales_RegionGRP": "Sales_Region;c=0000ff|{AUTO_ENUM_LIST}",

Option 2 (Manually defined groups): tm.group.{group_name}

Description: Defines each group – where {group_name} is a unique name used internally to reference the group option, and the value of the parameter defines the group option.

Value: {value_name}[;{override_list}]|{group_spec1}|...|{group_specN}

{value_name}	Any attribute from “CSV_DataTypes.cells” that has ENUM properties.
{override_list}	Optional: Additional tags that override the default group parameters. See the “Group Override Table” below for list and format of overrides.
{group_spec}	Manually defines a group. See {group_spec} table below for format.

Group Override Table

An optional section of the group definition.

The format for listing multiple group overrides is: {tag1}={value1},{tag2}={value2},...,{tagN}={valueN}

Property	Tag	Value	Parameter it overrides
Group background color	c	hexadecimal color value	tm.group.bg.color.default
Label font	lf	any font defined by one of the tm.font.size.{font_name} parameters	tm.group.label.font.default

{group_spec}

Value: [{sub_group}];{label};[{description}];{operation};{operation_values}

{group_spec} item	Value	Explanation
{sub_group}	Any value may be entered, or this field can be left blank.	Not used in current version of Flaremap JS.
{label}	any string	This is the group name that a user sees for the group
{description}	Any value may be entered, or this field can be left blank.	Not used in current version of Flaremap JS.
{operation}	See table below for list of operations	Specifies the operation used to define group membership
{operation_values}	See table below for how different operations require different values	Specifies what values the group operation uses to determine group membership

Group operations and values

Description	{operation}	{operation_values}
equals	EQ	Any number or string. Strings are assumed to be enum values
not equals	NEQ	Any number or string. Strings are assumed to be enum values
less than	LT	Any number
less than or equals	LTE	Any number
greater than	GT	Any number
greater than or equals	GTE	Any number
set membership (in a set)	SET	Any comma separated list of numbers or strings. Strings are assumed to be enum values
from (inclusive)... to (inclusive)	[]	Any two comma separated numbers (the second should be larger than the first)
from (not inclusive)... to (inclusive)	(]	Any two comma separated numbers (the second should be larger than the first)
from (inclusive)... to (not inclusive)	[)	Any two comma separated numbers (the second should be larger than the first)
from (not inclusive)... to (not inclusive)	()	Any two comma separated numbers (the second should be larger than the first)
the rest of the items not already in a group	ELSE	No operation value necessary

tm.hierarchy.{hierarchy_name}

Description: Specifies a hierarchical list of groups, with the first listed at the top of the hierarchy, and the last listed at the bottom. Also allows for specification of group option overrides.

Value: {group_name}[`{OPTIONS}]^{group_name2}[`{OPTIONS}]^{group_name3}...

Item	Function	Values
{group_name}	The group to use at this level in the hierarchy. NOTE that this cannot be another GROUP_HIERARCHY definition.	Any {group_name} from the tm.group.{group_name} defined groups
{OPTIONS}	Additional tags that override the default group parameters.	Comma separated list of override options from Group Override Table. See table below.

Group Override Table

An optional section of the group definition.

The format for listing multiple group overrides is: {tag1}={value1},{tag2}={value2},...,{tagN}={valueN}

Property	Tag	Value	Parameter it overrides
Group background color	c	hexadecimal color value	tm.group.bg.color.default
Label font	lf	any font defined by one of the tm.font.size.{font_name} parameters	tm.group.label.font.default

Example: "tm.hierarchy.HierGrp": "Sales_RegionGRP^Sales_ManagerGRP`c=999999,lf=size9" ,