Class HeatMapModel

Interface for a class HeatMap

Inheritance

System.Object

HeatMapModel

Implements

System.IEquatable<HeatMapModel>

Namespace: Syncfusion.Blazor.HeatMap

Assembly: Syncfusion.Blazor.dll

Syntax

public class HeatMapModel : Object, IEquatable<HeatMapModel>

Constructors

HeatMapModel()

Declaration

public HeatMapModel()

Properties

AllowSelection

Enable or disable the selection of multiple cells in heatmap

Declaration

public bool AllowSelection { get; set; }

Property Value

Type	Description
System.Boolean

CellClick

Triggers when click the heat map cell.

Declaration

public EventCallback<object> CellClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

CellSelected

Triggers when multiple cells gets selected.

Declaration

public EventCallback<object> CellSelected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

CellSettings

Options to customize the heat map cell

Declaration

public CellSettingsModel CellSettings { get; set; }

Property Value

Type	Description
CellSettingsModel

Created

Triggers after heat map rendered.

Declaration

public EventCallback<object> Created { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

DataSource

Specifies the datasource for the heat map.

Declaration

public object DataSource { get; set; }

Property Value

Type	Description
System.Object

DataSourceSettings

Specifies the datasource settings for heat map.

Declaration

public DataModel DataSourceSettings { get; set; }

Property Value

Type	Description
DataModel

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean

Height

The height of the heatmap as a string accepts input as both like '100px' or '100%'. If specified as '100%, heatmap renders to the full height of its parent element.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

LegendSettings

Options for customizing the legend of the heat map

Declaration

public LegendSettingsModel LegendSettings { get; set; }

Property Value

Type	Description
LegendSettingsModel

Load

Triggers before heat map load.

Declaration

public EventCallback<object> Load { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Loaded

Triggers after heatmap is loaded.

Declaration

public EventCallback<object> Loaded { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

Margin

Options to customize left, right, top and bottom margins of the heat map.

Declaration

public MarginModel Margin { get; set; }

Property Value

Type	Description
MarginModel

PaletteSettings

Options for customizing the cell color of the heat map

Declaration

public PaletteSettingsModel PaletteSettings { get; set; }

Property Value

Type	Description
PaletteSettingsModel

RenderingMode

Specifies the rendering mode of heat map. SVG - Heat map is render using SVG draw mode. Canvas - Heat map is render using Canvas draw mode. Auto - Automatically switch the draw mode based on number of records in data source.

Declaration

public DrawType RenderingMode { get; set; }

Property Value

Type	Description
DrawType

Resized

Triggers after resizing of Heatmap.

Declaration

public EventCallback<object> Resized { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

ShowTooltip

Enable or disable the tool tip for heatmap

Declaration

public bool ShowTooltip { get; set; }

Property Value

Type	Description
System.Boolean

Theme

Specifies the theme for heatmap.

Declaration

public HeatMapTheme Theme { get; set; }

Property Value

Type	Description
HeatMapTheme

TitleSettings

Title of heat map

Declaration

public TitleModel TitleSettings { get; set; }

Property Value

Type	Description
TitleModel

TooltipRender

Triggers when click the heat map cell.

Declaration

public EventCallback<object> TooltipRender { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

TooltipSettings

Options for customizing the ToolTipSettings property of the heat map

Declaration

public TooltipSettingsModel TooltipSettings { get; set; }

Property Value

Type	Description
TooltipSettingsModel

Width

The width of the heatmap as a string accepts input as both like '100px' or '100%'. If specified as '100%, heatmap renders to the full width of its parent element.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

XAxis

Options to configure the horizontal axis.

Declaration

public AxisModel XAxis { get; set; }

Property Value

Type	Description
AxisModel

YAxis

Options to configure the vertical axis.

Declaration

public AxisModel YAxis { get; set; }

Property Value

Type	Description
AxisModel

Methods

Equals(HeatMapModel)

Declaration

public bool Equals(HeatMapModel heatMapModel)

Parameters

Type	Name	Description
HeatMapModel	heatMapModel

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<>