menu

ASP.NET Core - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class HeatMapLegendSettingsBuilder - API Reference

    Show / Hide Table of Contents

    Class HeatMapLegendSettingsBuilder

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

    Constructors

    HeatMapLegendSettingsBuilder()

    Declaration
    public HeatMapLegendSettingsBuilder()

    HeatMapLegendSettingsBuilder(HeatMapLegendSettings)

    Declaration
    public HeatMapLegendSettingsBuilder(HeatMapLegendSettings model)
    Parameters
    Type Name Description
    HeatMapLegendSettings model

    Methods

    Alignment(Alignment)

    Specifies the alignment of the legend.

    Declaration
    public HeatMapLegendSettingsBuilder Alignment(Alignment value)
    Parameters
    Type Name Description
    Alignment value
    Returns
    Type Description
    HeatMapLegendSettingsBuilder

    EnableSmartLegend(Boolean)

    Specifies whether smart legend should be displayed or not when palette type is fixed.

    Declaration
    public HeatMapLegendSettingsBuilder EnableSmartLegend(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    HeatMapLegendSettingsBuilder

    Height(String)

    Sets and gets the height of the legend.

    Declaration
    public HeatMapLegendSettingsBuilder Height(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    HeatMapLegendSettingsBuilder

    LabelDisplayType(LabelDisplayType)

    Specifies the display mode for label for smart legend. The available display types are, All: All the labels in the legend are displayed. Edge: Labels will be displayed only at the edges of the legend. None: No labels are displayed.

    Declaration
    public HeatMapLegendSettingsBuilder LabelDisplayType(LabelDisplayType value)
    Parameters
    Type Name Description
    LabelDisplayType value
    Returns
    Type Description
    HeatMapLegendSettingsBuilder

    LabelFormat(String)

    Used to format the legend label.

    Declaration
    public HeatMapLegendSettingsBuilder LabelFormat(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    HeatMapLegendSettingsBuilder

    Position(LegendPosition)

    Sets and gets the position of the legend.

    Declaration
    public HeatMapLegendSettingsBuilder Position(LegendPosition value)
    Parameters
    Type Name Description
    LegendPosition value
    Returns
    Type Description
    HeatMapLegendSettingsBuilder

    ShowGradientPointer(Boolean)

    Enables or disables the visibility of the gradient pointer in the gradient legend.

    Declaration
    public HeatMapLegendSettingsBuilder ShowGradientPointer(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    HeatMapLegendSettingsBuilder

    ShowLabel(Boolean)

    Specifies whether the labels in the legend should be visible or not.

    Declaration
    public HeatMapLegendSettingsBuilder ShowLabel(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    HeatMapLegendSettingsBuilder

    TextStyle(Object)

    Sets and gets the options to customize the font style of the legend label.

    Declaration
    public HeatMapLegendSettingsBuilder TextStyle(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type Description
    HeatMapLegendSettingsBuilder

    Title(HeatMapTitle)

    Sets and gets the options to customize the title of the legend.

    Declaration
    public HeatMapLegendSettingsBuilder Title(HeatMapTitle value)
    Parameters
    Type Name Description
    HeatMapTitle value
    Returns
    Type Description
    HeatMapLegendSettingsBuilder

    Title(Action<HeatMapTitleBuilder>)

    Declaration
    public HeatMapLegendSettingsBuilder Title(Action<HeatMapTitleBuilder> title)
    Parameters
    Type Name Description
    System.Action<HeatMapTitleBuilder> title
    Returns
    Type Description
    HeatMapLegendSettingsBuilder

    ToggleVisibility(Boolean)

    Enables or disables the toggle visibility of heatmap cells based on legend item selection.

    Declaration
    public HeatMapLegendSettingsBuilder ToggleVisibility(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    HeatMapLegendSettingsBuilder

    Visible(Boolean)

    Specifies whether the legend should be visible or not.

    Declaration
    public HeatMapLegendSettingsBuilder Visible(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    HeatMapLegendSettingsBuilder

    Width(String)

    Sets and gets the width of the legend.

    Declaration
    public HeatMapLegendSettingsBuilder Width(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    HeatMapLegendSettingsBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved