Class TreeMap
Inheritance
Namespace: Syncfusion.EJ2.TreeMap
Assembly: Syncfusion.EJ2.dll
Syntax
public class TreeMap : EJTagHelperConstructors
TreeMap()
Declaration
public TreeMap()Properties
AllowImageExport
Enables and disables the export to image functionality in treemap.
Declaration
public bool AllowImageExport { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
AllowPdfExport
Enables and disables the export to pdf functionality in treemap.
Declaration
public bool AllowPdfExport { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
AllowPrint
Enables and disables the print functionality in treemap.
Declaration
public bool AllowPrint { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
Background
Sets and gets the background color of the treemap.
Declaration
public string Background { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
BeforePrint
Triggers before the print gets started.
Declaration
public string BeforePrint { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Border
Sets and gets the options for customizing the color and width of the treemap border.
Declaration
public TreeMapBorder Border { get; set; }Property Value
| Type | Description |
|---|---|
| TreeMapBorder | The default value is null |
BreadcrumbConnector
Specifies the symbol to show connection between the two words in the header of the treemap during drill down.
Declaration
public string BreadcrumbConnector { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is " - " |
Click
Triggers after clicking on the treemap.
Declaration
public string Click { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
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 | The default value is null |
DataSource
Sets and gets the data source for the treemap.
Declaration
public object DataSource { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
Description
Sets and gets the description for treemap.
Declaration
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
DoubleClick
Triggers after double clicking on the treemap.
Declaration
public string DoubleClick { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
DrillDownView
Enables or disables the initial drill in the treemap.
Declaration
public bool DrillDownView { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
DrillEnd
Triggers after drill down functionality gets completed in the treemap.
Declaration
public string DrillEnd { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
DrillStart
Triggers on performing drill down functionality in the treemap.
Declaration
public string DrillStart { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
EnableBreadcrumb
Enables or disables the connection text in the header of the treemap when drill down is enabled.
Declaration
public bool EnableBreadcrumb { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
EnableDrillDown
Enables or disables the drill down functionality in treemap.
Declaration
public bool EnableDrillDown { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
EnableHtmlSanitizer
Specifies whether to enable the rendering of untrusted HTML values in the TreeMap. If enableHtmlSanitizer set to true, the component will sanitize any suspected untrusted strings and scripts before rendering them.
Declaration
public bool EnableHtmlSanitizer { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
public bool EnablePersistence { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
public bool EnableRtl { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
EqualColorValuePath
Sets and gets the value path from the data source, based on it color is filled in treemap. This property is used when equal color mapping is set in the treemap.
Declaration
public string EqualColorValuePath { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
Format
Sets and gets format for the texts in the treemap. This property accepts any global string format like 'C', 'N1', 'P' etc.
Declaration
public string Format { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Height
Sets and gets the height of the treemap.
Declaration
public string Height { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
HighlightSettings
Sets and gets the options to customize the highlight functionality of the treemap.
Declaration
public TreeMapHighlightSettings HighlightSettings { get; set; }Property Value
| Type | Description |
|---|---|
| TreeMapHighlightSettings | The default value is null |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
public object HtmlAttributes { get; set; }Property Value
| Type |
|---|
| System.Object |
InitialDrillDown
Specifies the options for customizing the initial drill down in treemap.
Declaration
public TreeMapInitialDrillSettings InitialDrillDown { get; set; }Property Value
| Type | Description |
|---|---|
| TreeMapInitialDrillSettings | The default value is null |
ItemClick
Triggers after clicking an item in the treemap.
Declaration
public string ItemClick { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
ItemHighlight
Triggers after highlighting on the treemap item.
Declaration
public string ItemHighlight { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
ItemMove
Triggers after mouse hover on the treemap item.
Declaration
public string ItemMove { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
ItemRendering
Triggers before item rendering in the treemap.
Declaration
public string ItemRendering { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
ItemSelected
Triggers after selecting a treemap item.
Declaration
public string ItemSelected { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
LayoutType
Specifies the rendering type for the layout of the treemap.
Declaration
public LayoutMode LayoutType { get; set; }Property Value
| Type | Description |
|---|---|
| LayoutMode | The default value is LayoutMode.Squarified |
LeafItemSettings
Sets and gets the options for customizing the leaf item of the treemap.
Declaration
public TreeMapLeafItemSettings LeafItemSettings { get; set; }Property Value
| Type | Description |
|---|---|
| TreeMapLeafItemSettings | The default value is null |
LegendItemRendering
Triggers before rendering each legend item in the treemap.
Declaration
public string LegendItemRendering { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
LegendRendering
Triggers before rendering the legend items in the treemap.
Declaration
public string LegendRendering { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
LegendSettings
Sets and gets the options for customizing the legend of the treemap.
Declaration
public TreeMapLegendSettings LegendSettings { get; set; }Property Value
| Type | Description |
|---|---|
| TreeMapLegendSettings | The default value is null |
Levels
Sets and gets the options to configure and customize the levels of treemap items.
Declaration
public List<TreeMapLevel> Levels { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<TreeMapLevel> | The default value is null |
Load
Triggers before the treemap is rendered.
Declaration
public string Load { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Loaded
Triggers after treemap is rendered.
Declaration
public string Loaded { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public string Locale { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
Margin
Sets and gets the options for customizing the margin in the treemap.
Declaration
public TreeMapMargin Margin { get; set; }Property Value
| Type | Description |
|---|---|
| TreeMapMargin | The default value is null |
MouseMove
Triggers after mouse hover on the treemap.
Declaration
public string MouseMove { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Palette
Sets and gets a set of colors to apply in the treemap items.
Declaration
public string[] Palette { get; set; }Property Value
| Type | Description |
|---|---|
| System.String[] | The default value is null |
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 string Query { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
RangeColorValuePath
Sets and gets the value path from the data source, based on it color is filled in treemap. This property is used when range color mapping is set in the treemap.
Declaration
public string RangeColorValuePath { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
RenderDirection
Specifies the rendering direction of layout of the treemap items.
Declaration
public RenderingMode RenderDirection { get; set; }Property Value
| Type | Description |
|---|---|
| RenderingMode | The default value is RenderingMode.TopLeftBottomRight |
Resize
Triggers to notify the resize of the treemap when the window is resized.
Declaration
public string Resize { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
RightClick
Triggers after right clicking on the treemap.
Declaration
public string RightClick { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
SelectionSettings
Sets and gets the options for customizing the selection functionality of the treemap.
Declaration
public TreeMapSelectionSettings SelectionSettings { get; set; }Property Value
| Type | Description |
|---|---|
| TreeMapSelectionSettings | The default value is null |
TabIndex
Sets and gets the tab index value for treemap.
Declaration
public double TabIndex { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 0 |
Theme
Sets and gets the theme styles supported for treemap. When the theme is set, the styles associated with the theme will be set in the treemap.
Declaration
public TreeMapTheme Theme { get; set; }Property Value
| Type | Description |
|---|---|
| TreeMapTheme | The default value is TreeMapTheme.Material |
TitleSettings
Sets and gets the options for customizing the title of the treemap.
Declaration
public TreeMapTitleSettings TitleSettings { get; set; }Property Value
| Type | Description |
|---|---|
| TreeMapTitleSettings | The default value is null |
TooltipRendering
Triggers on rendering of the tooltip in the treemap.
Declaration
public string TooltipRendering { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
TooltipSettings
Sets and gets the options for customizing the tooltip of the treemap.
Declaration
public TreeMapTooltipSettings TooltipSettings { get; set; }Property Value
| Type | Description |
|---|---|
| TreeMapTooltipSettings | The default value is null |
UseGroupingSeparator
Enables or disables the visibility state of the separator for grouping.
Declaration
public bool UseGroupingSeparator { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
WeightValuePath
Sets and gets the value path of the weight from the data source, based on which the treemap item is rendered.
Declaration
public string WeightValuePath { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Width
Sets and gets the width of the treemap.
Declaration
public string Width { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |