Class
HeatMapDefinition

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

Definition

Constructors

HeatMapDefinition()

Initializes a new instance of the HeatMapDefinition class.

Declaration

cs-api-definition
protected HeatMapDefinition()

Properties

ColumnsCount

Gets the columns count.

Declaration

cs-api-definition
public int ColumnsCount { get; }

Property Value

int

DataSource

Gets or sets the data source.

Declaration

cs-api-definition
[Browsable(true)]
public object DataSource { get; set; }

Property Value

object

DataView

Gets the DataView collection.

Declaration

cs-api-definition
[Browsable(false)]
public RadCollectionView<HeatMapDataItem> DataView { get; }

Property Value

RadCollectionView<HeatMapDataItem>

Items

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

Declaration

cs-api-definition
[Browsable(false)]
public HeatMapDataItemCollection Items { get; protected set; }

Property Value

HeatMapDataItemCollection

ListSource

Gets the source of the items.

Declaration

cs-api-definition
[Browsable(false)]
public RadListSource<HeatMapDataItem> ListSource { get; }

Property Value

RadListSource<HeatMapDataItem>

RowsCount

Gets the rows count.

Declaration

cs-api-definition
public int RowsCount { get; }

Property Value

int

Source

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

Declaration

cs-api-definition
protected abstract IHeatMapSource Source { get; }

Property Value

IHeatMapSource

Methods

CreateBindingContext()

Creates the binding context.

Declaration

cs-api-definition
protected virtual BindingContext CreateBindingContext()

Returns

BindingContext

CreateDataItem()

Declaration

cs-api-definition
protected abstract HeatMapDataItem CreateDataItem()

Returns

HeatMapDataItem

CreateListSource()

Creates the list source.

Declaration

cs-api-definition
protected virtual RadListSource<HeatMapDataItem> CreateListSource()

Returns

RadListSource<HeatMapDataItem>

Dispose(bool)

Declaration

cs-api-definition
protected override void Dispose(bool disposing)

Parameters

disposing

bool

Overrides Component.Dispose(bool)

GetColor(CellIndex)

Declaration

cs-api-definition
public int GetColor(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Returns

int

GetColor(int, int)

Gets the color of the cell.

Declaration

cs-api-definition
public abstract int GetColor(int rowIndex, int columnIndex)

Parameters

rowIndex

int

The row index.

columnIndex

int

The column index.

Returns

int

The color of the cell.

GetColumnHeader(int)

Gets the header of the corresponding column.

Declaration

cs-api-definition
public abstract object GetColumnHeader(int index)

Parameters

index

int

The column index.

Returns

object

The header of the corresponding column.

GetDataItem(CellIndex)

Declaration

cs-api-definition
public HeatMapDataItem GetDataItem(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Returns

HeatMapDataItem

GetDataItem(int, int)

Declaration

cs-api-definition
public HeatMapDataItem GetDataItem(int rowIndex, int columnIndex)

Parameters

rowIndex

int

columnIndex

int

Returns

HeatMapDataItem

GetForeColor(Color)

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

Declaration

cs-api-definition
public virtual Color GetForeColor(Color backColor)

Parameters

backColor

Color

The background color.

Returns

Color

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

GetRowHeader(int)

Gets the header of the corresponding row.

Declaration

cs-api-definition
public abstract object GetRowHeader(int index)

Parameters

index

int

The row index.

Returns

object

The header of the corresponding row.

GetValue(CellIndex)

Declaration

cs-api-definition
public double GetValue(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Returns

double

GetValue(int, int)

Declaration

cs-api-definition
public double GetValue(int rowIndex, int columnIndex)

Parameters

rowIndex

int

columnIndex

int

Returns

double

InitializeHeatMap()

Declaration

cs-api-definition
public void InitializeHeatMap()

ItemsPropertyChanged()

Declaration

cs-api-definition
protected void ItemsPropertyChanged()

NewItem()

Declaration

cs-api-definition
public IDataItem NewItem()

Returns

IDataItem

Implements IDataItemSource.NewItem()

OnDataItemCreating(HeatMapItemCreatingEventArgs)

Fires the ItemCreating event.

Declaration

cs-api-definition
protected virtual void OnDataItemCreating(HeatMapItemCreatingEventArgs args)

Parameters

args

HeatMapItemCreatingEventArgs

The event arguments.

OnItemDataBound(HeatMapItemEventArgs)

Fires the ItemDataBound event.

Declaration

cs-api-definition
protected virtual void OnItemDataBound(HeatMapItemEventArgs args)

Parameters

args

HeatMapItemEventArgs

The event arguments.

OnItemsChanged()

This method is called when the Items changes.

Declaration

cs-api-definition
protected abstract void OnItemsChanged()

Events

ItemCreating

Occurs when a HeatMapDataItem needs to be created.

Declaration

cs-api-definition
public event HeatMapItemCreatingEventHandler ItemCreating

Event Value

HeatMapItemCreatingEventHandler

ItemDataBound

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

Declaration

cs-api-definition
public event HeatMapItemEventHandler ItemDataBound

Event Value

HeatMapItemEventHandler