bulletgraph-configuring-the-comparative-marker.adoc

Configuring Comparative Marker

Topic Overview

Purpose

This topic explains, with code examples, how to configure the comparative measure marker of the {BulletGraphName}™ control. This includes the marker’s value, width, and formatting.

Required background

The following topics are prerequisites to understanding this topic:

Topic	Purpose
{BulletGraphName} Overview	This topic provides conceptual information about the {BulletGraphName} control including its main features, minimum requirements, and user functionality.
Adding {BulletGraphName}	This topic explains how to add the {BulletGraphName} control to a {PlatformName} application.

In this topic

This topic contains the following sections:

• Configuring the Comparative Marker

  • Comparative marker configuration summary

  • Comparative marker configuration summary chart

  • Property settings

  • Example

• Related Content

  • Topics

Configuring the Comparative Marker

Comparative marker configuration summary

The comparative marker indicates a mark on the scale against which the value denoted by the performance bar is compared. This comparative value can be some sort of a target to aim for (like target sales volume) or a limit that not to be exceeded (as the 98.6°F/37°C mark on a medical thermometer scale).

The value indicated by the comparative marker (and its position on the scale, respectively) is set by the TargetValue property. The comparative marker is customizable in terms of position and size across the scale ( TargetValueInnerExtent and TargetValueOuterExtent), breadth ( TargetValueBreadth) and look-and-feel (fill color – TargetValueBrush, border thickness – TargetValueStrokeThickness, border color – TargetValueOutline) using the respective properties.

Comparative marker configuration summary chart

The following table explains briefly the configurable aspects of {BulletGraphName} control’s comparative marker and maps them to properties that configure them.

Configurable aspects	Property	Default value
Name	TargetValueName	Not set
Value indicated	TargetValue	Not set
Breadth	TargetValueBreadth	3.0
Inner edge	TargetValueInnerExtent	0.3
Outer edge	TargetValueOuterExtent	0.85
Fill color	TargetValueBrush	Default color
Border thickness	TargetValueStrokeThickness	1.0
Border color	TargetValueOutline	Default color

Property settings

The following table maps the desired behavior to its respective property settings.

In order to configure:	Details	Use this property:	And set it to:
Name	A name for the comparative marker pick:[sl,wpf="(for displaying in the tooltip)"]	TargetValueName	A string expressing the name of the comparative marker
Value to indicate	The value to indicate	TargetValue	The desired value of the measures in the scale
Breadth	The breadth of the marker	TargetValueBreadth	The desired value in pixels
Inner edge	The position of the lower edge of the comparative marker at horizontal orientation or the left edge at vertical orientation.	TargetValueInnerExtent	The desired value as a relative part of the height/width of the Graph area (depending on the orientation) presented as a fraction of 1 (e.g. 0.2 )
Outer edge	The position of the top edge of the comparative marker at horizontal orientation or the right edge at vertical orientation.	TargetValueOuterExtent	The desired value as a relative part of the height/width of the Graph area (depending on the orientation) presented as a fraction of 1 (e.g. 0.2 )
Fill color	Fill color of the marker	TargetValueBrush	The desired color
Border thickness	Thickness of the marker’s border	TargetValueStrokeThickness	The desired value in pixels
Border color	Configure the color of the marker’s border	TargetValueOutline	The desired color

Example

The screenshot below demonstrates how the {BulletGraphName} looks as a result of the following settings:

Property	Value
TargetValue	“70”
TargetValueBreadth	“10”
TargetValueBrush	“Yellow”
TargetValueInnerExtent	“0.2”
TargetValueOuterExtent	“0.7”
TargetValueOutline	“DarkGreen ”
TargetValueStrokeThickness	“3”

Following is the code that implements this example.

Related Content

Topics

The following topics provide additional information related to this topic.

Topic	Purpose
Configuring the Scale ( {BulletGraphName} )	This topic explains, with examples, how to configure the scale of the {BulletGraphName} control. This includes positioning the scale inside the control and configuring the scale tick marks and labels.
Configuring the Performance Bar ( {BulletGraphName} )	This topic explains, with examples, how to configure the performance bar of the {BulletGraphName} control. This includes the value indicated by the bar, its width, position, and formatting.
Configuring Comparative Ranges ( {BulletGraphName} )	This topic explains, with code examples, how to configure ranges in the {BulletGraphName} control. This includes the number of ranges and their positions, lengths, widths, and formatting.
Configuring the Background ( {BulletGraphName} )	This topic explains, with code examples, how to configure a background for the bullet graph. This includes setting the background’s size, position, color, and border.