Property Format properties (rv_property

Property	Description
format	The format for the property values. Valid format values are "0", "0.00", "0%", "0.00%", "Date","Datetime", "KPI" or "Text" where property Type = Number or Currency; Or "Date", "Datetime" where Type = Date. Indicates the format for the selected property. If KPI then the highlightgreen property is set to TRUE and disabled. If set to Text then there is no attempt to apply a numeric format to values for this property and it is displayed as retrieved. If there is no value then is displayed as null (not 0). nullasblank property is ignored.
highamber	set background to amber when property values >= this value for the corresponding property.
highred	set background to red when property values >= this value for the corresponding property.
lowamber	set background to amber when property values <= this value for the corresponding property.
lowred	set background to red when property values <= this value for the corresponding property.
highlightgreen	Indicates whether values within the amber and red upper and lower limits are highlighted green. If TRUE, sets the background to green when property values are NOT within the amber and red range, otherwise displays the normal (white) background color. Applicable when the property has at least one highamber, or highred, or lowamber, or lowred defined. If False all values within the amber and red upper and lower limits have no background highlighting (default white). Requires at least one of High Amber, High Red, Low Amber, Low Red to be defined, otherwise ignored. Default = False.
kpisize	used when format = KPI, allows user to set KPI indicators to a certain size. Valid values are 'equal' or 'proportional' Selected from a list: Equal, Proportional. Indicates whether the property is displayed as an equal sized KPI or a KPI that is proportional to the value. When set to proportional a bar will be displayed in the cell, the size of the bar is proportional to the scenarios value for the specified property. It will display the full column width (i.e. 100%) for the largest value and scale down accordingly based on the proportion to this value. The highamber, highred, lowamber, lowred and highlightgreen parameters can be utilized in order to display the appropriate colour ranges (red, amber and green), otherwise it uses the standard chart colour pallet if colour ranges are not specified. Values falling within the red range will be displayed as a red bar. Values within the amber range are displayed as an amber bar. Highlightgreen must be set to TRUE and thus all other values will be displayed as a green bar. When set to Equal an Icon is displayed (red/amber exclamation marks and green tick). The highamber, highred, lowamber, lowred and highlightgreen parameters must be utilized in order to display the appropriate icons. Values falling within the red range will be displayed as a red exclamation mark. Values within the amber range are displayed as an amber exclamation mark. Highlightgreen must be set to TRUE and thus all other values will be displayed as a green tick. Default = Equal, if undefined.
total	TRUE set values to bold. If property is not on the pivot this will be ignored.
insertblank	TRUE inserts a blank row (if property is on Left Dim) or blank column (if property is on Top Dim) in the plansheet after the chosen property. If property is not on the pivot this will be ignored.
chartnumber	(1,2,4). Override default chart type for this property. If property is included in the charted series this will be ignored. Where drawing multiple chart types it should draw in the order of Area, Column, Line from background to foreground to ensure each chart type is visible. Does not support chart types: 3 (Pie), 5 (Bar), 6 (Map heat), 7 (gauge), 8 (Funnel), 9 (Map co-ordinate). 0 has no effect (use rv_property_graphhide). Note that gauge properties defined within the rv_property_format and used only when main chart is set to gauge, do not require the chartnumber to be set to 7
secondaxis	True or False. When True plot this property on an alternate axis. The axis is automatically sized to match all plotted series (where secondaxis = TRUE). If property is included in the charted series this will be ignored. Default = False if not defined, plotting the property on the primary axis, except where property format is %, in which case it defaults to a separate axis. Whether the % format or alternate axis for properties where secondaxis=TRUE is displayed first depends on which is encountered first when iterating through the properties for the plansheets.
stackedtype	0,1 or 2 (None, Stacked, Percentage). Overrides the plansheet default stacked type for this property. If property is not included in the charted series this will be ignored. Only applicable for chart types 1,2,4,5 (Column, Line, Area, Bar), otherwise ignored. Uses the plansheet default stacked type where not defined.
trendproperty	sets the property to use as the trend property for the current property. Only applicable where the default chart type = 7 (Gauge), otherwise ignored. If Property is not included in the charted series this will be ignored.
mingaugeaxis	Entered by the user as a number. Indicates the minimum axis value to be displayed on a gauge chart. If undefined then the minimum axis value on the gauge chart will be 0. If property is not included in the charted series this will be ignored. Only applicable for chart type 7 (Gauge), otherwise ignored.
maxgaugeaxis	Entered by the user as a number. Indicates the maximum value axis to be displayed on a gauge chart. If undefined then the maximum axis value on the gauge chart will be 100. If property is not included in the charted series this will be ignored. Only applicable for chart type 7 (Gauge), otherwise ignored.
nullasblank	Selected from list = True, False. If True will display the property as blank if the value is null/0. If False null/0 values are displayed as 0 (zero). If state = null (undefined) then the default property will be applied. Note that this formatting will also apply to the charts, i.e. null values will not be plotted on charts. Ignored where property is of type Date or format property = Text (null always displayed as blank).
rangeproperty	Selected from a list of properties available for the defined planning engine. Indicates the property on which to base the color coding on. Note: The rangeproperty property does not have to be included in the plansheet. i.e. the values may be fetched but not shown in the pivot or chart.
displayValue	Selected by the user. If True the values for the property will be displayed (as a label) on the chart. if percentage the values are displayed in % format. If False, or undefined, the values are not displayed but will still be visible via tool-tip. Not applicable for rv_chart_number = 7 (Gauge) since the value is always displayed.

format

The format for the property values. Valid format values are "0", "0.00", "0%", "0.00%", "Date","Datetime", "KPI" or "Text" where property Type = Number or Currency; Or "Date", "Datetime" where Type = Date. Indicates the format for the selected property. If KPI then the highlightgreen property is set to TRUE and disabled. If set to Text then there is no attempt to apply a numeric format to values for this property and it is displayed as retrieved. If there is no value then is displayed as null (not 0). nullasblank property is ignored.

highamber

set background to amber when property values >= this value for the corresponding property.

highred

set background to red when property values >= this value for the corresponding property.

lowamber

set background to amber when property values <= this value for the corresponding property.

lowred

set background to red when property values <= this value for the corresponding property.

highlightgreen

Indicates whether values within the amber and red upper and lower limits are highlighted green. If TRUE, sets the background to green when property values are NOT within the amber and red range, otherwise displays the normal (white) background color. Applicable when the property has at least one highamber, or highred, or lowamber, or lowred defined. If False all values within the amber and red upper and lower limits have no background highlighting (default white). Requires at least one of High Amber, High Red, Low Amber, Low Red to be defined, otherwise ignored. Default = False.

kpisize

used when format = KPI, allows user to set KPI indicators to a certain size. Valid values are 'equal' or 'proportional' Selected from a list: Equal, Proportional. Indicates whether the property is displayed as an equal sized KPI or a KPI that is proportional to the value. When set to proportional a bar will be displayed in the cell, the size of the bar is proportional to the scenarios value for the specified property. It will display the full column width (i.e. 100%) for the largest value and scale down accordingly based on the proportion to this value. The highamber, highred, lowamber, lowred and highlightgreen parameters can be utilized in order to display the appropriate colour ranges (red, amber and green), otherwise it uses the standard chart colour pallet if colour ranges are not specified. Values falling within the red range will be displayed as a red bar. Values within the amber range are displayed as an amber bar. Highlightgreen must be set to TRUE and thus all other values will be displayed as a green bar. When set to Equal an Icon is displayed (red/amber exclamation marks and green tick). The highamber, highred, lowamber, lowred and highlightgreen parameters must be utilized in order to display the appropriate icons. Values falling within the red range will be displayed as a red exclamation mark. Values within the amber range are displayed as an amber exclamation mark. Highlightgreen must be set to TRUE and thus all other values will be displayed as a green tick. Default = Equal, if undefined.

total

TRUE set values to bold. If property is not on the pivot this will be ignored.

insertblank

TRUE inserts a blank row (if property is on Left Dim) or blank column (if property is on Top Dim) in the plansheet after the chosen property. If property is not on the pivot this will be ignored.

chartnumber

(1,2,4). Override default chart type for this property. If property is included in the charted series this will be ignored. Where drawing multiple chart types it should draw in the order of Area, Column, Line from background to foreground to ensure each chart type is visible. Does not support chart types: 3 (Pie), 5 (Bar), 6 (Map heat), 7 (gauge), 8 (Funnel), 9 (Map co-ordinate). 0 has no effect (use rv_property_graphhide).

Note that gauge properties defined within the rv_property_format and used only when main chart is set to gauge, do not require the chartnumber to be set to 7

secondaxis

True or False. When True plot this property on an alternate axis. The axis is automatically sized to match all plotted series (where secondaxis = TRUE). If property is included in the charted series this will be ignored. Default = False if not defined, plotting the property on the primary axis, except where property format is %, in which case it defaults to a separate axis. Whether the % format or alternate axis for properties where secondaxis=TRUE is displayed first depends on which is encountered first when iterating through the properties for the plansheets.

stackedtype

0,1 or 2 (None, Stacked, Percentage). Overrides the plansheet default stacked type for this property. If property is not included in the charted series this will be ignored. Only applicable for chart types 1,2,4,5 (Column, Line, Area, Bar), otherwise ignored. Uses the plansheet default stacked type where not defined.

trendproperty

sets the property to use as the trend property for the current property. Only applicable where the default chart type = 7 (Gauge), otherwise ignored. If Property is not included in the charted series this will be ignored.

mingaugeaxis

Entered by the user as a number. Indicates the minimum axis value to be displayed on a gauge chart. If undefined then the minimum axis value on the gauge chart will be 0. If property is not included in the charted series this will be ignored. Only applicable for chart type 7 (Gauge), otherwise ignored.

maxgaugeaxis

Entered by the user as a number. Indicates the maximum value axis to be displayed on a gauge chart. If undefined then the maximum axis value on the gauge chart will be 100. If property is not included in the charted series this will be ignored. Only applicable for chart type 7 (Gauge), otherwise ignored.

nullasblank

Selected from list = True, False. If True will display the property as blank if the value is null/0. If False null/0 values are displayed as 0 (zero). If state = null (undefined) then the default property will be applied. Note that this formatting will also apply to the charts, i.e. null values will not be plotted on charts. Ignored where property is of type Date or format property = Text (null always displayed as blank).

rangeproperty

Selected from a list of properties available for the defined planning engine. Indicates the property on which to base the color coding on.

Note: The rangeproperty property does not have to be included in the plansheet. i.e. the values may be fetched but not shown in the pivot or chart.

displayValue

Selected by the user. If True the values for the property will be displayed (as a label) on the chart. if percentage the values are displayed in % format. If False, or undefined, the values are not displayed but will still be visible via tool-tip. Not applicable for rv_chart_number = 7 (Gauge) since the value is always displayed.

Property Format properties (rv_property_format)