Skip to main content

TreeMapBuilder Methods

A TreeMap control.
Name Description
ChildrenField(JS) Specifies the name of the data source field that provides nested items for a group. Applies to hierarchical data sources only. Mirrors the client-side childrenField option.
ChildrenField(String) Specifies the name of the data source field that provides nested items for a group. Applies to hierarchical data sources only. Mirrors the client-side childrenField option.
ColorField(JS) Specifies the name of the data source field that provides colors for tiles. Mirrors the client-side colorField option.
ColorField(String) Specifies the name of the data source field that provides colors for tiles. Mirrors the client-side colorField option.
Colorizer(Action<TreeMapColorizerBuilder>) Manages the color settings. Mirrors the client-side colorizer object.
DataSource(JS) Binds the UI component to data. Mirrors the client-side dataSource option.
DataSource(IEnumerable, String[]) Binds a TreeMap control to a collection: Array, List, or IEnumerable.
DataSource(Func<DataSourceFactory, OptionsOwnerBuilder>) Binds a TreeMap control to data, allows you to configure data access from different sources: API controllers, Razor page handlers, OData services, arrays, and more.
DataSource(String, String[]) Binds a TreeMap control to read-only data in JSON format.
DataSourceOptions(Action<DataSourceOptionsBuilder>) Provides access to methods that mirror client-side data source options.
Disabled(JS) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
Disabled(Boolean) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
ElementAttr(JS) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Dictionary<String, Object>) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(String, Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Export(Action<TreeMapExportBuilder>) Configures the exporting and printing features. Mirrors the client-side export object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
Group(Action<TreeMapGroupBuilder>) Configures groups. Mirrors the client-side group object.
HoverEnabled(JS) Specifies whether tiles and groups change their style when a user pauses on them. Mirrors the client-side hoverEnabled option.
HoverEnabled(Boolean) Specifies whether tiles and groups change their style when a user pauses on them. Mirrors the client-side hoverEnabled option.
ID(JS) Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
ID(String) Specifies the id attribute for the control’s HTML element.
IdField(JS) Specifies the name of the data source field that provides IDs for items. Applies to plain data sources only. Mirrors the client-side idField option.
IdField(String) Specifies the name of the data source field that provides IDs for items. Applies to plain data sources only. Mirrors the client-side idField option.
InteractWithGroup(JS) Specifies whether the user will interact with a single tile or its group. Mirrors the client-side interactWithGroup option.
InteractWithGroup(Boolean) Specifies whether the user will interact with a single tile or its group. Mirrors the client-side interactWithGroup option.
LabelField(JS) Specifies the name of the data source field that provides texts for tile and group labels. Mirrors the client-side labelField option.
LabelField(String) Specifies the name of the data source field that provides texts for tile and group labels. Mirrors the client-side labelField option.
LayoutAlgorithm(TreeMapLayoutAlgorithm) Specifies the layout algorithm. Mirrors the client-side layoutAlgorithm option.
LayoutDirection(TreeMapLayoutDirection) Specifies the direction in which the items will be laid out. Mirrors the client-side layoutDirection option.
LoadingIndicator(Action<TreeMapLoadingIndicatorBuilder>) Configures the loading indicator. Mirrors the client-side loadingIndicator object.
MaxDepth(JS) Specifies how many hierarchical levels must be visualized. Mirrors the client-side maxDepth option.
MaxDepth(Double) Specifies how many hierarchical levels must be visualized. Mirrors the client-side maxDepth option.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnClick(RazorBlock) A function that is executed when a node is clicked or tapped. Mirrors the client-side onClick option.
OnClick(String) A function that is executed when a node is clicked or tapped. Mirrors the client-side onClick option.
OnDisposing(RazorBlock) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnDisposing(String) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnDrawn(RazorBlock) A function that is executed when the UI component's rendering has finished. Mirrors the client-side onDrawn option.
OnDrawn(String) A function that is executed when the UI component's rendering has finished. Mirrors the client-side onDrawn option.
OnDrill(RazorBlock) A function that is executed when a user drills up or down. Mirrors the client-side onDrill option.
OnDrill(String) A function that is executed when a user drills up or down. Mirrors the client-side onDrill option.
OnExported(RazorBlock) A function that is executed after the UI component is exported. Mirrors the client-side onExported option.
OnExported(String) A function that is executed after the UI component is exported. Mirrors the client-side onExported option.
OnExporting(RazorBlock) A function that is executed before the UI component is exported. Mirrors the client-side onExporting option.
OnExporting(String) A function that is executed before the UI component is exported. Mirrors the client-side onExporting option.
OnFileSaving(RazorBlock) A function that is executed before a file with exported UI component is saved to the user's local storage. Mirrors the client-side onFileSaving option.
OnFileSaving(String) A function that is executed before a file with exported UI component is saved to the user's local storage. Mirrors the client-side onFileSaving option.
OnHoverChanged(RazorBlock) A function that is executed after the pointer enters or leaves a node. Mirrors the client-side onHoverChanged option.
OnHoverChanged(String) A function that is executed after the pointer enters or leaves a node. Mirrors the client-side onHoverChanged option.
OnIncidentOccurred(RazorBlock) A function that is executed when an error or warning occurs. Mirrors the client-side onIncidentOccurred option.
OnIncidentOccurred(String) A function that is executed when an error or warning occurs. Mirrors the client-side onIncidentOccurred option.
OnInitialized(RazorBlock) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnInitialized(String) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnNodesInitialized(RazorBlock) A function that is executed only once, after the nodes are initialized. Mirrors the client-side onNodesInitialized option.
OnNodesInitialized(String) A function that is executed only once, after the nodes are initialized. Mirrors the client-side onNodesInitialized option.
OnNodesRendering(RazorBlock) A function that is executed before the nodes are displayed and each time the collection of active nodes is changed. Mirrors the client-side onNodesRendering option.
OnNodesRendering(String) A function that is executed before the nodes are displayed and each time the collection of active nodes is changed. Mirrors the client-side onNodesRendering option.
OnOptionChanged(RazorBlock) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnOptionChanged(String) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnSelectionChanged(RazorBlock) A function that is executed when a node is selected or selection is canceled. Mirrors the client-side onSelectionChanged option.
OnSelectionChanged(String) A function that is executed when a node is selected or selection is canceled. Mirrors the client-side onSelectionChanged option.
Option(String, Object) Specifies an option by its name.
ParentField(JS) Specifies the name of the data source field that provides parent IDs for items. Applies to plain data sources only. Mirrors the client-side parentField option.
ParentField(String) Specifies the name of the data source field that provides parent IDs for items. Applies to plain data sources only. Mirrors the client-side parentField option.
PathModified(JS) Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path. Mirrors the client-side pathModified option.
PathModified(Boolean) Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path. Mirrors the client-side pathModified option.
RedrawOnResize(JS) Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates. Mirrors the client-side redrawOnResize option.
RedrawOnResize(Boolean) Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates. Mirrors the client-side redrawOnResize option.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Render() Inherited from WidgetBuilder.
RtlEnabled(JS) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
RtlEnabled(Boolean) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
SelectionMode(SelectionMode) Specifies whether a single or multiple nodes can be in the selected state simultaneously. Mirrors the client-side selectionMode option.
Size(Action<TreeMapSizeBuilder>) Mirrors the client-side size object.
Theme(VizTheme) Sets the name of the theme the UI component uses. Mirrors the client-side theme option.
Tile(Action<TreeMapTileBuilder>) Configures tiles. Mirrors the client-side tile object.
Title(JS) Configures the UI component's title. Mirrors the client-side title option.
Title(Action<TreeMapTitleBuilder>) Configures the UI component's title. Mirrors the client-side title object.
Title(String) Configures the UI component's title. Mirrors the client-side title option.
Tooltip(Action<TreeMapTooltipBuilder>) Mirrors the client-side tooltip object.
ToString() Inherited from WidgetBuilder.
ToTemplate() Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder.
ValueField(JS) Specifies the name of the data source field that provides values for tiles. Mirrors the client-side valueField option.
ValueField(String) Specifies the name of the data source field that provides values for tiles. Mirrors the client-side valueField option.
See Also