Skip to content

Latest commit

 

History

History
862 lines (572 loc) · 32.3 KB

bulletgraph-overview.adoc

File metadata and controls

862 lines (572 loc) · 32.3 KB

Overview of Bullet Graph Features

Topic Overview

Purpose

This topic provides conceptual information about the {BulletGraphName}™ control including its main features, minimum requirements, and user functionality.

Required background

The following concept is required for understanding this topic.

Introduction

{BulletGraphName} summary

The {BulletGraphName} control is an {ProductName} control which allows for visualizing data in the form of a bullet graph. Linear by design, it provides a simple and concise view of a primary measure compared against a scale and, optionally, some other measure.

BulletGraph Overview 1

The {BulletGraphName} control provides you with the ability to create attractive data presentations, replacing meters and gauges that are used on dashboards with simple yet straightforward and clear bar charts. A bullet graph is one of the most effective and efficient ways to present progress towards goals, good/better/best ranges, or compare multiple measurements in as little horizontal or vertical space as possible.

Main Features

Main features summary

The features of {BulletGraphName} include configurable orientation and direction, configurable visual elements, and more. The control has also a built-in support for animated transitions.

Main features summary chart

The following table summarizes the main features of the {BulletGraphName} control.

Feature Description

Configurable orientation and direction

The {BulletGraphName} control exposes an API for setting the state of its scale’s orientation and direction, so that the look of the graph can be largely customized. (For details, see the Configuring the Orientation and Direction topic.)

Configurable visual elements

Each of the visual elements of the bullet graph can be configured in several aspects. (For details, see Configurable Visual Elements of {BulletGraphName} and Related Properties.)

Animated transitions

The {BulletGraphName} control provides built-in support for animation by its TransitionDuration property. The animation effect occurs on loading the control as well as when the value of any of its properties is changed. (For details, see Animated Transitions Configuration.)

Logical areas and Configurable Visual Elements Summary

Logical areas

The user-visible area of the {BulletGraphName} control is logically divided into the following areas: pick:[sl,wpf="Title area,"] Reserved area, and Graph area.

Each of them serves different purpose related to some of the visual elements of the {BulletGraphName} control.

The main purpose of the Reserved area is to provide enough space for the numbering labels of the scale at any orientation – horizontal or vertical (The Reserved area automatically re-sizes when the orientation changes in order to accommodate the specific space requirements for displaying the numbering labels in each of the orientations: in horizontal orientation, the area has to fit the labels’ height and in vertical orientation – their maximum width.) This doesn’t mean that you must necessarily place the numbering labels in the Reserved area: actually, you can position the label row across-the-scale anywhere within the Graph area. However, even if you place the label row outside Reserved area, this will have no bearing on the spread and location of the Reserved area itself – it remains where it is, automatically defined through the height/width (depending on the orientation) of the numbering labels.

Another aspect in which the Reserved area is significant is the fact that its inner edge specifies the beginning edge of the Graph area in the across-the-scale dimension. This is important, because this edge serves as a reference mark for the extent-related properties that position some Configurable visual elementsvisual elements across the scale. (Positive values for these properties – the most common case – position the visual elements inside the Graph area and negative values – inside the Reserved area.)

Spread of the Graph area:

  • Along the scale – the Graph area begins pick:[sl,wpf="either"] at the edge of the control pick:[sl,wpf="(when no Title area exists) or at the edge of the Title area (as in the pictures above)"] and ends at the edge of the control. Both the starting and ending positions of the scale are measured against the starting edge of the Graph area (the left edge at horizontal orientation or bottom edge at vertical orientation).

  • Across the scale – the Graph area begins at the edge of the Reserved area (this is the bottom edge of the Graph area at horizontal orientation or its left edge at vertical orientation). The edge of the Graph area that borders with the Reserved area serves as reference point for the extent-related properties of some of the visual elements of the scale (for positioning these elements across the scale).

Configurable visual elements

The {BulletGraphName} control features the following visual elements pick:[sl,wpf="(See the picture below.):"]

  • Performance bar pick:[sl,wpf="(3)"] – This is the primary measure displayed by the control and is visualized as a bar.

  • Comparative marker pick:[sl,wpf="(4)"] – A measure which the performance bar measure compares against. It is visualized as a marker that runs perpendicular to the orientation of the performance bar.

  • Comparative range(s) pick:[sl,wpf="(5)"] – The ranges are visual elements that highlight a specified range of values on a scale. Their purpose is to visually communicate the qualitative state of the performance bar measure, illustrating at the same times the degree to which it resides within that state.

  • Tick marks pick:[sl,wpf="(6)"] –The tick marks serve as a visual division of the scale into intervals in order to increase the readability of the bullet graph.

    • Major tick marks – The major tick marks are used as primary delimiters on the scale. The frequency they appear at, their extents and style can be controlled by setting the corresponding properties.

    • Minor tick marks – The minor tick marks represent helper tick marks, which might be used to additionally improve the readability of the scale and can be customized in a way similar to the major ones.

  • Scale labels pick:[sl,wpf="(7)"] – The labels indicate the measures on the scale.

  • Border pick:[sl,wpf="(8)"] – The line visually delimiting the dimensions of the control.

  • Background pick:[sl,wpf="(9)"] – The background on which visual elements is placed is configurable in terms of pattern and color.

Configurable Visual Elements and Related Properties

Configurable visual elements and related properties summary

There are several specific aspects in which each element can be configured.

The following table provides an overview of the configurable aspects of the visual elements of the {BulletGraphName} control. Further details about the configurable aspects with illustrations and the properties that configure them are available, for each visual element, in the blocks that follow the table:

Visual element Main configurable aspects
  • Position

  • Tick marks

  • Labels

  • Value indicated

  • Width and position

  • Look-and-feel

  • Value indicated

  • Width

  • Look-and-feel

  • Number (of ranges in the graph)

  • Length, width, and position

  • Look-and-feel

  • Size and position

  • Look-and-feel

Scale

The following pictures illustrate the scale-related extents, listed in the table below.

Extent positioning the scale within the Graph area Extents configuring the position of the labels
BulletGraph Overview 9
BulletGraph Overview 10
Extents configuring the major tick marks along the scale Extents configuring the major tick marks across the scale
BulletGraph Overview 11
BulletGraph Overview 12
Extents configuring the minor tick marks across the scale
BulletGraph Overview 13

The following table maps the configurable aspects related to the scale of the bullet graph to the {BulletGraphName} properties that manage them.

Configurable aspects Property Default value

Position

0.05

0.95

Min value

0

Max value

100

Major tick marks

Not set

0

0

0.02

0.2

Defined in the default theme

2.0

Minor tick marks

3.0

0.06

0.2

Defined in the default theme

1.0

Labels

0

Not set

0

0

Defined in the default theme

Performance bar

The following picture illustrates the performance-bar-related extents, listed in the table below.

BulletGraph Overview 88

The following table maps the configurable aspects related to the performance bar of the bullet graph to the {BulletGraphName} properties that manage them.

Configurable aspects Property Default value

Name

Not set

Value to indicate

Not set

Breadth and position

0.5

0.65

Fill color

Defined in the default theme

Border color

Defined in the default theme

Border thickness

1.0

Comparative marker

The following picture illustrates the comparative-market-related extents, listed in the table below.

BulletGraph Overview 15

The following table maps the configurable aspects related to the comparative marker of the bullet graph to the {BulletGraphName} properties that manage them.

Configurable aspects Property Default value

Value indicated

Not set

Breadth

3.0

Fill color

Defined in the default theme

Border color

Defined in the default theme

Border thickness

1.0

Comparative ranges

The following picture illustrates the comparative-ranges-related extents, listed in the table below.

BulletGraph Overview 16

The following table maps the configurable aspects related to the comparative ranges of the bullet graph to the {BulletGraphName} properties that manage them.

Configurable aspects Property Default value

Number (of ranges in the graph)

pick:[sl,wpf=" {BulletGraphName}.Ranges"]

pick:[android=" {BulletGraphName}.addRange"]

Not set

Length, width, and position

Not set

Not set

Not set

Not set

Not set

Not set

Fill color

Defined in the default theme

Border color

Defined in the default theme

Border thickness

1.0

Background

The following picture illustrates the background-related extents, listed in the table below.

BulletGraph Overview 17

The following table maps the configurable aspects related to the background of the bullet graph to the {BulletGraphName} properties that manage them.

Configurable aspects Property Default value

Spread and position (across the scale)

0

1.0

Color

Defined in the default theme

Border color

Defined in the default theme

Border thickness

2.0

Animated Transitions Configuration

Animated transitions configuration summary

The {BulletGraphName} control provides built-in support for animation by its TransitionDuration property. The animation effect occurs on loading the control as well as when the value of any of its properties is changed. By default, animated transitions are disabled. Providing a value in milliseconds for the TransitionDuration property of the control determines the timeframe for swiping the control into view by smoothly visualizing all its visual elements through a slide effect (from bottom-left to top-right). Setting the value to 0 disables the animated transition. pick:[sl="For a demonstration of the animation transition effect, see the"] pick:[sl=" Animated Transitions sample."] pick:[wpf=" Animated Transitions sample."]

Default Configuration

Default configuration summary

By default, the {BulletGraphName} control is oriented horizontally. It displays with a scale starting at 0 and ending at 100. The major tick marks of the control are located at an interval of 10 and the count of minor tick marks between each pair of major tick marks is 3. There is no title/subtitle displayed, the background color is a variety of light grey. The border is 2 pixels thick colored in dark grey. No comparative marker or ranges are displayed. Animated transitions are disabled.

The following picture demonstrates a {BulletGraphName} displayed with default settings.

BulletGraph Overview 18

Requirements

Requirements summary

The {BulletGraphName} control is a {PlatformName} control and a part from the pick:[android="jars"] pick:[wpf,win-universal,win-forms="assembly"] , containing the control itself, it depends on several other pick:[android="jars"] pick:[wpf,win-universal,win-forms="assembly"] pick:[wpf,win-universal="such as {ApiPlatform}{ApiVersion}.dll and {ApiPlatform}DataVisualization{ApiVersion}.dll."] pick:[wpf,win-universal,win-forms=""] Provided the required pick:[android="jars"] pick:[wpf,win-universal,win-forms="assembly"] are loaded correctly, a declaration with the Infragistics XML namespace is needed in the {PlatformName} component where the control is used.

In order for the bullet graph to display the performance bar, the Value property has to be set.

For the full requirements listing, refer to the Adding {BulletGraphName} topic.

Related Content

Topics

The following topics provide additional information related to this topic.

Topic Purpose

This is a group of topics explaining how to configure the various aspects of the {BulletGraphName} control including its orientation and direction and visual elements.

This topic provides reference information about the key classes and properties related to the {BulletGraphName} control.

This topic provides information about the known issues and limitations of the {BulletGraphName} control.

Resource

The following material (available outside the Infragistics family of content) provides additional information related to this topic.

Title Purpose

This is a PDF document explaining the bullet graph conceptually and providing design recommendations.