Measure Format properties

Property	Description
format	Indicates the format used to display measure values. The valid format values for the Number or Currency type measure are 0, 0.00, 0%, 0.00%, KPI, or Text. The valid format values for the Date type measure are Date and Datetime. Note: If this value is not specified, the format defined for the measure is used. If this value is set to KPI, the highlightgreen property must be set to True. If this value is set to Text, numeric formatting is not applied, and the values are displayed as retrieved. If no value exists, the value is displayed as null instead of 0. The nullasblank property is not considered.
highamber	Sets the background to amber when the scenario values >= the value for the corresponding measure.
highred	Sets the background to red when the scenario values >= the value for the corresponding measure.
lowamber	Sets the background to amber when the scenario values <= the value for the corresponding measure.
lowred	Sets the background to red when the scenario values <= the value for the corresponding measure.
highlightgreen	Indicates whether values that are not within the amber and red ranges are highlighted green. If TRUE, sets the background to green when scenario values are not within the amber and red conditions. If FALSE, these values are displayed with the normal background color. Applicable where the measure has at least one highamber, or highred, or lowamber, or lowred defined. When format is set to KPI, this value must be set to TRUE.
kpisize	Indicates if the measure is displayed as an equal sized KPI or a KPI that is proportional to the value. Can be set to either 'proportional' or 'equal'. When set to Proportional, a bar is displayed in the cell. The size of the bar is proportional to the value of the scenarios for the specified measure. The full column width (100%) is displayed for the largest value and scaled down accordingly, based on the proportion to this value. The highamber, highred, lowamber, lowred, and highlightgreen parameters can be utilized to display the appropriate color range (Red, Amber, and Green). If a color range is not specified, the standard chart color pallet is used. Values within the Red range are displayed as a Red bar. Values within the Amber range are displayed as an Amber bar. The highlightgreen parameter must be set to TRUE, consequently all other values are displayed as a Green bar. When set to Equal, an icon is displayed (Red/Amber exclamation marks and a Green check mark). The highamber, highred, lowamber, lowred, and highlightgreen parameters must be utilized to display the appropriate icons. Values within the red range are displayed as a Red exclamation mark. Values within the amber range are displayed as an Amber exclamation mark. The highlightgreen parameter must be set to TRUE, consequently all other values are displayed as a green check mark. By default, the value is set Equal.
total	If TRUE, sets the values to bold. If measure is not defined on the pivot, this condition is ignored.
insertblank	If TRUE, a blank row (if measure is on Left Dim) or blank column (if measure is on Top Dim) is inserted, in the worksheet after the selected measure. If the measure is not defined on the pivot, the same is ignored.
chartnumber (1, 2 and 4)	Overrides the default chart type for this measure. If the measure is included in the charted series this parameter is ignored. Where drawing multiple chart types the data must be retrieved in this order; Area, Column, Line from background to foreground to ensure that each chart type is displayed. The 3 (Pie), 5 (Bar),6 (Map heat), 7 (gauge), 8 (Funnel), 9 (Map co-ordinate) chart types, are not supported . The value 0 does not impact this parameter (use rv_measure_graphhide). Note: The gauge properties are defined in rv_measure_format and used only when main chart is set to gauge. The chart number is not required to be set to 7.
secondaxis	When TRUE, the measure is plotted on an alternate axis. This axis is automatically resized to match all the plotted series (where secondaxis = TRUE). If the measure is included in the charted series this parameter is ignored. By default, the value is set to FALSE, and the measure is plotting the measure on the primary axis. However, when the measure format is %, in which case the axis is defaulted to an alternate axis. Whether the % format or alternate axis for measures where secondaxis=TRUE is displayed first, is based on how the data is read when iterating through the measures for the worksheets.
stackedtype	0,1 or 2 (None, Stacked, Percentage). Overrides the default worksheet, stacked type for this measure. If Measure is not included in the charted series this measure is not considered. This is only applicable for chart types, 1,2,4,5 (Column, Line, Area, and Bar). If not defined, the default worksheet, stacked type is used.
nullasblank	When True, the measure is displayed as blank if the value is null/0. If False, null/0 values are displayed as 0 (zero). If state = null (undefined), by default the measure property value is applied. Note: This format is also applied to the charts, that is, null values are not plotted on the charts. When the Measure is of the type, Date or format property = Text (null always displayed as blank) the value is not considered. For example, to display null/0 values as blank cells instead of 0: `<Table> <Row name="[SOP_ERRPER]"> <Property name="format" value="0%" /> <Property name="highamber" value="0.2" /> <Property name="highred" value="0.4" /> <Property name="highlightgreen" value="TRUE" /> <Property name="nullasblank" value="TRUE" /> </Row> </Table>`
trendmeasure	The measure that must be used as the trend measure for the current measure. Only applicable if the default chart type = 7 (Gauge). If the measure is not included in the charted series, the trend measure is not considered.
mingaugeaxis	Indicates the minimum axis value to be displayed on a gauge chart. This is only applicable for the chart type = 7 (Gauge). The value is specified as a number. If the value is not defined, the minimum axis value on the gauge chart is displayed as 0. If the measure is not included in the chart series, the mingaugeaxis is not considered.
maxgaugeaxis	Indicates the maximum axis value to be displayed on a gauge chart. This is only applicable for the chart type = 7 (Gauge). The value is specified as a number. If the value is not defined, the maximum axis value on the gauge chart is displayed as 100. If the measure is not included in the chart series, the maxgaugeaxis is not considered.
rangemeasure	Indicates the measure on which the color coding is based. The measure is selected from the list of measures available in the defined worksheet module. Note: The range measure is not required to be included in the worksheet.
displayValue	If the value is set to: True: the values for the measure is displayed as label on the chart. False (or not defined): the values are not displayed on the chart; however, you can view the values using the tool-tip. Percentage: the values are displayed in % format. This property is not applicable for rv_chart_number = 7 (Gauge) as the value is always displayed.

format

Indicates the format used to display measure values.

The valid format values for the Number or Currency type measure are 0, 0.00, 0%, 0.00%, KPI, or Text.

The valid format values for the Date type measure are Date and Datetime.

Note:

If this value is not specified, the format defined for the measure is used.
If this value is set to KPI, the highlightgreen property must be set to True.

If this value is set to Text, numeric formatting is not applied, and the values are displayed as retrieved. If no value exists, the value is displayed as null instead of 0. The nullasblank property is not considered.

highamber

Sets the background to amber when the scenario values >= the value for the corresponding measure.

highred

Sets the background to red when the scenario values >= the value for the corresponding measure.

lowamber

Sets the background to amber when the scenario values <= the value for the corresponding measure.

lowred

Sets the background to red when the scenario values <= the value for the corresponding measure.

highlightgreen

Indicates whether values that are not within the amber and red ranges are highlighted green. If TRUE, sets the background to green when scenario values are not within the amber and red conditions. If FALSE, these values are displayed with the normal background color. Applicable where the measure has at least one highamber, or highred, or lowamber, or lowred defined. When format is set to KPI, this value must be set to TRUE.

kpisize

Indicates if the measure is displayed as an equal sized KPI or a KPI that is proportional to the value. Can be set to either 'proportional' or 'equal'. When set to Proportional, a bar is displayed in the cell. The size of the bar is proportional to the value of the scenarios for the specified measure. The full column width (100%) is displayed for the largest value and scaled down accordingly, based on the proportion to this value. The highamber, highred, lowamber, lowred, and highlightgreen parameters can be utilized to display the appropriate color range (Red, Amber, and Green). If a color range is not specified, the standard chart color pallet is used. Values within the Red range are displayed as a Red bar. Values within the Amber range are displayed as an Amber bar. The highlightgreen parameter must be set to TRUE, consequently all other values are displayed as a Green bar. When set to Equal, an icon is displayed (Red/Amber exclamation marks and a Green check mark). The highamber, highred, lowamber, lowred, and highlightgreen parameters must be utilized to display the appropriate icons. Values within the red range are displayed as a Red exclamation mark. Values within the amber range are displayed as an Amber exclamation mark. The highlightgreen parameter must be set to TRUE, consequently all other values are displayed as a green check mark. By default, the value is set Equal.

total

If TRUE, sets the values to bold. If measure is not defined on the pivot, this condition is ignored.

insertblank

If TRUE, a blank row (if measure is on Left Dim) or blank column (if measure is on Top Dim) is inserted, in the worksheet after the selected measure. If the measure is not defined on the pivot, the same is ignored.

chartnumber (1, 2 and 4)

Overrides the default chart type for this measure. If the measure is included in the charted series this parameter is ignored. Where drawing multiple chart types the data must be retrieved in this order; Area, Column, Line from background to foreground to ensure that each chart type is displayed. The 3 (Pie), 5 (Bar),6 (Map heat), 7 (gauge), 8 (Funnel), 9 (Map co-ordinate) chart types, are not supported . The value 0 does not impact this parameter (use rv_measure_graphhide).

Note: The gauge properties are defined in rv_measure_format and used only when main chart is set to gauge. The chart number is not required to be set to 7.

secondaxis

When TRUE, the measure is plotted on an alternate axis. This axis is automatically resized to match all the plotted series (where secondaxis = TRUE). If the measure is included in the charted series this parameter is ignored.

By default, the value is set to FALSE, and the measure is plotting the measure on the primary axis. However, when the measure format is %, in which case the axis is defaulted to an alternate axis. Whether the % format or alternate axis for measures where secondaxis=TRUE is displayed first, is based on how the data is read when iterating through the measures for the worksheets.

stackedtype

0,1 or 2 (None, Stacked, Percentage). Overrides the default worksheet, stacked type for this measure. If Measure is not included in the charted series this measure is not considered. This is only applicable for chart types, 1,2,4,5 (Column, Line, Area, and Bar). If not defined, the default worksheet, stacked type is used.

nullasblank

When True, the measure is displayed as blank if the value is null/0. If False, null/0 values are displayed as 0 (zero). If state = null (undefined), by default the measure property value is applied.

Note: This format is also applied to the charts, that is, null values are not plotted on the charts. When the Measure is of the type, Date or format property = Text (null always displayed as blank) the value is not considered.

For example, to display null/0 values as blank cells instead of 0:

<Table>
<Row name="[SOP_ERRPER]"> 
<Property name="format" value="0%" /> 
<Property name="highamber" value="0.2" />
<Property name="highred" value="0.4" />
<Property name="highlightgreen" value="TRUE" />
<Property name="nullasblank" value="TRUE" />
</Row>
</Table>

trendmeasure

The measure that must be used as the trend measure for the current measure. Only applicable if the default chart type = 7 (Gauge). If the measure is not included in the charted series, the trend measure is not considered.

mingaugeaxis

Indicates the minimum axis value to be displayed on a gauge chart. This is only applicable for the chart type = 7 (Gauge). The value is specified as a number.

If the value is not defined, the minimum axis value on the gauge chart is displayed as 0.

If the measure is not included in the chart series, the mingaugeaxis is not considered.

maxgaugeaxis

Indicates the maximum axis value to be displayed on a gauge chart. This is only applicable for the chart type = 7 (Gauge). The value is specified as a number.

If the value is not defined, the maximum axis value on the gauge chart is displayed as 100.

If the measure is not included in the chart series, the maxgaugeaxis is not considered.

rangemeasure

Indicates the measure on which the color coding is based. The measure is selected from the list of measures available in the defined worksheet module.

Note: The range measure is not required to be included in the worksheet.

displayValue

If the value is set to:

True: the values for the measure is displayed as label on the chart.
False (or not defined): the values are not displayed on the chart; however, you can view the values using the tool-tip.
Percentage: the values are displayed in % format.

This property is not applicable for rv_chart_number = 7 (Gauge) as the value is always displayed.