ASP.NET Core - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class HeatMapBuilder - ASP.NETCore-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class HeatMapBuilder

    Inheritance
    System.Object
    ControlBuilder
    HeatMapBuilder
    Inherited Members
    ControlBuilder.Context
    Namespace: Syncfusion.EJ2.HeatMap
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class HeatMapBuilder : ControlBuilder

    Constructors

    HeatMapBuilder()

    Declaration
    public HeatMapBuilder()

    HeatMapBuilder(HeatMap)

    Declaration
    public HeatMapBuilder(HeatMap model)
    Parameters
    Type Name Description
    HeatMap model

    Fields

    model

    Declaration
    public HeatMap model
    Field Value
    Type Description
    HeatMap

    Properties

    HtmlAttr

    Declaration
    public IDictionary<string, object> HtmlAttr { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    ID

    Declaration
    public string ID { get; set; }
    Property Value
    Type Description
    System.String

    Output

    Declaration
    public override TextWriter Output { get; set; }
    Property Value
    Type Description
    System.IO.TextWriter
    Overrides
    ControlBuilder.Output

    Methods

    AllowSelection(Boolean)

    Enable or disable the selection of multiple cells in heatmap {% codeBlock src='heatmap/allowSelection/index.md' %}{% endcodeBlock %}

    Declaration
    public HeatMapBuilder AllowSelection(bool allowSelection = true)
    Parameters
    Type Name Description
    System.Boolean allowSelection
    Returns
    Type Description
    HeatMapBuilder

    CellClick(String)

    Triggers when click the heat map cell.

    Declaration
    public HeatMapBuilder CellClick(string cellClick)
    Parameters
    Type Name Description
    System.String cellClick
    Returns
    Type Description
    HeatMapBuilder

    CellRender(String)

    Triggers before each heatmap cell renders. {% codeBlock src='heatmap/cellRender/index.md' %}{% endcodeBlock %}

    Declaration
    public HeatMapBuilder CellRender(string cellRender)
    Parameters
    Type Name Description
    System.String cellRender
    Returns
    Type Description
    HeatMapBuilder

    CellSelected(String)

    Triggers when multiple cells gets selected.

    Declaration
    public HeatMapBuilder CellSelected(string cellSelected)
    Parameters
    Type Name Description
    System.String cellSelected
    Returns
    Type Description
    HeatMapBuilder

    CellSettings(HeatMapCellSettings)

    Options to customize the heat map cell {% codeBlock src='heatmap/cellSettings/index.md' %}{% endcodeBlock %}

    Declaration
    public HeatMapBuilder CellSettings(HeatMapCellSettings cellSettings)
    Parameters
    Type Name Description
    HeatMapCellSettings cellSettings
    Returns
    Type Description
    HeatMapBuilder

    CellSettings(Action<HeatMapCellSettingsBuilder>)

    Declaration
    public HeatMapBuilder CellSettings(Action<HeatMapCellSettingsBuilder> cellSettings)
    Parameters
    Type Name Description
    System.Action<HeatMapCellSettingsBuilder> cellSettings
    Returns
    Type Description
    HeatMapBuilder

    Created(String)

    Triggers after heat map rendered.

    Declaration
    public HeatMapBuilder Created(string created)
    Parameters
    Type Name Description
    System.String created
    Returns
    Type Description
    HeatMapBuilder

    DataSource(Action<DataManagerBuilder>)

    Declaration
    public HeatMapBuilder DataSource(Action<DataManagerBuilder> dataSource)
    Parameters
    Type Name Description
    System.Action<DataManagerBuilder> dataSource
    Returns
    Type Description
    HeatMapBuilder

    DataSource(Object)

    Specifies the datasource for the heat map.

    Declaration
    public HeatMapBuilder DataSource(object dataSource)
    Parameters
    Type Name Description
    System.Object dataSource
    Returns
    Type Description
    HeatMapBuilder

    DataSourceSettings(HeatMapData)

    Specifies the datasource settings for heat map. {% codeBlock src='heatmap/dataSourceSettings/index.md' %}{% endcodeBlock %}

    Declaration
    public HeatMapBuilder DataSourceSettings(HeatMapData dataSourceSettings)
    Parameters
    Type Name Description
    HeatMapData dataSourceSettings
    Returns
    Type Description
    HeatMapBuilder

    DataSourceSettings(Action<HeatMapDataBuilder>)

    Declaration
    public HeatMapBuilder DataSourceSettings(Action<HeatMapDataBuilder> dataSourceSettings)
    Parameters
    Type Name Description
    System.Action<HeatMapDataBuilder> dataSourceSettings
    Returns
    Type Description
    HeatMapBuilder

    EnablePersistence(Boolean)

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

    Declaration
    public HeatMapBuilder EnablePersistence(bool enablePersistence = true)
    Parameters
    Type Name Description
    System.Boolean enablePersistence
    Returns
    Type Description
    HeatMapBuilder

    EnableRtl(Boolean)

    Enable or disable rendering component in right to left direction.

    Declaration
    public HeatMapBuilder EnableRtl(bool enableRtl = true)
    Parameters
    Type Name Description
    System.Boolean enableRtl
    Returns
    Type Description
    HeatMapBuilder

    Height(String)

    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 HeatMapBuilder Height(string height)
    Parameters
    Type Name Description
    System.String height
    Returns
    Type Description
    HeatMapBuilder

    HtmlAttributes(Object)

    Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

    Declaration
    public HeatMapBuilder HtmlAttributes(object htmlAttributes)
    Parameters
    Type Name Description
    System.Object htmlAttributes
    Returns
    Type Description
    HeatMapBuilder

    LegendRender(String)

    Triggers before the legend is rendered. {% codeBlock src='heatmap/legendRender/index.md' %}{% endcodeBlock %}

    Declaration
    public HeatMapBuilder LegendRender(string legendRender)
    Parameters
    Type Name Description
    System.String legendRender
    Returns
    Type Description
    HeatMapBuilder

    LegendSettings(HeatMapLegendSettings)

    Options for customizing the legend of the heat map {% codeBlock src='heatmap/legendSettings/index.md' %}{% endcodeBlock %}

    Declaration
    public HeatMapBuilder LegendSettings(HeatMapLegendSettings legendSettings)
    Parameters
    Type Name Description
    HeatMapLegendSettings legendSettings
    Returns
    Type Description
    HeatMapBuilder

    LegendSettings(Action<HeatMapLegendSettingsBuilder>)

    Declaration
    public HeatMapBuilder LegendSettings(Action<HeatMapLegendSettingsBuilder> legendSettings)
    Parameters
    Type Name Description
    System.Action<HeatMapLegendSettingsBuilder> legendSettings
    Returns
    Type Description
    HeatMapBuilder

    Load(String)

    Triggers before heat map load. {% codeBlock src='heatmap/load/index.md' %}{% endcodeBlock %}

    Declaration
    public HeatMapBuilder Load(string load)
    Parameters
    Type Name Description
    System.String load
    Returns
    Type Description
    HeatMapBuilder

    Loaded(String)

    Triggers after heatmap is loaded.

    Declaration
    public HeatMapBuilder Loaded(string loaded)
    Parameters
    Type Name Description
    System.String loaded
    Returns
    Type Description
    HeatMapBuilder

    Locale(String)

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

    Declaration
    public HeatMapBuilder Locale(string locale)
    Parameters
    Type Name Description
    System.String locale
    Returns
    Type Description
    HeatMapBuilder

    Margin(HeatMapMargin)

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

    Declaration
    public HeatMapBuilder Margin(HeatMapMargin margin)
    Parameters
    Type Name Description
    HeatMapMargin margin
    Returns
    Type Description
    HeatMapBuilder

    Margin(Action<HeatMapMarginBuilder>)

    Declaration
    public HeatMapBuilder Margin(Action<HeatMapMarginBuilder> margin)
    Parameters
    Type Name Description
    System.Action<HeatMapMarginBuilder> margin
    Returns
    Type Description
    HeatMapBuilder

    PaletteSettings(HeatMapPaletteSettings)

    Options for customizing the cell color of the heat map {% codeBlock src='heatmap/paletteSettings/index.md' %}{% endcodeBlock %}

    Declaration
    public HeatMapBuilder PaletteSettings(HeatMapPaletteSettings paletteSettings)
    Parameters
    Type Name Description
    HeatMapPaletteSettings paletteSettings
    Returns
    Type Description
    HeatMapBuilder

    PaletteSettings(Action<HeatMapPaletteSettingsBuilder>)

    Declaration
    public HeatMapBuilder PaletteSettings(Action<HeatMapPaletteSettingsBuilder> paletteSettings)
    Parameters
    Type Name Description
    System.Action<HeatMapPaletteSettingsBuilder> paletteSettings
    Returns
    Type Description
    HeatMapBuilder

    Render()

    Declaration
    public HtmlString Render()
    Returns
    Type Description
    Microsoft.AspNetCore.Html.HtmlString

    RenderingMode(DrawType)

    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 HeatMapBuilder RenderingMode(DrawType renderingMode)
    Parameters
    Type Name Description
    DrawType renderingMode
    Returns
    Type Description
    HeatMapBuilder

    Resized(String)

    Triggers after resizing of Heatmap.

    Declaration
    public HeatMapBuilder Resized(string resized)
    Parameters
    Type Name Description
    System.String resized
    Returns
    Type Description
    HeatMapBuilder

    ShowTooltip(Boolean)

    Enable or disable the tool tip for heatmap

    Declaration
    public HeatMapBuilder ShowTooltip(bool showTooltip = true)
    Parameters
    Type Name Description
    System.Boolean showTooltip
    Returns
    Type Description
    HeatMapBuilder

    Theme(HeatMapTheme)

    Specifies the theme for heatmap.

    Declaration
    public HeatMapBuilder Theme(HeatMapTheme theme)
    Parameters
    Type Name Description
    HeatMapTheme theme
    Returns
    Type Description
    HeatMapBuilder

    TitleSettings(HeatMapTitle)

    Title of heat map {% codeBlock src='heatmap/titleSettings/index.md' %}{% endcodeBlock %}

    Declaration
    public HeatMapBuilder TitleSettings(HeatMapTitle titleSettings)
    Parameters
    Type Name Description
    HeatMapTitle titleSettings
    Returns
    Type Description
    HeatMapBuilder

    TitleSettings(Action<HeatMapTitleBuilder>)

    Declaration
    public HeatMapBuilder TitleSettings(Action<HeatMapTitleBuilder> titleSettings)
    Parameters
    Type Name Description
    System.Action<HeatMapTitleBuilder> titleSettings
    Returns
    Type Description
    HeatMapBuilder

    TooltipRender(String)

    Triggers when click the heat map cell. {% codeBlock src='heatmap/tooltipRender/index.md' %}{% endcodeBlock %}

    Declaration
    public HeatMapBuilder TooltipRender(string tooltipRender)
    Parameters
    Type Name Description
    System.String tooltipRender
    Returns
    Type Description
    HeatMapBuilder

    TooltipSettings(HeatMapTooltipSettings)

    Options for customizing the ToolTipSettings property of the heat map {% codeBlock src='heatmap/tooltipSettings/index.md' %}{% endcodeBlock %}

    Declaration
    public HeatMapBuilder TooltipSettings(HeatMapTooltipSettings tooltipSettings)
    Parameters
    Type Name Description
    HeatMapTooltipSettings tooltipSettings
    Returns
    Type Description
    HeatMapBuilder

    TooltipSettings(Action<HeatMapTooltipSettingsBuilder>)

    Declaration
    public HeatMapBuilder TooltipSettings(Action<HeatMapTooltipSettingsBuilder> tooltipSettings)
    Parameters
    Type Name Description
    System.Action<HeatMapTooltipSettingsBuilder> tooltipSettings
    Returns
    Type Description
    HeatMapBuilder

    Width(String)

    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 HeatMapBuilder Width(string width)
    Parameters
    Type Name Description
    System.String width
    Returns
    Type Description
    HeatMapBuilder

    XAxis(HeatMapAxis)

    Options to configure the horizontal axis.

    Declaration
    public HeatMapBuilder XAxis(HeatMapAxis xAxis)
    Parameters
    Type Name Description
    HeatMapAxis xAxis
    Returns
    Type Description
    HeatMapBuilder

    XAxis(Action<HeatMapAxisBuilder>)

    Declaration
    public HeatMapBuilder XAxis(Action<HeatMapAxisBuilder> xAxis)
    Parameters
    Type Name Description
    System.Action<HeatMapAxisBuilder> xAxis
    Returns
    Type Description
    HeatMapBuilder

    YAxis(HeatMapAxis)

    Options to configure the vertical axis.

    Declaration
    public HeatMapBuilder YAxis(HeatMapAxis yAxis)
    Parameters
    Type Name Description
    HeatMapAxis yAxis
    Returns
    Type Description
    HeatMapBuilder

    YAxis(Action<HeatMapAxisBuilder>)

    Declaration
    public HeatMapBuilder YAxis(Action<HeatMapAxisBuilder> yAxis)
    Parameters
    Type Name Description
    System.Action<HeatMapAxisBuilder> yAxis
    Returns
    Type Description
    HeatMapBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved