Setting up group, size, and color controls

group

Description: Specifies the group options available to Flaremap end-users in the “Group by” dropdown list.

Value: group|{position_info}|{label_info}|{initial_option}|{written_name1},{group_name1}; ... ; {written_nameN},{group_nameN}

{position_info}	Not used in current version of Flaremap JS. Any value may be entered, or this field can be left blank.
{label_info}	Not used in current version of Flaremap JS. Any value may be entered, or this field can be left blank.
{initial_option}	Specifies the option that is first displayed when the application loads. If nothing is entered the first option is displayed. {initial_option} must match one of {written_name} options.
{written_name}	Specifies the name of an option which appears in the dropdown box control. {written_name} can be any string.
{group_name}	Specifies the internal name of a unique group option previously defined by one of the tm.group.{group_name} parameters or tm.hierarchy.{hierarchy_name} parameters.

Example: "group": "group|-|-|Sales Manager|Sales Region,Sales_RegionGRP; Sales Manager,Sales_ManagerGRP",

size

Description: Specifies the size options available to Flaremap end-users in the “Size by” dropdown list.

Value: size|{position_info}|{label_info}|{initial_option}|{written_name1},{size_option1}[^{override}]; ... ; {written_nameN},{ size_optionN}[^{override}]

{position_info}	Not used in current version of Flaremap JS. Any value may be entered, or this field can be left blank.
{label_info}	Not used in current version of Flaremap JS. Any value may be entered, or this field can be left blank.
{initial_option}	Specifies the option that is first displayed when the application loads. If nothing is entered the first option is displayed. {initial_option} must match one of {written_name} options.
{written_name}	Specifies the name of an option which appears in the dropdown box control. {written_name} can be any string.
{size_option}	Specifies the size option. There are two options for this value: 1) Any attribute from “CSV_DataTypes.cells” that has NUMBER properties. 2) The internal name of a unique size option previously defined in one of the tm.size.option.{size_option} parameters.
{override}	Optional, overrides the size parameter settings for an individual size option. See values below.

{override}

Value	Description	Parameter it overrides
a	Sizes cells based on their absolute values (rather than their original values).	tm.cell.size.abs
i	Inverts the size values.	tm.cell.size.invert
r{#}	Sets the cell size ratio between the smallest and largest cells to the specified number. The values of {#} are described below: {#} = 0: this parameter is ignored {#} = 1: all cells are the same size {#} = 2-50: cells will scale between relatively similar in size (2) and significantly dissimilar in size (50)	tm.cell.size.ratio

Example: "size": "size|-|-|-|Total Sales Q4,Total_Sales_Q4;Quota Q4,Quota_Q4^r9",

color

Description: Specifies the color options available to Flaremap end-users in the “Color by” dropdown list.

Value: color|{position_info};{gradient_position_info}[;{enum_position_info}]|{label_info}| {initial_option}|{written_name1},{color_def1}; ... ; {written_nameN},{ color_defN}}| {group_written_name1},{group_color_def1}; ... ; {group_written_nameN},{group_color_defN}

{position_info}	Not used in current version of Flaremap JS. Any value may be entered, or this field can be left blank.
{gradient_position_info}	Not used in current version of Flaremap JS. Any value may be entered, or this field can be left blank.
{enum_position_info}	Not used in current version of Flaremap JS. Any value may be entered, or this field can be left blank.
{label_info}	Not used in current version of Flaremap JS. Any value may be entered, or this field can be left blank.
{initial_option}	Specifies the option that is first displayed when the application loads. If nothing is entered the first option is displayed. {initial_option} must match one of {written_name} options.
{written_name}	Specifies the name of an option which appears in the dropdown box control. {written_name} can be any string.
{color_def}	Defines how the color option will appear. {color_def} is described in detail below.
{group_written_name}	(Optional) For coloring groups (instead of cells). Same format as {written_name},
{group_color_def}	(Optional) For coloring groups (instead of cells). Same format as color_def, except an aggregate data attribute must be referenced using the a^ override option..

{color_def}

Description: Matches a data attribute with a coloring option.
Value: {color_attribute}^{option_color_method}^p{color_option}[^{color_scale_override}]

{color_attribute}	The data attribute that the cell’s color will be based upon. Must be an attribute from “CSV_DataTypes.cells” that has NUMBER or ENUM properties.
{option_color_method}	Must be set to NodeColorRangeEx
{color_option}	Any {color_option} previously defined by one of the tm.color.range.{color_option} parameters
{color_scale_override}	Optional. By default colors are plotted along a linear color scale. Alternatively, colors can be plotted along a logarithmic color scale. To change the color scale for ALL color options to a logarithmic color scale use the parameter: "tm.color.logscale": "true", For more details on this parameter see section 6.8. To change the color scale for an individual color option use one of the overrides in the table below. {color_scale_override} Description l Forces the color option to be plotted along a logarithmic color scale o Forces the color option to be plotted along a linear color scale (i.e. uses “original values”) a Specify an aggregate data value (e.g. 'sum', 'min', 'max', 'avg', etc) to be used for coloring groups.

Example: "color": "color|-|-|Quota Percent|Quota Percent,Quota_Percent^ NodeColorRangeEx^pQuota_PercentCLR;Total Sales Q4,Total_Sales_Q4^ NodeColorRangeEx^pTotal_Sales_Q4CLR; Sales Region,Sales_Region^ NodeColorRangeEx^pSales_RegionCLR;",