Class SfTreeMap<TValue>

The treemap control is used to visualize both hierarchical and flat data in the form of nodes along with built-in features like color mapping, legends, label templates, and more.

Inheritance
System.Object
Syncfusion.Blazor.SfBaseComponent
SfDataBoundComponent
SfTreeMap<TValue>
Implements
Inherited Members
Namespace: Syncfusion.Blazor.TreeMap
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfTreeMap<TValue> : SfDataBoundComponent, ITreeMap
Type Parameters
Name Description
TValue

Represents the generic data type of the treemap control.

Constructors

SfTreeMap()

Declaration
public SfTreeMap()

Properties

AllowImageExport

Enables and disables the export to image functionality in treemap.

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

AllowPdfExport

Enables and disables the export to PDF functionality in treemap.

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

AllowPrint

Enables and disables the print functionality in treemap.

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

Background

Sets and gets the background color of the treemap.

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

BreadcrumbConnector

Specifies the connection between the two words.

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

ChildContent

Sets and gets the content of the UI element.

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

ColorValuePath

Sets and gets the value path from the data source, based on it color is filled in treemap.

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

DataSource

Sets and gets the data source for the treemap component.

Declaration
public IEnumerable<TValue> DataSource { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<TValue>

Description

Sets and gets the description for treemap.

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

DrillDownView

Enables or disables the initial drill in the treemap.

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

EnableBreadcrumb

Enables or disables the connection text in the header of the treemap.

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

EnableDrillDown

Enables or disables the drill down functionality in treemap.

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

EnableGroupingSeparator

Enables or disables the visibility state of the separator for grouping.

Declaration
public bool EnableGroupingSeparator { 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

EqualColorValuePath

Sets and gets the value path from the data source, based on it color is filled in treemap.

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

Format

Sets and gets format for the texts in the treemap.

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

Height

Sets and gets the height of the treemap component.

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

ID

Set the id string for the linear gauge component.

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

LayoutType

Specifies the rendering type of layout of the treemap component.

Declaration
public LayoutMode LayoutType { get; set; }
Property Value
Type Description
LayoutMode

Palette

Sets and gets the set of colors to apply in the treemap items.

Declaration
public string[] Palette { get; set; }
Property Value
Type Description
System.String[]

Query

Sets and gets the query to select particular data from the shape data. This property is applicable only when the data source is created by data manager.

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

RangeColorValuePath

Sets and gets the value path from the data source, based on it color is filled in treemap.

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

RenderDirection

Specifies the rendering direction of layout of the treemap items.

Declaration
public RenderingMode RenderDirection { get; set; }
Property Value
Type Description
RenderingMode

TabIndex

Sets and gets the tab index value for treemap.

Declaration
public int TabIndex { get; set; }
Property Value
Type Description
System.Int32

Theme

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

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

WeightValuePath

Sets and gets the value path of the weight from the data source, based on which the map item is rendered.

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

Width

Sets and gets the width of the treemap component.

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

Export(ExportType, String, Nullable<PdfPageOrientation>, Boolean)

The method is used to perform the export functionality for the rendered treemap.

Declaration
public Task<string> Export(ExportType type, string fileName, Nullable<PdfPageOrientation> orientation = null, bool allowDownload = true)
Parameters
Type Name Description
ExportType type

Specifies the export type for the rendered treemap.
System.String fileName

Specifies the filename.
System.Nullable<Syncfusion.PdfExport.PdfPageOrientation> orientation

Specifies the portrait or landscape orientation of the page.
System.Boolean allowDownload

Specifies whether to download or not.
Returns
Type Description
System.Threading.Tasks.Task<System.String>

Returns base64 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

OnInitializedAsync()

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

OnParametersSetAsync()

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

OnTreeMapParametersSet()

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

Print()

The method is used to perform the print functionality in treemap.

Declaration
public Task Print()
Returns
Type Description
System.Threading.Tasks.Task

Refresh()

The method is used to render the treemap again.

Declaration
public Task Refresh()
Returns
Type Description
System.Threading.Tasks.Task

SelectItem(String[], Boolean)

The method is used to select or remove the selection of treemap item based on the provided selection settings.

Declaration
public Task SelectItem(string[] levelOrder, bool isSelected = true)
Parameters
Type Name Description
System.String[] levelOrder

Specifies the level order name for the treemap item.
System.Boolean isSelected

Specifies whether the treemap item is selected or not. Default value is true.
Returns
Type Description
System.Threading.Tasks.Task

Implements