RadzenHeatmapSeries<TItem> Class

A chart series that renders a grid of colored cells (a heatmap). Each data item provides an X coordinate (CategoryProperty), a Y coordinate (ValueProperty) and an intensity value (IntensityProperty) that drives the cell color. Cell color is picked from . When no range matches, is used. Both and must be numeric.

Inheritance

Object

ComponentBase

RadzenChartComponentBase

CartesianSeries<TItem>

RadzenHeatmapSeries<TItem>

Implements

IComponent

IHandleEvent

IHandleAfterRender

IChartSeries

IChartValueAxisSeries

Inherited Members

CartesianSeries<TItem>.RequireChart

CartesianSeries<TItem>.ComposeCategory

CartesianSeries<TItem>.ComposeValue

CartesianSeries<TItem>.IsValueNullable

CartesianSeries<TItem>.GetRawValueGetter

CartesianSeries<TItem>.IsDate

CartesianSeries<TItem>.IsNumeric

CartesianSeries<TItem>.GetCategories

CartesianSeries<TItem>.RenderOverlays

CartesianSeries<TItem>.RenderTopOverlays

CartesianSeries<TItem>.SetParametersAsync

CartesianSeries<TItem>.Initialize

CartesianSeries<TItem>.MeasureLegend

CartesianSeries<TItem>.MeasureLegendItems

CartesianSeries<TItem>.InsidePolygon

CartesianSeries<TItem>.RenderTooltip

CartesianSeries<TItem>.RenderSharedTooltipItem

CartesianSeries<TItem>.GetTooltipPosition

CartesianSeries<TItem>.TooltipStyle

CartesianSeries<TItem>.TooltipClass

CartesianSeries<TItem>.GetMedian

CartesianSeries<TItem>.GetMean

CartesianSeries<TItem>.GetMode

CartesianSeries<TItem>.GetTrend

CartesianSeries<TItem>.GetScaledDataPoints

CartesianSeries<TItem>.GetTitle

CartesianSeries<TItem>.TooltipLabel

CartesianSeries<TItem>.GetDataLabels

CartesianSeries<TItem>.PickColor

CartesianSeries<TItem>.Dispose

CartesianSeries<TItem>.InvokeClick

CartesianSeries<TItem>.ValueAxisName

CartesianSeries<TItem>.Title

CartesianSeries<TItem>.ChildContent

CartesianSeries<TItem>.TooltipTemplate

CartesianSeries<TItem>.Overlays

CartesianSeries<TItem>.CoordinateSystem

CartesianSeries<TItem>.CategoryProperty

CartesianSeries<TItem>.Visible

CartesianSeries<TItem>.Hidden

CartesianSeries<TItem>.ShowInLegend

CartesianSeries<TItem>.ValueProperty

CartesianSeries<TItem>.RenderingOrder

CartesianSeries<TItem>.Data

CartesianSeries<TItem>.Items

CartesianSeries<TItem>.Markers

CartesianSeries<TItem>.MarkerType

CartesianSeries<TItem>.ShowActivePoint

CartesianSeries<TItem>.ShowLineInLegend

CartesianSeries<TItem>.MarkerSize

RadzenChartComponentBase.ShouldRefreshChart

RadzenChartComponentBase.ValidateParameters

RadzenChartComponentBase.DidParameterChange

RadzenChartComponentBase.Chart

ComponentBase.OnInitialized

ComponentBase.OnInitializedAsync

ComponentBase.OnParametersSet

ComponentBase.OnParametersSetAsync

ComponentBase.StateHasChanged

ComponentBase.ShouldRender

ComponentBase.OnAfterRender

ComponentBase.OnAfterRenderAsync

ComponentBase.InvokeAsync

ComponentBase.DispatchExceptionAsync

ComponentBase.RendererInfo

ComponentBase.Assets

ComponentBase.AssignedRenderMode

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenHeatmapSeries<TItem> : CartesianSeries<TItem>, IComponent, IHandleEvent, IHandleAfterRender, IChartSeries, IChartValueAxisSeries

Type Parameters

Name Description
TItemThe type of data items in the series.

Examples

<RadzenChart>
    <RadzenHeatmapSeries Data=@grid CategoryProperty="X" ValueProperty="Y" IntensityProperty="Lux"
        ColorRange="@ranges" Title="Illuminance" />
    <RadzenCategoryAxis Min="0" Max="5" />
    <RadzenValueAxis Min="0" Max="5" />
</RadzenChart>

Constructors

RadzenHeatmapSeries<TItem>link

A chart series that renders a grid of colored cells (a heatmap). Each data item provides an X coordinate (CategoryProperty), a Y coordinate (ValueProperty) and an intensity value (IntensityProperty) that drives the cell color. Cell color is picked from . When no range matches, is used. Both and must be numeric.

Declaration
public RadzenHeatmapSeries<TItem>()

Properties

CellHeightlink

The height of each cell in axis units. When 0 (default) the height is inferred from the smallest gap between unique Y values in the data.

Declaration
public double CellHeight { get; set; }
Property Value
Type Description
doubleThe height of each cell in axis units. When 0 (default) the height is inferred from the smallest gap between unique Y values in the data.

CellWidthlink

The width of each cell in axis units. When 0 (default) the width is inferred from the smallest gap between unique X values in the data.

Declaration
public double CellWidth { get; set; }
Property Value
Type Description
doubleThe width of each cell in axis units. When 0 (default) the width is inferred from the smallest gap between unique X values in the data.

Colorlink

Declaration
public string Color { get; }
Property Value
Type Description
string

ColorRangelink

The value-to-color mapping for cells. Each range specifies a Min, Max and Color. Cells with an intensity falling inside a range are filled with its color.

Declaration
public IList<SeriesColorRange> ColorRange { get; set; }
Property Value
Type Description
IList<SeriesColorRange>The value-to-color mapping for cells. Each range specifies a Min, Max and Color. Cells with an intensity falling inside a range are filled with its color.

Filllink

The default fill color applied to cells whose intensity does not match any entry in ColorRange.

Declaration
public string Fill { get; set; }
Property Value
Type Description
stringThe default fill color applied to cells whose intensity does not match any entry in ColorRange.

IntensityLabellink

The label used for the intensity dimension in the tooltip. Defaults to "Value".

Declaration
public string IntensityLabel { get; set; }
Property Value
Type Description
stringThe label used for the intensity dimension in the tooltip. Defaults to "Value".

IntensityPropertylink

The name of the numeric property of TItem that provides the cell intensity (the value mapped to color).

Declaration
public string IntensityProperty { get; set; }
Property Value
Type Description
stringThe name of the numeric property of TItem that provides the cell intensity (the value mapped to color).

Strokelink

The cell border color.

Declaration
public string Stroke { get; set; }
Property Value
Type Description
stringThe cell border color.

StrokeWidthlink

The cell border width in pixels.

Declaration
public double StrokeWidth { get; set; }
Property Value
Type Description
doubleThe cell border width in pixels.

Methods

BuildRenderTreelink

Declaration
protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)
Parameters
Type Name Description
Rendering.RenderTreeBuilder __builder

Containslink

Declaration
public override bool Contains(double x, double y, double tolerance)
Parameters
Type Name Description
double x
double y
double tolerance
Returns
Type Description
bool

DataAtlink

Declaration
public override ValueTuple<object, Point> DataAt(double x, double y)
Parameters
Type Name Description
double x
double y
Returns
Type Description
ValueTuple<object, Point>

Renderlink

Declaration
public override RenderFragment Render(ScaleBase categoryScale, ScaleBase valueScale)
Parameters
Type Name Description
ScaleBase categoryScale
ScaleBase valueScale
Returns
Type Description
RenderFragment

RenderLegendItemlink

Declaration
protected override RenderFragment RenderLegendItem(bool clickable)
Parameters
Type Name Description
bool clickable
Returns
Type Description
RenderFragment

TooltipTitlelink

Declaration
protected override string TooltipTitle(TItem item)
Parameters
Type Name Description
TItem item
Returns
Type Description
string

TooltipValuelink

Declaration
protected override string TooltipValue(TItem item)
Parameters
Type Name Description
TItem item
Returns
Type Description
string

TransformCategoryScalelink

Declaration
public override ScaleBase TransformCategoryScale(ScaleBase scale)
Parameters
Type Name Description
ScaleBase scale
Returns
Type Description
ScaleBase

TransformValueScalelink

Declaration
public override ScaleBase TransformValueScale(ScaleBase scale)
Parameters
Type Name Description
ScaleBase scale
Returns
Type Description
ScaleBase
An error has occurred. This app may no longer respond until reloaded. Reload 🗙