Class TreeMapLegendSettings

Sets and gets the options for customizing the legend of the treemap component.

Inheritance

System.Object

TreeMapLegendSettings

Namespace: Syncfusion.Blazor.TreeMap

Assembly: Syncfusion.Blazor.dll

Syntax

public class TreeMapLegendSettings : OwningComponentBase

Constructors

TreeMapLegendSettings()

Declaration

public TreeMapLegendSettings()

Properties

Alignment

Sets and gets the alignment of legend in the treemap component.

Declaration

public Alignment Alignment { get; set; }

Property Value

Type
Alignment

Background

Sets and gets the background color of legend in the treemap component.

Declaration

public string Background { get; set; }

Property Value

Type
System.String

ChildContent

Sets and gets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.RenderFragment

Fill

Sets and gets the shape color of legend in the treemap component.

Declaration

public string Fill { get; set; }

Property Value

Type
System.String

Height

Sets and gets the height of legend in the treemap component.

Declaration

public string Height { get; set; }

Property Value

Type
System.String

ImageUrl

Sets and gets the URL path of the legend shapes rendered as image in the treemap component.

Declaration

public string ImageUrl { get; set; }

Property Value

Type
System.String

InvertedPointer

Enables or disables the pointer for interactive legend in the treemap component.

Declaration

public bool InvertedPointer { get; set; }

Property Value

Type
System.Boolean

LabelDisplayMode

Sets and gets the label intersect action of legend in the treemap component.

Declaration

public LabelIntersectAction LabelDisplayMode { get; set; }

Property Value

Type
LabelIntersectAction

LabelPosition

Sets and gets the label position for interactive legend in the treemap component.

Declaration

public LabelPlacement LabelPosition { get; set; }

Property Value

Type
LabelPlacement

Mode

Sets and gets the mode of legend in the treemap component. The modes available are default and interactive modes.

Declaration

public LegendMode Mode { get; set; }

Property Value

Type
LegendMode

Opacity

Sets and gets the opacity of legends in the treemap component.

Declaration

public double Opacity { get; set; }

Property Value

Type
System.Double

Orientation

Sets and gets the orientation of legend in the treemap component.

Declaration

public LegendOrientation Orientation { get; set; }

Property Value

Type
LegendOrientation

Position

Sets and gets the position of legend in the treemap component.

Declaration

public LegendPosition Position { get; set; }

Property Value

Type
LegendPosition

RemoveDuplicateLegend

Enables or disables to remove the duplicate legend item.

Declaration

public bool RemoveDuplicateLegend { get; set; }

Property Value

Type
System.Boolean

Shape

Sets and gets the shape of legend in the treemap component.

Declaration

public LegendShape Shape { get; set; }

Property Value

Type
LegendShape

ShapeHeight

Sets and gets the height of the shapes of legend in the treemap component.

Declaration

public double ShapeHeight { get; set; }

Property Value

Type
System.Double

ShapePadding

Sets and gets the shape padding of legend in the treemap component.

Declaration

public double ShapePadding { get; set; }

Property Value

Type
System.Double

ShapeWidth

Sets and gets the width of the shapes in legend in the treemap component.

Declaration

public double ShapeWidth { get; set; }

Property Value

Type
System.Double

ShowLegendPath

Sets and gets the visibility state of the legend in the treemap component.

Declaration

public string ShowLegendPath { get; set; }

Property Value

Type
System.String

ValuePath

Sets and gets the value path from the data source to render legend in the treemap component.

Declaration

public string ValuePath { get; set; }

Property Value

Type
System.String

Visible

Enables or disables the visibility of legend in the treemap component.

Declaration

public bool Visible { get; set; }

Property Value

Type
System.Boolean

Width

Sets and gets the width of legend in the treemap component.

Declaration

public string Width { get; set; }

Property Value

Type
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree and the incoming values have been assigned to properties.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.