Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class HeatMapLegendSettings - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class HeatMapLegendSettings

    Inheritance
    System.Object
    BaseComponent
    HeatMapLegendSettings
    Implements
    System.IDisposable
    Inherited Members
    BaseComponent.CreateJsAdaptor()
    BaseComponent.Dispose()
    BaseComponent.Refresh()
    BaseComponent.clearClientChanges(Boolean)
    BaseComponent.InvokeSet<T>(String, String, Object[])
    BaseComponent.InvokeGet<T>(String, String)
    BaseComponent.WireObservableEvents(Object)
    BaseComponent.getSerializedModel()
    BaseComponent.getUpdateModel(Boolean)
    BaseComponent.GetDataManager(Object, String)
    BaseComponent.uniqueId
    BaseComponent.jsRuntime
    BaseComponent.EditContext
    BaseComponent.nameSpace
    BaseComponent.DotNetObjectRef
    Namespace: Syncfusion.Blazor.HeatMap
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class HeatMapLegendSettings : BaseComponent, IDisposable

    Constructors

    HeatMapLegendSettings()

    Declaration
    public HeatMapLegendSettings()

    Properties

    Alignment

    Specifies the alignment of the legend

    Declaration
    public Alignment Alignment { get; set; }
    Property Value
    Type Description
    Alignment

    ChildContent

    Declaration
    public RenderFragment ChildContent { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment

    EnableSmartLegend

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

    Declaration
    public bool EnableSmartLegend { get; set; }
    Property Value
    Type Description
    System.Boolean

    Height

    Specifies the height of Legend.

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

    jsProperty

    Declaration
    protected override string jsProperty { get; set; }
    Property Value
    Type Description
    System.String
    Overrides
    BaseComponent.jsProperty

    LabelDisplayType

    Specifies the type of label display for smart legend. All: All labels are displayed. Edge: Labels will be displayed only at the edges of the legend. None: No labels are displayed.

    Declaration
    public LabelDisplayType LabelDisplayType { get; set; }
    Property Value
    Type Description
    LabelDisplayType

    LabelFormat

    Specifies the formatting options for the legend label.

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

    mainParent

    Declaration
    protected override BaseComponent mainParent { get; set; }
    Property Value
    Type Description
    BaseComponent
    Overrides
    BaseComponent.mainParent

    Position

    Specifies the position of Legend to render.

    Declaration
    public LegendPosition Position { get; set; }
    Property Value
    Type Description
    LegendPosition

    ShowGradientPointer

    Specifies whether the gradient pointer should be visible or not.

    Declaration
    public bool ShowGradientPointer { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowLabel

    Specifies whether the label should be visible or not.

    Declaration
    public bool ShowLabel { get; set; }
    Property Value
    Type Description
    System.Boolean

    TextStyle

    Specifies the legend label style.

    Declaration
    public FontModel TextStyle { get; set; }
    Property Value
    Type Description
    FontModel

    Title

    Specifies title of Legend.

    Declaration
    public HeatMapLegendTitle Title { get; set; }
    Property Value
    Type Description
    HeatMapLegendTitle

    ToggleVisibility

    To toggle the visibility of heatmap cells based on legend range selection

    Declaration
    public bool ToggleVisibility { get; set; }
    Property Value
    Type Description
    System.Boolean

    Visible

    Specifies whether the Legend should be visible or not.

    Declaration
    public bool Visible { get; set; }
    Property Value
    Type Description
    System.Boolean

    Width

    Specifies the width of Legend.

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

    Methods

    BuildRenderTree(RenderTreeBuilder)

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

    GetJSNamespace()

    Declaration
    public string GetJSNamespace()
    Returns
    Type Description
    System.String

    OnAfterRenderAsync(Boolean)

    Declaration
    protected override Task OnAfterRenderAsync(bool firstRender)
    Parameters
    Type Name Description
    System.Boolean firstRender
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    BaseComponent.OnAfterRenderAsync(Boolean)

    OnInitializedAsync()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    BaseComponent.OnInitializedAsync()

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    updateChildProperties(String, Object)

    Declaration
    public void updateChildProperties(string key, object value)
    Parameters
    Type Name Description
    System.String key
    System.Object value

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved