TreeMapComponent

Represents react TreeMap Component

<TreeMapComponent></TreeMapComponent>

Properties

allowImageExport

boolean

Enables and disables the export to image functionality in treemap.

Defaults to false

allowPdfExport

boolean

Enables and disables the export to pdf functionality in treemap.

Defaults to false

allowPrint

boolean

Enables and disables the print functionality in treemap.

Defaults to false

background

string

Sets and gets the background color of the treemap.

border

BorderModel

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

breadcrumbConnector

string

Specifies the connection between the two words.

colorValuePath

string

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

dataSource

DataManager | TreeMapAjax | Object[]

Sets and gets the data source for the treemap component.

Defaults to null

description

string

Sets and gets the description for treemap.

Defaults to null

drillDownView

boolean

Enables or disables the initial drill in the treemap.

enableBreadcrumb

boolean

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

enableDrillDown

boolean

Enables or disables the drill down functionality in treemap.

enablePersistence

boolean

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

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

equalColorValuePath

string

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

format

string

Sets and gets format for the texts in the treemap.

Defaults to null

height

string

Sets and gets the height of the treemap component.

Defaults to null

highlightSettings

HighlightSettingsModel

Sets and gets the options for customizing the highlight of the treemap item on mouse over on the treemap component.

initialDrillDown

InitialDrillSettingsModel

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

layoutType

LayoutMode

Specifies the rendering type of layout of the treemap component.

leafItemSettings

LeafItemSettingsModel

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

legendSettings

LegendSettingsModel

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

levels

LevelSettingsModel[]

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

locale

string

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

Defaults to ”

margin

MarginModel

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

palette

string[]

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

query

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.

Defaults to null

rangeColorValuePath

string

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

renderDirection

RenderingMode

Specifies the rendering direction of layout of the treemap items.

Defaults to TopLeftBottomRight

selectionSettings

SelectionSettingsModel

Sets and gets the options for customizing the selection of the treemap item on click event on the treemap component.

tabIndex

number

Sets and gets the tab index value for treemap.

Defaults to 1

theme

TreeMapTheme

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

titleSettings

TitleSettingsModel

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

tooltipSettings

TooltipSettingsModel

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

treeMapHighlightModule

TreeMapHighlight

Sets and gets the module that is used to add highlight functionality in the treemap.

treeMapLegendModule

TreeMapLegend

Sets and gets the module that is used to add legend in the treemap.

treeMapSelectionModule

TreeMapSelection

Sets and gets the module that is used to add selection functionality in the treemap.

treeMapTooltipModule

TreeMapTooltip

Sets and gets the module that is used to add tooltip in the treemap.

useGroupingSeparator

boolean

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

Defaults to false

weightValuePath

string

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

width

string

Sets and gets the width of the treemap component.

Defaults to null

Methods

calculateSelectedTextLevels

This method calculates the selected treemap levels.

Returns any

clickOnTreeMap

This method handles the click event on the treemap.

Returns void

compareSelectedLabelWithDrillDownItems

This method compares the selected labels with the drill down items.

Returns any

destroy

This method is used to dispose the treemap component.

Returns void

doubleClickOnTreeMap

This method handles the double click event in the treemap.

Returns void

export

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

Returns Promise

findTotalWeight

This method finds the weight value of the treemap level.

Returns void

getModuleName

Gets component name.

Returns string

mouseDownOnTreeMap

This method handles the mouse down event in the treemap.

Returns void

mouseEndOnTreeMap

This method handles mouse end event in treemap.

Returns void

mouseLeaveOnTreeMap

This method handles mouse leave event in treemap.

Returns void

mouseMoveOnTreeMap

This method handles the mouse move event in the treemap.

Returns void

print

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

Returns void

reOrderLevelData

This method orders the treemap level data.

Returns void

resizeOnTreeMap

This method handles the window resize event on treemap.

Returns void

rightClickOnTreeMap

This method handles the right click event in the treemap.

Returns void

selectItem

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

Returns void

Events

beforePrint

EmitType<IPrintEventArgs>

Triggers before the prints gets started.

click

EmitType<IItemClickEventArgs>

Triggers after clicking on the treemap.

doubleClick

EmitType<IDoubleClickEventArgs>

Triggers after double clicking on the treemap.

drillEnd

EmitType<IDrillEndEventArgs>

Triggers after drill down functionality gets completed in the treemap.

drillStart

EmitType<IDrillStartEventArgs>

Triggers on performing drill down functionality in the treemap.

itemClick

EmitType<IItemClickEventArgs>

Triggers after clicking an item in the treemap.

itemHighlight

EmitType<IItemHighlightEventArgs>

Triggers after highlighting on the treemap item.

itemMove

EmitType<IItemMoveEventArgs>

Triggers after mouse hover on the treemap item.

itemRendering

EmitType<IItemRenderingEventArgs>

Triggers before item rendering in the treemap component.

itemSelected

EmitType<IItemSelectedEventArgs>

Triggers after selecting a treemap item.

legendItemRendering

EmitType<ILegendItemRenderingEventArgs>

Triggers before rendering each legend item in the treemap.

legendRendering

EmitType<ILegendRenderingEventArgs>

Triggers before rendering the legend items in the treemap.

load

EmitType<ILoadEventArgs>

Triggers when the treemap is on load.

loaded

EmitType<ILoadedEventArgs>

Triggers after treemap is rendered.

mouseMove

EmitType<IMouseMoveEventArgs>

Triggers after mouse hover on the treemap.

resize

EmitType<IResizeEventArgs>

Triggers after resizing the treemap component.

rightClick

EmitType<IMouseMoveEventArgs>

Triggers after right clicking on the treemap.

tooltipRendering

EmitType<ITreeMapTooltipRenderEventArgs>

Triggers on rendering of the tooltip in the treemap component.