Class TreeMapBuilder

Inheritance

System.Object

ControlBuilder

TreeMapBuilder

Inherited Members

ControlBuilder.Context

Namespace: Syncfusion.EJ2.TreeMap

Assembly: Syncfusion.EJ2.dll

Syntax

public class TreeMapBuilder : ControlBuilder

Constructors

TreeMapBuilder()

Declaration

public TreeMapBuilder()

TreeMapBuilder(TreeMap)

Declaration

public TreeMapBuilder(TreeMap model)

Parameters

Type	Name	Description
TreeMap	model

Fields

model

Declaration

public TreeMap model

Field Value

Type	Description
TreeMap

Properties

HtmlAttr

Declaration

public IDictionary<string, object> HtmlAttr { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Output

Declaration

public override TextWriter Output { get; set; }

Property Value

Type	Description
System.IO.TextWriter

Overrides

ControlBuilder.Output

Methods

AllowImageExport(Boolean)

Enables and disables the export to image functionality in treemap.

Declaration

public TreeMapBuilder AllowImageExport(bool allowImageExport = true)

Parameters

Type	Name	Description
System.Boolean	allowImageExport

Returns

Type	Description
TreeMapBuilder

AllowPdfExport(Boolean)

Enables and disables the export to pdf functionality in treemap.

Declaration

public TreeMapBuilder AllowPdfExport(bool allowPdfExport = true)

Parameters

Type	Name	Description
System.Boolean	allowPdfExport

Returns

Type	Description
TreeMapBuilder

AllowPrint(Boolean)

Enables and disables the print functionality in treemap.

Declaration

public TreeMapBuilder AllowPrint(bool allowPrint = true)

Parameters

Type	Name	Description
System.Boolean	allowPrint

Returns

Type	Description
TreeMapBuilder

Background(String)

Sets and gets the background color of the treemap.

Declaration

public TreeMapBuilder Background(string background)

Parameters

Type	Name	Description
System.String	background

Returns

Type	Description
TreeMapBuilder

BeforePrint(String)

Triggers before the print gets started.

Declaration

public TreeMapBuilder BeforePrint(string beforePrint)

Parameters

Type	Name	Description
System.String	beforePrint

Returns

Type	Description
TreeMapBuilder

Border(TreeMapBorder)

Sets and gets the options for customizing the color and width of the treemap border.

Declaration

public TreeMapBuilder Border(TreeMapBorder border)

Parameters

Type	Name	Description
TreeMapBorder	border

Returns

Type	Description
TreeMapBuilder

Border(Action<TreeMapBorderBuilder>)

Declaration

public TreeMapBuilder Border(Action<TreeMapBorderBuilder> border)

Parameters

Type	Name	Description
System.Action<TreeMapBorderBuilder>	border

Returns

Type	Description
TreeMapBuilder

BreadcrumbConnector(String)

Specifies the symbol to show connection between the two words in the header of the treemap during drill down.

Declaration

public TreeMapBuilder BreadcrumbConnector(string breadcrumbConnector)

Parameters

Type	Name	Description
System.String	breadcrumbConnector

Returns

Type	Description
TreeMapBuilder

Click(String)

Triggers after clicking on the treemap.

Declaration

public TreeMapBuilder Click(string click)

Parameters

Type	Name	Description
System.String	click

Returns

Type	Description
TreeMapBuilder

ColorValuePath(String)

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

Declaration

public TreeMapBuilder ColorValuePath(string colorValuePath)

Parameters

Type	Name	Description
System.String	colorValuePath

Returns

Type	Description
TreeMapBuilder

DataSource(Action<DataManagerBuilder>)

Declaration

public TreeMapBuilder DataSource(Action<DataManagerBuilder> dataSource)

Parameters

Type	Name	Description
System.Action<DataManagerBuilder>	dataSource

Returns

Type	Description
TreeMapBuilder

DataSource(Object)

Sets and gets the data source for the treemap.

Declaration

public TreeMapBuilder DataSource(object dataSource)

Parameters

Type	Name	Description
System.Object	dataSource

Returns

Type	Description
TreeMapBuilder

Description(String)

Sets and gets the description for treemap.

Declaration

public TreeMapBuilder Description(string description)

Parameters

Type	Name	Description
System.String	description

Returns

Type	Description
TreeMapBuilder

DoubleClick(String)

Triggers after double clicking on the treemap.

Declaration

public TreeMapBuilder DoubleClick(string doubleClick)

Parameters

Type	Name	Description
System.String	doubleClick

Returns

Type	Description
TreeMapBuilder

DrillDownView(Boolean)

Enables or disables the initial drill in the treemap.

Declaration

public TreeMapBuilder DrillDownView(bool drillDownView = true)

Parameters

Type	Name	Description
System.Boolean	drillDownView

Returns

Type	Description
TreeMapBuilder

DrillEnd(String)

Triggers after drill down functionality gets completed in the treemap.

Declaration

public TreeMapBuilder DrillEnd(string drillEnd)

Parameters

Type	Name	Description
System.String	drillEnd

Returns

Type	Description
TreeMapBuilder

DrillStart(String)

Triggers on performing drill down functionality in the treemap.

Declaration

public TreeMapBuilder DrillStart(string drillStart)

Parameters

Type	Name	Description
System.String	drillStart

Returns

Type	Description
TreeMapBuilder

EnableBreadcrumb(Boolean)

Enables or disables the connection text in the header of the treemap when drill down is enabled.

Declaration

public TreeMapBuilder EnableBreadcrumb(bool enableBreadcrumb = true)

Parameters

Type	Name	Description
System.Boolean	enableBreadcrumb

Returns

Type	Description
TreeMapBuilder

EnableDrillDown(Boolean)

Enables or disables the drill down functionality in treemap.

Declaration

public TreeMapBuilder EnableDrillDown(bool enableDrillDown = true)

Parameters

Type	Name	Description
System.Boolean	enableDrillDown

Returns

Type	Description
TreeMapBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads.

Declaration

public TreeMapBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
TreeMapBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration

public TreeMapBuilder EnableRtl(bool enableRtl = true)

Parameters

Type	Name	Description
System.Boolean	enableRtl

Returns

Type	Description
TreeMapBuilder

EqualColorValuePath(String)

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 TreeMapBuilder EqualColorValuePath(string equalColorValuePath)

Parameters

Type	Name	Description
System.String	equalColorValuePath

Returns

Type	Description
TreeMapBuilder

Format(String)

Sets and gets format for the texts in the treemap. This property accepts any global string format like 'C', 'N1', 'P' etc.

Declaration

public TreeMapBuilder Format(string format)

Parameters

Type	Name	Description
System.String	format

Returns

Type	Description
TreeMapBuilder

Height(String)

Sets and gets the height of the treemap.

Declaration

public TreeMapBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
TreeMapBuilder

HighlightSettings(TreeMapHighlightSettings)

Sets and gets the options to customize the highlight functionality of the treemap.

Declaration

public TreeMapBuilder HighlightSettings(TreeMapHighlightSettings highlightSettings)

Parameters

Type	Name	Description
TreeMapHighlightSettings	highlightSettings

Returns

Type	Description
TreeMapBuilder

HighlightSettings(Action<TreeMapHighlightSettingsBuilder>)

Declaration

public TreeMapBuilder HighlightSettings(Action<TreeMapHighlightSettingsBuilder> highlightSettings)

Parameters

Type	Name	Description
System.Action<TreeMapHighlightSettingsBuilder>	highlightSettings

Returns

Type	Description
TreeMapBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration

public TreeMapBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
TreeMapBuilder

InitialDrillDown(TreeMapInitialDrillSettings)

Specifies the options for customizing the initial drill down in treemap.

Declaration

public TreeMapBuilder InitialDrillDown(TreeMapInitialDrillSettings initialDrillDown)

Parameters

Type	Name	Description
TreeMapInitialDrillSettings	initialDrillDown

Returns

Type	Description
TreeMapBuilder

InitialDrillDown(Action<TreeMapInitialDrillSettingsBuilder>)

Declaration

public TreeMapBuilder InitialDrillDown(Action<TreeMapInitialDrillSettingsBuilder> initialDrillDown)

Parameters

Type	Name	Description
System.Action<TreeMapInitialDrillSettingsBuilder>	initialDrillDown

Returns

Type	Description
TreeMapBuilder

ItemClick(String)

Triggers after clicking an item in the treemap.

Declaration

public TreeMapBuilder ItemClick(string itemClick)

Parameters

Type	Name	Description
System.String	itemClick

Returns

Type	Description
TreeMapBuilder

ItemHighlight(String)

Triggers after highlighting on the treemap item.

Declaration

public TreeMapBuilder ItemHighlight(string itemHighlight)

Parameters

Type	Name	Description
System.String	itemHighlight

Returns

Type	Description
TreeMapBuilder

ItemMove(String)

Triggers after mouse hover on the treemap item.

Declaration

public TreeMapBuilder ItemMove(string itemMove)

Parameters

Type	Name	Description
System.String	itemMove

Returns

Type	Description
TreeMapBuilder

ItemRendering(String)

Triggers before item rendering in the treemap.

Declaration

public TreeMapBuilder ItemRendering(string itemRendering)

Parameters

Type	Name	Description
System.String	itemRendering

Returns

Type	Description
TreeMapBuilder

ItemSelected(String)

Triggers after selecting a treemap item.

Declaration

public TreeMapBuilder ItemSelected(string itemSelected)

Parameters

Type	Name	Description
System.String	itemSelected

Returns

Type	Description
TreeMapBuilder

LayoutType(LayoutMode)

Specifies the rendering type for the layout of the treemap.

Declaration

public TreeMapBuilder LayoutType(LayoutMode layoutType)

Parameters

Type	Name	Description
LayoutMode	layoutType

Returns

Type	Description
TreeMapBuilder

LeafItemSettings(TreeMapLeafItemSettings)

Sets and gets the options for customizing the leaf item of the treemap.

Declaration

public TreeMapBuilder LeafItemSettings(TreeMapLeafItemSettings leafItemSettings)

Parameters

Type	Name	Description
TreeMapLeafItemSettings	leafItemSettings

Returns

Type	Description
TreeMapBuilder

LeafItemSettings(Action<TreeMapLeafItemSettingsBuilder>)

Declaration

public TreeMapBuilder LeafItemSettings(Action<TreeMapLeafItemSettingsBuilder> leafItemSettings)

Parameters

Type	Name	Description
System.Action<TreeMapLeafItemSettingsBuilder>	leafItemSettings

Returns

Type	Description
TreeMapBuilder

LegendItemRendering(String)

Triggers before rendering each legend item in the treemap.

Declaration

public TreeMapBuilder LegendItemRendering(string legendItemRendering)

Parameters

Type	Name	Description
System.String	legendItemRendering

Returns

Type	Description
TreeMapBuilder

LegendRendering(String)

Triggers before rendering the legend items in the treemap.

Declaration

public TreeMapBuilder LegendRendering(string legendRendering)

Parameters

Type	Name	Description
System.String	legendRendering

Returns

Type	Description
TreeMapBuilder

LegendSettings(TreeMapLegendSettings)

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

Declaration

public TreeMapBuilder LegendSettings(TreeMapLegendSettings legendSettings)

Parameters

Type	Name	Description
TreeMapLegendSettings	legendSettings

Returns

Type	Description
TreeMapBuilder

LegendSettings(Action<TreeMapLegendSettingsBuilder>)

Declaration

public TreeMapBuilder LegendSettings(Action<TreeMapLegendSettingsBuilder> legendSettings)

Parameters

Type	Name	Description
System.Action<TreeMapLegendSettingsBuilder>	legendSettings

Returns

Type	Description
TreeMapBuilder

Levels(Action<TreeMapLevelBuilder>)

Declaration

public TreeMapBuilder Levels(Action<TreeMapLevelBuilder> levels)

Parameters

Type	Name	Description
System.Action<TreeMapLevelBuilder>	levels

Returns

Type	Description
TreeMapBuilder

Levels(List<TreeMapLevel>)

Sets and gets the options to configure and customize the levels of treemap items.

Declaration

public TreeMapBuilder Levels(List<TreeMapLevel> levels)

Parameters

Type	Name	Description
System.Collections.Generic.List<TreeMapLevel>	levels

Returns

Type	Description
TreeMapBuilder

Load(String)

Triggers before the treemap is rendered.

Declaration

public TreeMapBuilder Load(string load)

Parameters

Type	Name	Description
System.String	load

Returns

Type	Description
TreeMapBuilder

Loaded(String)

Triggers after treemap is rendered.

Declaration

public TreeMapBuilder Loaded(string loaded)

Parameters

Type	Name	Description
System.String	loaded

Returns

Type	Description
TreeMapBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public TreeMapBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
TreeMapBuilder

Margin(TreeMapMargin)

Sets and gets the options for customizing the margin in the treemap.

Declaration

public TreeMapBuilder Margin(TreeMapMargin margin)

Parameters

Type	Name	Description
TreeMapMargin	margin

Returns

Type	Description
TreeMapBuilder

Margin(Action<TreeMapMarginBuilder>)

Declaration

public TreeMapBuilder Margin(Action<TreeMapMarginBuilder> margin)

Parameters

Type	Name	Description
System.Action<TreeMapMarginBuilder>	margin

Returns

Type	Description
TreeMapBuilder

MouseMove(String)

Triggers after mouse hover on the treemap.

Declaration

public TreeMapBuilder MouseMove(string mouseMove)

Parameters

Type	Name	Description
System.String	mouseMove

Returns

Type	Description
TreeMapBuilder

Palette(String[])

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

Declaration

public TreeMapBuilder Palette(string[] palette)

Parameters

Type	Name	Description
System.String[]	palette

Returns

Type	Description
TreeMapBuilder

Query(String)

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 TreeMapBuilder Query(string query)

Parameters

Type	Name	Description
System.String	query

Returns

Type	Description
TreeMapBuilder

RangeColorValuePath(String)

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 TreeMapBuilder RangeColorValuePath(string rangeColorValuePath)

Parameters

Type	Name	Description
System.String	rangeColorValuePath

Returns

Type	Description
TreeMapBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
Microsoft.AspNetCore.Html.HtmlString

RenderDirection(RenderingMode)

Specifies the rendering direction of layout of the treemap items.

Declaration

public TreeMapBuilder RenderDirection(RenderingMode renderDirection)

Parameters

Type	Name	Description
RenderingMode	renderDirection

Returns

Type	Description
TreeMapBuilder

Resize(String)

Triggers to notify the resize of the treemap when the window is resized.

Declaration

public TreeMapBuilder Resize(string resize)

Parameters

Type	Name	Description
System.String	resize

Returns

Type	Description
TreeMapBuilder

RightClick(String)

Triggers after right clicking on the treemap.

Declaration

public TreeMapBuilder RightClick(string rightClick)

Parameters

Type	Name	Description
System.String	rightClick

Returns

Type	Description
TreeMapBuilder

SelectionSettings(TreeMapSelectionSettings)

Sets and gets the options for customizing the selection functionality of the treemap.

Declaration

public TreeMapBuilder SelectionSettings(TreeMapSelectionSettings selectionSettings)

Parameters

Type	Name	Description
TreeMapSelectionSettings	selectionSettings

Returns

Type	Description
TreeMapBuilder

SelectionSettings(Action<TreeMapSelectionSettingsBuilder>)

Declaration

public TreeMapBuilder SelectionSettings(Action<TreeMapSelectionSettingsBuilder> selectionSettings)

Parameters

Type	Name	Description
System.Action<TreeMapSelectionSettingsBuilder>	selectionSettings

Returns

Type	Description
TreeMapBuilder

TabIndex(Double)

Sets and gets the tab index value for treemap.

Declaration

public TreeMapBuilder TabIndex(double tabIndex)

Parameters

Type	Name	Description
System.Double	tabIndex

Returns

Type	Description
TreeMapBuilder

Theme(TreeMapTheme)

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 TreeMapBuilder Theme(TreeMapTheme theme)

Parameters

Type	Name	Description
TreeMapTheme	theme

Returns

Type	Description
TreeMapBuilder

TitleSettings(TreeMapTitleSettings)

Sets and gets the options for customizing the title of the treemap.

Declaration

public TreeMapBuilder TitleSettings(TreeMapTitleSettings titleSettings)

Parameters

Type	Name	Description
TreeMapTitleSettings	titleSettings

Returns

Type	Description
TreeMapBuilder

TitleSettings(Action<TreeMapTitleSettingsBuilder>)

Declaration

public TreeMapBuilder TitleSettings(Action<TreeMapTitleSettingsBuilder> titleSettings)

Parameters

Type	Name	Description
System.Action<TreeMapTitleSettingsBuilder>	titleSettings

Returns

Type	Description
TreeMapBuilder

TooltipRendering(String)

Triggers on rendering of the tooltip in the treemap.

Declaration

public TreeMapBuilder TooltipRendering(string tooltipRendering)

Parameters

Type	Name	Description
System.String	tooltipRendering

Returns

Type	Description
TreeMapBuilder

TooltipSettings(TreeMapTooltipSettings)

Sets and gets the options for customizing the tooltip of the treemap.

Declaration

public TreeMapBuilder TooltipSettings(TreeMapTooltipSettings tooltipSettings)

Parameters

Type	Name	Description
TreeMapTooltipSettings	tooltipSettings

Returns

Type	Description
TreeMapBuilder

TooltipSettings(Action<TreeMapTooltipSettingsBuilder>)

Declaration

public TreeMapBuilder TooltipSettings(Action<TreeMapTooltipSettingsBuilder> tooltipSettings)

Parameters

Type	Name	Description
System.Action<TreeMapTooltipSettingsBuilder>	tooltipSettings

Returns

Type	Description
TreeMapBuilder

UseGroupingSeparator(Boolean)

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

Declaration

public TreeMapBuilder UseGroupingSeparator(bool useGroupingSeparator = true)

Parameters

Type	Name	Description
System.Boolean	useGroupingSeparator

Returns

Type	Description
TreeMapBuilder

WeightValuePath(String)

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

Declaration

public TreeMapBuilder WeightValuePath(string weightValuePath)

Parameters

Type	Name	Description
System.String	weightValuePath

Returns

Type	Description
TreeMapBuilder

Width(String)

Sets and gets the width of the treemap.

Declaration

public TreeMapBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
TreeMapBuilder