Documentation

Class HeatMapDefinition

A base class for the definitions based on which a RadHeatMap is constructed.

Inheritance
System.Object
HeatMapDefinition
CategoricalDefinition
MemberDefinitionBase
Namespace: Telerik.WinControls.UI.HeatMap
Assembly: Telerik.WinControls.UI.dll

Syntax

public abstract class HeatMapDefinition : Component, IDataItemSource

Constructors

HeatMapDefinition()

Initializes a new instance of the HeatMapDefinition class.

Declaration
protected HeatMapDefinition()

Properties

ColumnsCount

Gets the columns count.

Declaration
public int ColumnsCount { get; }
Property Value
System.Int32

DataSource

Gets or sets the data source.

Declaration
public object DataSource { get; set; }
Property Value
System.Object

DataView

Gets the DataView collection.

Declaration
public RadCollectionView<HeatMapDataItem> DataView { get; }
Property Value
RadCollectionView<HeatMapDataItem>

Items

Gets a collection of HeatMapDataItem objects which represent the items in RadHeatMap.

Declaration
public HeatMapDataItemCollection Items { get; protected set; }
Property Value
HeatMapDataItemCollection

ListSource

Gets the source of the items.

Declaration
public RadListSource<HeatMapDataItem> ListSource { get; }
Property Value
RadListSource<HeatMapDataItem>

RowsCount

Gets the rows count.

Declaration
public int RowsCount { get; }
Property Value
System.Int32

Source

Gets the collection source used internally by the heat map definition.

Declaration
protected abstract IHeatMapSource Source { get; }
Property Value
IHeatMapSource

Methods

CreateBindingContext()

Creates the binding context.

Declaration
protected virtual BindingContext CreateBindingContext()
Returns
System.Windows.Forms.BindingContext

CreateDataItem()

Declaration
protected abstract HeatMapDataItem CreateDataItem()
Returns
HeatMapDataItem

CreateListSource()

Creates the list source.

Declaration
protected virtual RadListSource<HeatMapDataItem> CreateListSource()
Returns
RadListSource<HeatMapDataItem>

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

GetColor(Int32, Int32)

Gets the color of the cell.

Declaration
public abstract int GetColor(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

The row index.
System.Int32 columnIndex

The column index.
Returns
System.Int32

The color of the cell.

GetColor(CellIndex)

Declaration
public int GetColor(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Returns
System.Int32

GetColumnHeader(Int32)

Gets the header of the corresponding column.

Declaration
public abstract object GetColumnHeader(int index)
Parameters
System.Int32 index

The column index.
Returns
System.Object

The header of the corresponding column.

GetDataItem(Int32, Int32)

Declaration
public HeatMapDataItem GetDataItem(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

System.Int32 columnIndex

Returns
HeatMapDataItem

GetDataItem(CellIndex)

Declaration
public HeatMapDataItem GetDataItem(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Returns
HeatMapDataItem

GetForeColor(Color)

Gets the foreground color based on the darkness of the background.

Declaration
public virtual Color GetForeColor(Color backColor)
Parameters
System.Drawing.Color backColor

The background color.
Returns
System.Drawing.Color

If the background is dark returns System.Drawing.Color.White foreground color, othewise returns System.Drawing.Color.Black.

GetRowHeader(Int32)

Gets the header of the corresponding row.

Declaration
public abstract object GetRowHeader(int index)
Parameters
System.Int32 index

The row index.
Returns
System.Object

The header of the corresponding row.

GetValue(Int32, Int32)

Declaration
public double GetValue(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

System.Int32 columnIndex

Returns
System.Double

GetValue(CellIndex)

Declaration
public double GetValue(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Returns
System.Double

InitializeHeatMap()

Declaration
public void InitializeHeatMap()

ItemsPropertyChanged()

Declaration
protected void ItemsPropertyChanged()

NewItem()

Declaration
public IDataItem NewItem()
Returns
IDataItem

Implements

OnDataItemCreating(HeatMapItemCreatingEventArgs)

Fires the ItemCreating event.

Declaration
protected virtual void OnDataItemCreating(HeatMapItemCreatingEventArgs args)
Parameters
HeatMapItemCreatingEventArgs args

The event arguments.

OnItemDataBound(HeatMapItemEventArgs)

Fires the ItemDataBound event.

Declaration
protected virtual void OnItemDataBound(HeatMapItemEventArgs args)
Parameters
HeatMapItemEventArgs args

The event arguments.

OnItemsChanged()

This method is called when the Items changes.

Declaration
protected abstract void OnItemsChanged()

Events

ItemCreating

Occurs when a HeatMapDataItem needs to be created.

Declaration
public event HeatMapItemCreatingEventHandler ItemCreating
Event Type
HeatMapItemCreatingEventHandler

ItemDataBound

Occurs when a data-bound item is being attached to a HeatMapDataItem.

Declaration
public event HeatMapItemEventHandler ItemDataBound
Event Type
HeatMapItemEventHandler

Explicit Interface Implementations

IDataItemSource.BindingComplete()

Declaration
void IDataItemSource.BindingComplete()
Implements

IDataItemSource.BindingContext

Declaration
BindingContext IDataItemSource.BindingContext { get; }
Returns
System.Windows.Forms.BindingContext

Implements

IDataItemSource.BindingContextChanged

Declaration
event EventHandler IDataItemSource.BindingContextChanged
Returns
System.EventHandler

Implements

IDataItemSource.Initialize()

Initializes IDataItemSource.

Declaration
void IDataItemSource.Initialize()
Implements

IDataItemSource.MetadataChanged(PropertyDescriptor)

Declaration
void IDataItemSource.MetadataChanged(PropertyDescriptor pd)
Parameters
System.ComponentModel.PropertyDescriptor pd

Implements

Extension Methods