New to Telerik UI for WinFormsStart a free 30-day trial

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

Definition

Constructors

Initializes a new instance of the HeatMapDefinition class.

C#
protected HeatMapDefinition()

Properties

Gets the columns count.

C#
public int ColumnsCount { get; }

Gets or sets the data source.

C#
[Browsable(true)]
public object DataSource { get; set; }

Gets the DataView collection.

C#
[Browsable(false)]
public RadCollectionView<HeatMapDataItem> DataView { get; }

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

C#
[Browsable(false)]
public HeatMapDataItemCollection Items { get; protected set; }

Gets the source of the items.

C#
[Browsable(false)]
public RadListSource<HeatMapDataItem> ListSource { get; }

Gets the rows count.

C#
public int RowsCount { get; }

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

C#
protected abstract IHeatMapSource Source { get; }

Methods

Creates the binding context.

C#
protected virtual BindingContext CreateBindingContext()
Returns:

BindingContext

C#
protected abstract HeatMapDataItem CreateDataItem()
Returns:

HeatMapDataItem

Creates the list source.

C#
protected virtual RadListSource<HeatMapDataItem> CreateListSource()
Returns:

RadListSource<HeatMapDataItem>

C#
protected override void Dispose(bool disposing)
Parameters:disposingbool

Overrides: Component.Dispose(bool)

C#
public int GetColor(CellIndex cellIndex)
Parameters:cellIndexCellIndexReturns:

int

Gets the color of the cell.

C#
public abstract int GetColor(int rowIndex, int columnIndex)
Parameters:rowIndexint

The row index.

columnIndexint

The column index.

Returns:

int

The color of the cell.

Gets the header of the corresponding column.

C#
public abstract object GetColumnHeader(int index)
Parameters:indexint

The column index.

Returns:

object

The header of the corresponding column.

C#
public HeatMapDataItem GetDataItem(CellIndex cellIndex)
Parameters:cellIndexCellIndexReturns:

HeatMapDataItem

C#
public HeatMapDataItem GetDataItem(int rowIndex, int columnIndex)
Parameters:rowIndexintcolumnIndexintReturns:

HeatMapDataItem

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

C#
public virtual Color GetForeColor(Color backColor)
Parameters:backColorColor

The background color.

Returns:

Color

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

Gets the header of the corresponding row.

C#
public abstract object GetRowHeader(int index)
Parameters:indexint

The row index.

Returns:

object

The header of the corresponding row.

C#
public double GetValue(CellIndex cellIndex)
Parameters:cellIndexCellIndexReturns:

double

C#
public double GetValue(int rowIndex, int columnIndex)
Parameters:rowIndexintcolumnIndexintReturns:

double

C#
public void InitializeHeatMap()
C#
protected void ItemsPropertyChanged()
C#
public IDataItem NewItem()
Returns:

IDataItem

Implements: IDataItemSource.NewItem()

Fires the ItemCreating event.

C#
protected virtual void OnDataItemCreating(HeatMapItemCreatingEventArgs args)
Parameters:argsHeatMapItemCreatingEventArgs

The event arguments.

Fires the ItemDataBound event.

C#
protected virtual void OnItemDataBound(HeatMapItemEventArgs args)
Parameters:argsHeatMapItemEventArgs

The event arguments.

This method is called when the Items changes.

C#
protected abstract void OnItemsChanged()

Events

Occurs when a HeatMapDataItem needs to be created.

C#
public event HeatMapItemCreatingEventHandler ItemCreating

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

C#
public event HeatMapItemEventHandler ItemDataBound