Interface ITreeMap

The interface specifies the properties of the treemap.

Namespace: Syncfusion.Blazor.TreeMap

Assembly: Syncfusion.Blazor.dll

Syntax

public interface ITreeMap

Properties

AllowImageExport

Enables or disables the export to image functionality in the TreeMap.

Declaration

bool AllowImageExport { get; set; }

Property Value

Type	Description
System.Boolean	true if the image export option can be enabled; otherwise, false.

Remarks

Allows users to export the TreeMap as an image, supporting the sharing and saving of visual representations of data.

AllowPdfExport

Enables or disables the export to PDF functionality in the TreeMap.

Declaration

bool AllowPdfExport { get; set; }

Property Value

Type	Description
System.Boolean	true if the PDF export option can be enabled; otherwise, false.

Remarks

Provides the ability to export the TreeMap component to a PDF file, enabling document generation and reporting features.

AllowPrint

Enables or disables the print functionality in the TreeMap.

Declaration

bool AllowPrint { get; set; }

Property Value

Type	Description
System.Boolean	true if the print option can be enabled; otherwise, false.

Remarks

Allows the TreeMap component to be printed directly from the browser, facilitating hardcopy distribution of the data visualization.

Background

Sets and gets the background color of the TreeMap.

Declaration

string Background { get; set; }

Property Value

Type	Description
System.String	A string value representing the color to be used as the background.

Remarks

This property specifies the TreeMap's background color, which can be customized to match the application's theme or design.

BreadcrumbConnector

Specifies the connector string between breadcrumb nodes in the TreeMap.

Declaration

string BreadcrumbConnector { get; set; }

Property Value

Type	Description
System.String	A string value representing the connector, with a default of " - ".

Remarks

The BreadcrumbConnector defines the character or string used to separate breadcrumb items, enhancing navigation context.

ColorValuePath

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

Declaration

string ColorValuePath { get; set; }

Property Value

Type	Description
System.String	A string specifying the color value path from the data source. Default is null.

Remarks

The ColorValuePath is used to determine the fill color of the treemap items based on data.

Description

Sets and gets the description for treemap.

Declaration

string Description { get; set; }

Property Value

Type	Description
System.String	A string that provides a description of the treemap. Default is null.

Remarks

Use this property to specify a description for accessibility and documentation purposes.

DrillDownView

Enables or disables the initial drill-down feature in the TreeMap.

Declaration

bool DrillDownView { get; set; }

Property Value

Type	Description
System.Boolean	true if the drill-down view is enabled; otherwise, false.

Remarks

Allows users to interactively explore hierarchical data by delving into specific branches of the TreeMap.

EnableBreadcrumb

Enables or disables breadcrumb visibility in the TreeMap header.

Declaration

bool EnableBreadcrumb { get; set; }

Property Value

Type	Description
System.Boolean	true if breadcrumb navigation is enabled; otherwise, false.

Remarks

The breadcrumb provides a visual representation of the user's current path within the TreeMap, aiding navigation.

EnableDrillDown

Enables or disables the drill-down functionality in the TreeMap.

Declaration

bool EnableDrillDown { get; set; }

Property Value

Type	Description
System.Boolean	true if the drill-down functionality can be enabled; otherwise, false.

Remarks

Drill-down enables users to analyze data hierarchies in more detail by interacting with TreeMap elements.

EnableGroupingSeparator

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

Declaration

bool EnableGroupingSeparator { get; set; }

Property Value

Type	Description
System.Boolean	true if the grouping separator is enabled; otherwise, false.

Remarks

This property enhances the visual separation and organization of grouped data in the TreeMap.

EnableRtl

Enables or disables rendering the component in right-to-left direction.

Declaration

bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	true if right-to-left (RTL) rendering is enabled; otherwise, false. Default is false.

Remarks

This property adapts the TreeMap layout to support languages and locales that are read from right to left.

EqualColorValuePath

Sets and gets the value path from the data source for uniform color mapping in the TreeMap.

Declaration

string EqualColorValuePath { get; set; }

Property Value

Type	Description
System.String	A string value that specifies the data source field for equal color assignment.

Remarks

This property allows colors to be uniformly applied across TreeMap items based on a specified data field.

Format

Sets and gets the format for text elements in the TreeMap.

Declaration

string Format { get; set; }

Property Value

Type	Description
System.String	A string value representing the format, with the default being empty.

Remarks

This property configures how text, such as labels and tooltips, is formatted in the TreeMap.

Height

Sets and gets the height of the TreeMap component.

Declaration

string Height { get; set; }

Property Value

Type	Description
System.String	A string value specifying the component's height.

Remarks

The Height property determines the vertical size of the TreeMap within its container or page.

LayoutType

Specifies the rendering type of layout for the TreeMap component.

Declaration

LayoutMode LayoutType { get; set; }

Property Value

Type	Description
LayoutMode	A LayoutMode enumeration value specifying the layout, with default Squarified.

Remarks

The LayoutType property configures how TreeMap items are arranged visually within the component.

Palette

Sets and gets the array of colors to apply to TreeMap items.

Declaration

string[] Palette { get; set; }

Property Value

Type	Description
System.String[]	An array of strings representing color values.

Remarks

Colors in the Palette are used sequentially or according to data values to enhance visual differentiation of TreeMap items.

Query

Sets and gets the query used to select data from the shape data when a data manager creates the data source.

Declaration

Query Query { get; set; }

Property Value

Type	Description
Query	A Query object representing the query to be executed on the data source.

Remarks

This property allows fine-grained control over data selection and retrieval when integrating with complex data services.

RangeColorValuePath

Sets and gets the value path from the data source for range color mapping in the TreeMap.

Declaration

string RangeColorValuePath { get; set; }

Property Value

Type	Description
System.String	A string specifying the field used for range color application.

Remarks

The RangeColorValuePath property facilitates the application of gradient or range-based colors based on data values.

RenderDirection

Specifies the rendering direction of layout for TreeMap items.

Declaration

RenderingMode RenderDirection { get; set; }

Property Value

Type	Description
RenderingMode	A RenderingMode enum value with default TopLeftBottomRight.

Remarks

The RenderDirection specifies the primary orientation and direction in which TreeMap items are drawn.

TabIndex

Sets and gets the tab index value for the TreeMap component.

Declaration

int TabIndex { get; set; }

Property Value

Type	Description
System.Int32	An integer representing the tab index. The default value is 0.

Remarks

This property determines the tab order for keyboard navigation, enhancing accessibility and user navigation within the TreeMap.

Theme

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

Declaration

Theme Theme { get; set; }

Property Value

Type	Description
Theme	A value from the Theme enumeration. The default is Material.

Remarks

The Theme property allows setting visual themes to style the TreeMap, ensuring consistency with application aesthetics.

WeightValuePath

Sets and gets the path for the value that determines the weight of items in the TreeMap from the data source.

Declaration

string WeightValuePath { get; set; }

Property Value

Type	Description
System.String	A string specifying the data source field for item weight.

Remarks

The WeightValuePath influences how space is allocated to items, supporting proportional representation based on data significance.

Width

Sets and gets the width of the treemap component.

Declaration

string Width { get; set; }

Property Value

Type	Description
System.String	A string specifying the width of the treemap. Default is "auto".

Remarks

The Width property specifies the horizontal size of the TreeMap, impacting its display layout and responsiveness.