Version

UltraSparkline Property Reference

Introduction

This topic explains the featured properties of the UltraSparkline™ control.

Property reference summary

The following table summarizes the purpose and functionality of the UltraSparkline control’s featured properties. The properties are listed alphabetically for reference purposes.

Property name Description Property type Default

Used to determine the type of Sparkline.

The valid setting are:

  • Line – Displays line type of chart

  • Area – Displays area type of chart

  • Column – Displays column type of chart, same as vertical bars

  • WinLoss – Displays a chart visualizing Win or Loss scenario based on positive and negative values

Line

Styles the Marker for the first data point by setting it to desired color. The color can be specified in one of the following:

  • Name of the color

  • Hexadecimal code of the color

Brush

Not set

Specifies the size of the Marker on the first data point. The valid settings are all positive numbers and they indicate the size in pixels. If a negative number is used, it will convert the number into a positive, for example –3 will be treated as 3.

Double

3

Visibility setting of the Marker for the first data point. The valid settings are:

  • Visible – The marker is visible.

  • Collapsed – The marker is hidden (not shown).

Visibility

Not set

Styles the Marker for the highest data point by setting it to desired color. The color can be specified in one of the following:

  • Name of the color

  • Hexadecimal code of the color

Brush

Not set

Specifies the size of the Marker on the highest data point. The valid settings are all positive numbers and they indicate the size in pixels. If a negative number is used, it will convert the number into a positive, for example –3 will be treated as 3.

Double

3

Visibility setting of the Marker for the highest data point. The valid settings are:

  • Visible – The marker is visible.

  • Collapsed – The marker is hidden (not shown).

Visibility

Not set

Visibility setting allows displaying the horizontal line of X axis.

Only the minimum and maximum values per axis will display, because of the size limitation of the Sparkline.

The valid settings are:

  • Visible – Displays the horizontal line of the X axis showing the first and last values outside of the axis.

  • Collapsed – Does not display the horizontal line for X axis.

Visibility

Not set

Identifies the labels on X axis when the Horizontal axis is visible.

String (the Name of the field to display as a label)

Not set

Specifies the color of the Marker on the last data point. The color can be specified in one of the following:

  • Name of the color

  • Hexadecimal code of the color

Brush

Not set

Specifies the size of the Marker on the last data point. The valid settings are all positive numbers and they indicate the size in pixels. If a negative number is used, it will convert the number into a positive, for example –3 will be treated as 3.

Double

3

Visibility setting of the Marker for the last data point. The valid settings are:

  • Visible – The marker is visible.

  • Collapsed – The marker is hidden (not shown).

Visibility

Not set

Specifies the color of the Marker on the lowest data point. The color can be specified in one of the following:

  • Name of the color

  • Hexadecimal code of the color

Brush

Not set

Specifies the size of the Marker on the lowest data point. The valid settings are all positive numbers and they indicate the size in pixels. If a negative number is used, it will convert the number into a positive, for example –3 will be treated as 3.

Double

3

Visibility setting of the Marker for the lowest data point. The valid settings are:

  • Visible – The marker is visible.

  • Collapsed – The marker is hidden (not shown).

Visibility

Not set

Specifies the color of the Marker on all data points. The color can be specified in one of the following:

  • Name of the color

  • Hexadecimal code of the color

Brush

Not set

Specifies the size of the Marker on all data points. The valid settings are all positive numbers and they indicate the size in pixels. If a negative number is used, it will convert the number into a positive, for example –3 will be treated as 3.

Double

3

Visibility setting of the Marker for all data point. The valid settings are:

  • Visible – The markers are visible.

  • Collapsed – The markers are hidden (not shown).

Visibility

Collapsed

Specifies the color of the Marker on the negative data points. The color can be specified in one of the following:

  • Name of the color

  • Hexadecimal code of the color

Brush

Not set

Specifies the size of the Marker on the negative data point. The valid settings are all positive numbers and they indicate the size in pixels. If a negative number is used, it will convert the number into a positive, for example –3 will be treated as 3.

Double

3

Visibility setting of the markers on the negative data points.

The valid settings are:

  • Visible – The markers are visible.

  • Collapsed – The markers are hidden (not shown)

Visibility

Not set

Specifies the color of the Normal Range.

Brush

Gray color

Specifies the upper boarder of the Normal Range.

Double

Not set

Specifies the lower boarder of the Normal Range.

Double

Not set

Visibility setting of the Normal Range on the data points.

The valid settings are:

  • Visible – The Normal Range is visible.

  • Collapsed – The Normal Range is hidden (not shown).

Visibility

Not set

Enables or disables the tooltip. If enabled ( Visible ), it displays the tooltip when the the mouse pointer is over the chart. The enabled tooltip displays the first, last, high and low data points by default.

The available valid options are:

  • Visible – The tooltip is enabled.

  • Collapsed – The tooltip is hidden (disabled).

Visibility

Collapsed

Specifies the color of the Trend Line. The color can be specified in one of the following:

  • Name of the color

  • Hexadecimal code of the color

Brush

Gray color

Feeds the seed in calculation formula for the different Trend Line types. Used for calculating average type trend lines.

The valid settings are 1÷255, representing the specific number of data points the average types use to smooth out the fluctuation in data.

For example, if the period is set to 2 then the average of the first 2 data points is used as the first point, then the average of the next two data points will be used as the second point and so on.

Double

7

Thickness of the Trend Line in pixels.

Double

1

Draws a directional trend line over the Sparkline chart. The valid settings reflect the supported Trend Line:

  • CubicFit – Specifies a cubic polynomial fit trend line on a series.

  • CumulativeAverage – Specifies a cumulative moving average trend line on a series.

  • ExponentialAverage – Specifies an exponential moving average trend line on a series.

  • ExponentialFit – Specifies an exponential fit trend line on a series.

  • LinearFit – Specifies a linear fit trend line on a series.

  • LogarithmicFit – Specifies a logarithmic fit trend line on a series.

  • ModifiedAverage – Specifies a modified moving average trend line on a series.

  • PowerLawFit – Specifies a power-law fit trend line on a series.

  • QuadraticFit – Specifies a quadratic polynomial fit trend line on a series.

  • QuarticFit – Specifies a quartic polynomial fit trend line on a series.

  • QuinticFit – Specifies a quintic polynomial fit trend line on a series.

  • SimpleAverage – Specifies a simple moving average trend line on a series.

  • WeightedAverage – Specifies a weighted moving average trend line on a series.

  • None – Disables the Trend Line feature. No trend line is displayed.

TrendLineType

Not set

Identifies and plots the unknown data points (null values). The valid settings are:

  • LinearInterpolate – Connects the previous point to the next point with a line or area over the null value.

  • DontPlot – Displays a blank for the null data point.

Effective only on with Line and Area Sparkline types.

String

DontPlot

Identifies the numeric property from the underlying data as the Sparkline data points. This identification is necessary for displaying the Sparkline data points.

String (the Name of the field to display the chart)

Not set

Visibility setting of the Y axis. Displays the axis line, along with the minimum and maximum axis values. (Only the minimum and maximum values per axis will display, because of the size limitation of the Sparkline.)

The valid settings are:

  • Visible – Displays the Vertical line of Y axis showing the highest and lowest values outside of the axis.

  • Collapsed – Does not display the vertical line for Y axis.

String

Not set

Related Content

The following topics provide additional information related to this topic.

Topic Purpose

This topic provides an overview of the UltraSparkline control, its benefits, and the supported chart types.

This topic provides an overview of the possible ways to configure the UltraSparkline control. Links to the detailed configurations (available in separate topics) are provided as well.