Version

Common Properties

Purpose

This topic provides information about the properties and methods that the hover interaction feature uses for highlighting, hovering and interacting with the tooltip interactions inherited from the Series class.

Required background

The following topics are prerequisites to understanding this topic:

Topic Purpose

The UltraDataChart control requires a data object model to be mapped to control’s DataSource property. This article will provide a simple data object model but you can create your own and use it with this sample code instead.

This topic explains various types of Category Series in the UltraDataChart control.

Overview

Common properties overview

The hover interactions layers inherit those Series base class properties and methods that are relevant in the context of hover interactions. For example, hover interactions, by design do not interact with the mouse, so they do not raise the mouse events. Also, the interaction layers do not display data directly, so methods such as ScrollIntoView are not applicable for this feature.

Common Properties

Common Items summary

The following table summarizes the Series class properties inherited by the hover interaction classes.

Property Name Property Type Description

Brush

The hover interaction layers inherit their Brush from the series with whom they are interacting. However, this can be overridden by setting the Brush property directly.

Brush

This property follows the same guidelines as the Brush property, listed above.

Point

This property specifies the world position to use instead of the default mouse position (NaN, NaN). When this property is set, it fixes the particular layer on the provided world position.

Note
Note:

A world position contains x and y values which range from 0 to 1 representing the global position of the cursor relative to the entire ranges of the axes.

bool

This property specifies if the series default crosshair should be disabled when there is a hover interactions layer on the chart. The default value is True.

bool

This property specifies if the hover interactions layer should use a series index and reserve a color in the Brushes collection that is assigned to the UltraDataChart control. The default value is False.

bool

This property specifies if the hover interactions layer should appear in the legend. When this property is set to true, it also indexes the series as it is required to appear in the legend. In order be recognized in the legend you must assign a single color to the series. The default value is False.

Setting the Inherited Properties on a Crosshair Layer

Example

The following screenshot illustrates how the UltraDataChart control’s CrosshairLayer looks using the following settings:

Property Value

0.55, 0.55

True

WF Common Properties 1.png

Following is the code used in this implementation

In C#:

CrosshairLayer crosshairLayerSeries = new CrosshairLayer();
crosshairLayerSeries.UseLegend = true;
crosshairLayerSeries.CursorPosition = new Infragistics.Win.DataVisualization.Point(0.55, 0.55);
crosshairLayerSeries.Title = "CrosshairLayer";
crosshairLayerSeries.Legend = legend;
chart.Series.Add(crosshairLayerSeries);

Related Content

Topics

Topic Purpose

This topic provides conceptual information about the hover interactions available on the UltraDataChart™ control including the different types of hover interaction layers available.

This topic provides information about the crosshair layer used for hover interactions. It describes the properties of the crosshair layer and provides an implementation example.

This topic provides information about the category item highlight layer used for hover interactions. It describes the properties of the category item highlight layer and provides an example of its implementation.

This topic provides information about the category tooltip layer used for hover interactions. It describes the properties of the category tooltip layer and provides an example of its implementation.

This topic provides information about the item tooltip layer which is used for hover interactions. It describes the properties of the item tooltip layer and also provides an example of its implementation.