Constructors

Section titled "Constructors"

IgrTreemap 

new IgrTreemap(props: IIgrTreemapProps): IgrTreemap

Returns IgrTreemap

Properties

Section titled "Properties"

actualStyleMappings

Section titled "actualStyleMappings"

The style mappings actually present in the treemap. Do not directly modify this array. This array's contents can be modified by causing React to reproject the child content. Or adding and removing ranges from the manual ranges collection on the ranges property.

 
actualStyleMappings: IgrTreemapNodeStyleMapping[]

contentStyleMappings

Section titled "contentStyleMappings" 
contentStyleMappings: IgrTreemapNodeStyleMapping[]

Accessors

Section titled "Accessors"

actualHighlightingMode

Section titled "actualHighlightingMode"

Gets the actual highlighting mode used.

 
get actualHighlightingMode(): TreemapHighlightingMode

Returns TreemapHighlightingMode 

set actualHighlightingMode(v: TreemapHighlightingMode): void

Parameters

Returns void

actualInteractionPixelScalingRatio

Section titled "actualInteractionPixelScalingRatio"

Gets or sets the resolved scaling value used to affect the pixel density of the control while it is animating. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

 
get actualInteractionPixelScalingRatio(): number

Returns number 

set actualInteractionPixelScalingRatio(v: number): void

Parameters

  • v: number

Returns void

actualPixelScalingRatio

Section titled "actualPixelScalingRatio" 
get actualPixelScalingRatio(): number

Returns number 

set actualPixelScalingRatio(v: number): void

Parameters

  • v: number

Returns void

animating

Section titled "animating" 
get animating(): boolean

Returns boolean

Section titled "breadcrumbSequence"

Gets or sets the root title to use for breadcrumbs.

 
get breadcrumbSequence(): string

Returns string 

set breadcrumbSequence(v: string): void

Parameters

  • v: string

Returns void

customValueMemberPath

Section titled "customValueMemberPath"

Gets or sets the path to use to get the custom value of the items.

 
get customValueMemberPath(): string

Returns string 

set customValueMemberPath(v: string): void

Parameters

  • v: string

Returns void

darkTextColor

Section titled "darkTextColor"

Gets or sets the dark text color to use for the nodes.

 
get darkTextColor(): string

Returns string 

set darkTextColor(v: string): void

Parameters

  • v: string

Returns void

dataSource

Section titled "dataSource"

Gets or sets the (possibly hierarchical) data to assign to the TreeMap.

 
get dataSource(): any[]

Returns any[] 

set dataSource(v: any[]): void

Parameters

  • v: any[]

Returns void

fillBrushes

Section titled "fillBrushes"

Gets or sets brushes to use for the fill scale.

 
get fillBrushes(): string[]

Returns string[] 

set fillBrushes(v: string[]): void

Parameters

  • v: string[]

Returns void

fillScaleLogarithmBase

Section titled "fillScaleLogarithmBase"

Gets or sets the logarithm base to use if the fill scale is logarithmic.

 
get fillScaleLogarithmBase(): number

Returns number 

set fillScaleLogarithmBase(v: number): void

Parameters

  • v: number

Returns void

fillScaleMaximumValue

Section titled "fillScaleMaximumValue"

Gets or sets the maximum value to use for the fill scale.

 
get fillScaleMaximumValue(): number

Returns number 

set fillScaleMaximumValue(v: number): void

Parameters

  • v: number

Returns void

fillScaleMinimumValue

Section titled "fillScaleMinimumValue"

Gets or sets the minimum value to use for the fill scale.

 
get fillScaleMinimumValue(): number

Returns number 

set fillScaleMinimumValue(v: number): void

Parameters

  • v: number

Returns void

fillScaleMode

Section titled "fillScaleMode"

Gets or sets mode to use for the fill scale.

 
get fillScaleMode(): TreemapFillScaleMode

Returns TreemapFillScaleMode 

set fillScaleMode(v: TreemapFillScaleMode): void

Parameters

Returns void

focusItem

Section titled "focusItem"

Gets or sets the item to drill to in the treemap.

 
get focusItem(): any

Returns any 

set focusItem(v: any): void

Parameters

  • v: any

Returns void

headerBackground

Section titled "headerBackground"

Gets or sets the background to use for the header.

 
get headerBackground(): string

Returns string 

set headerBackground(v: string): void

Parameters

  • v: string

Returns void

headerDarkTextColor

Section titled "headerDarkTextColor"

Gets or sets the dark text color to use for the header.

 
get headerDarkTextColor(): string

Returns string 

set headerDarkTextColor(v: string): void

Parameters

  • v: string

Returns void

headerDisplayMode

Section titled "headerDisplayMode"

Gets or sets the font to use for header nodes

 
get headerDisplayMode(): TreemapHeaderDisplayMode

Returns TreemapHeaderDisplayMode 

set headerDisplayMode(v: TreemapHeaderDisplayMode): void

Parameters

Returns void

headerHeight

Section titled "headerHeight"

Gets or sets the height to use for the header.

 
get headerHeight(): number

Returns number 

set headerHeight(v: number): void

Parameters

  • v: number

Returns void

headerHoverBackground

Section titled "headerHoverBackground"

Gets or sets the background to use for the header when it is hovered.

 
get headerHoverBackground(): string

Returns string 

set headerHoverBackground(v: string): void

Parameters

  • v: string

Returns void

headerHoverDarkTextColor

Section titled "headerHoverDarkTextColor"

Gets or sets the dark text color to use for the header when hovered.

 
get headerHoverDarkTextColor(): string

Returns string 

set headerHoverDarkTextColor(v: string): void

Parameters

  • v: string

Returns void

headerHoverTextColor

Section titled "headerHoverTextColor"

Gets or sets the text color to use for the header.

 
get headerHoverTextColor(): string

Returns string 

set headerHoverTextColor(v: string): void

Parameters

  • v: string

Returns void

headerLabelBottomMargin

Section titled "headerLabelBottomMargin"

Gets or sets the bottom margin to use for the header.

 
get headerLabelBottomMargin(): number

Returns number 

set headerLabelBottomMargin(v: number): void

Parameters

  • v: number

Returns void

headerLabelLeftMargin

Section titled "headerLabelLeftMargin"

Gets or sets the left margin to use for the header.

 
get headerLabelLeftMargin(): number

Returns number 

set headerLabelLeftMargin(v: number): void

Parameters

  • v: number

Returns void

headerLabelRightMargin

Section titled "headerLabelRightMargin"

Gets or sets the right margin to use for the header.

 
get headerLabelRightMargin(): number

Returns number 

set headerLabelRightMargin(v: number): void

Parameters

  • v: number

Returns void

headerLabelTopMargin

Section titled "headerLabelTopMargin"

Gets or sets the top margin to use for the header.

 
get headerLabelTopMargin(): number

Returns number 

set headerLabelTopMargin(v: number): void

Parameters

  • v: number

Returns void

headerTextColor

Section titled "headerTextColor"

Gets or sets the text color to use for the header.

 
get headerTextColor(): string

Returns string 

set headerTextColor(v: string): void

Parameters

  • v: string

Returns void

headerTextStyle

Section titled "headerTextStyle"

Gets or sets the font to use for header nodes

 
get headerTextStyle(): string

Returns string 

set headerTextStyle(v: string): void

Parameters

  • v: string

Returns void

height

Section titled "height" 
get height(): string

Returns string 

set height(value: string): void

Parameters

  • value: string

Returns void

highlightedDataSource

Section titled "highlightedDataSource"

Gets or sets the data to highlight.

 
get highlightedDataSource(): any[]

Returns any[] 

set highlightedDataSource(v: any[]): void

Parameters

  • v: any[]

Returns void

highlightedValueMemberPath

Section titled "highlightedValueMemberPath"

Gets or sets the highlighted value mapping property.

 
get highlightedValueMemberPath(): string

Returns string 

set highlightedValueMemberPath(v: string): void

Parameters

  • v: string

Returns void

highlightedValueOpacity

Section titled "highlightedValueOpacity"

Gets or sets the opacity applied to the node underneath the highlighted value.

 
get highlightedValueOpacity(): number

Returns number 

set highlightedValueOpacity(v: number): void

Parameters

  • v: number

Returns void

highlightedValuesDisplayMode

Section titled "highlightedValuesDisplayMode"

Gets or sets the display mode for highlighted values.

 
get highlightedValuesDisplayMode(): TreemapHighlightedValueDisplayMode

Returns TreemapHighlightedValueDisplayMode 

set highlightedValuesDisplayMode(v: TreemapHighlightedValueDisplayMode): void

Parameters

Returns void

highlightingFadeOpacity

Section titled "highlightingFadeOpacity"

Gets or sets the opacity to use for nodes that are not highlighted when HighlightingMode is set to FadeOthers.

 
get highlightingFadeOpacity(): number

Returns number 

set highlightingFadeOpacity(v: number): void

Parameters

  • v: number

Returns void

highlightingMode

Section titled "highlightingMode"

Gets or sets the highlighting mode to use.

 
get highlightingMode(): TreemapHighlightingMode

Returns TreemapHighlightingMode 

set highlightingMode(v: TreemapHighlightingMode): void

Parameters

Returns void

highlightingTransitionDuration

Section titled "highlightingTransitionDuration"

Gets or sets the number of milliseconds over which the highlighting effect will render.

 
get highlightingTransitionDuration(): number

Returns number 

set highlightingTransitionDuration(v: number): void

Parameters

  • v: number

Returns void

i

Section titled "i" 
get i(): Treemap

Returns Treemap

idMemberPath

Section titled "idMemberPath"

Gets or sets the path to use to get the id of the items.

 
get idMemberPath(): string

Returns string 

set idMemberPath(v: string): void

Parameters

  • v: string

Returns void

interactionPixelScalingRatio

Section titled "interactionPixelScalingRatio"

Gets or sets the scaling value used to affect the pixel density of the control while it is animating. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

 
get interactionPixelScalingRatio(): number

Returns number 

set interactionPixelScalingRatio(v: number): void

Parameters

  • v: number

Returns void

isFillScaleLogarithmic

Section titled "isFillScaleLogarithmic"

Gets or sets whether the fill scale is logarithmic.

 
get isFillScaleLogarithmic(): boolean

Returns boolean 

set isFillScaleLogarithmic(v: boolean): void

Parameters

  • v: boolean

Returns void

labelBottomMargin

Section titled "labelBottomMargin"

Gets or sets the bottom margin to use for the labels.

 
get labelBottomMargin(): number

Returns number 

set labelBottomMargin(v: number): void

Parameters

  • v: number

Returns void

labelHorizontalAlignment

Section titled "labelHorizontalAlignment"

Gets or sets the horizontal alignment to use for the node labels.

 
get labelHorizontalAlignment(): HorizontalAlignment

Returns HorizontalAlignment 

set labelHorizontalAlignment(v: HorizontalAlignment): void

Parameters

  • v: HorizontalAlignment

Returns void

labelHorizontalFitMode

Section titled "labelHorizontalFitMode"

Gets or sets the horizontal fit mode to use for the node labels.

 
get labelHorizontalFitMode(): TreemapLabelHorizontalFitMode

Returns TreemapLabelHorizontalFitMode 

set labelHorizontalFitMode(v: TreemapLabelHorizontalFitMode): void

Parameters

Returns void

labelLeftMargin

Section titled "labelLeftMargin"

Gets or sets the left margin to use for the labels.

 
get labelLeftMargin(): number

Returns number 

set labelLeftMargin(v: number): void

Parameters

  • v: number

Returns void

labelMemberPath

Section titled "labelMemberPath"

Gets or sets the path to use to get the Label of the items.

 
get labelMemberPath(): string

Returns string 

set labelMemberPath(v: string): void

Parameters

  • v: string

Returns void

labelRightMargin

Section titled "labelRightMargin"

Gets or sets the right margin to use for the labels.

 
get labelRightMargin(): number

Returns number 

set labelRightMargin(v: number): void

Parameters

  • v: number

Returns void

labelTopMargin

Section titled "labelTopMargin"

Gets or sets the top margin to use for the labels.

 
get labelTopMargin(): number

Returns number 

set labelTopMargin(v: number): void

Parameters

  • v: number

Returns void

labelVerticalAlignment

Section titled "labelVerticalAlignment"

Gets or sets the vertical alignment to use for the node labels.

 
get labelVerticalAlignment(): VerticalAlignment

Returns VerticalAlignment 

set labelVerticalAlignment(v: VerticalAlignment): void

Parameters

  • v: VerticalAlignment

Returns void

labelVerticalFitMode

Section titled "labelVerticalFitMode"

Gets or sets the vertical fit mode to use for the node labels.

 
get labelVerticalFitMode(): TreemapLabelVerticalFitMode

Returns TreemapLabelVerticalFitMode 

set labelVerticalFitMode(v: TreemapLabelVerticalFitMode): void

Parameters

Returns void

layoutOrientation

Section titled "layoutOrientation"

Gets or sets the orientation to use for the stripped and slice and dice layout types.

 
get layoutOrientation(): TreemapOrientation

Returns TreemapOrientation 

set layoutOrientation(v: TreemapOrientation): void

Parameters

Returns void

layoutType

Section titled "layoutType"

Gets or sets the type of layout to use for the nodes.

 
get layoutType(): TreemapLayoutType

Returns TreemapLayoutType 

set layoutType(v: TreemapLayoutType): void

Parameters

Returns void

minimumDisplaySize

Section titled "minimumDisplaySize"

Gets or sets the minimum size (width or height) to display a node.

 
get minimumDisplaySize(): number

Returns number 

set minimumDisplaySize(v: number): void

Parameters

  • v: number

Returns void

nodeOpacity

Section titled "nodeOpacity"

Gets or sets the opacity to use for the nodes.

 
get nodeOpacity(): number

Returns number 

set nodeOpacity(v: number): void

Parameters

  • v: number

Returns void

nodePointerEnter

Section titled "nodePointerEnter"

Fired when the pointer enters a node.

 
get nodePointerEnter(): object

Returns object 

set nodePointerEnter(ev: object): void

Parameters

  • ev: object

Returns void

nodePointerLeave

Section titled "nodePointerLeave"

Fired when the pointer leaved a node.

 
get nodePointerLeave(): object

Returns object 

set nodePointerLeave(ev: object): void

Parameters

  • ev: object

Returns void

nodePointerOver

Section titled "nodePointerOver"

Fired with the pointer is moving over a node.

 
get nodePointerOver(): object

Returns object 

set nodePointerOver(ev: object): void

Parameters

  • ev: object

Returns void

nodePointerPressed

Section titled "nodePointerPressed"

Fired when the pointer is pressed on a node.

 
get nodePointerPressed(): object

Returns object 

set nodePointerPressed(ev: object): void

Parameters

  • ev: object

Returns void

nodePointerReleased

Section titled "nodePointerReleased"

Fired when the pointer is released on a node.

 
get nodePointerReleased(): object

Returns object 

set nodePointerReleased(ev: object): void

Parameters

  • ev: object

Returns void

nodeRenderStyling

Section titled "nodeRenderStyling"

Fired before a node is rendered for last minute style changes.

 
get nodeRenderStyling(): object

Returns object 

set nodeRenderStyling(ev: object): void

Parameters

  • ev: object

Returns void

nodeStyling

Section titled "nodeStyling"

Fired when a node is being styled. Provides an opportunity to customize node styling.

 
get nodeStyling(): object

Returns object 

set nodeStyling(ev: object): void

Parameters

  • ev: object

Returns void

outline

Section titled "outline"

Gets or sets the outline to use for the nodes.

 
get outline(): string

Returns string 

set outline(v: string): void

Parameters

  • v: string

Returns void

overlayHeaderBackground

Section titled "overlayHeaderBackground"

Gets or sets the background to use for the overlay header.

 
get overlayHeaderBackground(): string

Returns string 

set overlayHeaderBackground(v: string): void

Parameters

  • v: string

Returns void

overlayHeaderHoverBackground

Section titled "overlayHeaderHoverBackground"

Gets or sets the background to use for the overlay header when it is hovered.

 
get overlayHeaderHoverBackground(): string

Returns string 

set overlayHeaderHoverBackground(v: string): void

Parameters

  • v: string

Returns void

overlayHeaderLabelBottomMargin

Section titled "overlayHeaderLabelBottomMargin"

Gets or sets the bottom margin to use for the overlay header.

 
get overlayHeaderLabelBottomMargin(): number

Returns number 

set overlayHeaderLabelBottomMargin(v: number): void

Parameters

  • v: number

Returns void

overlayHeaderLabelLeftMargin

Section titled "overlayHeaderLabelLeftMargin"

Gets or sets the left margin to use for the overlay header.

 
get overlayHeaderLabelLeftMargin(): number

Returns number 

set overlayHeaderLabelLeftMargin(v: number): void

Parameters

  • v: number

Returns void

overlayHeaderLabelRightMargin

Section titled "overlayHeaderLabelRightMargin"

Gets or sets the right margin to use for the overlay header.

 
get overlayHeaderLabelRightMargin(): number

Returns number 

set overlayHeaderLabelRightMargin(v: number): void

Parameters

  • v: number

Returns void

overlayHeaderLabelTopMargin

Section titled "overlayHeaderLabelTopMargin"

Gets or sets the top margin to use for the overlay header.

 
get overlayHeaderLabelTopMargin(): number

Returns number 

set overlayHeaderLabelTopMargin(v: number): void

Parameters

  • v: number

Returns void

parentIdMemberPath

Section titled "parentIdMemberPath"

Gets or sets the path to use to get the Parent of the items.

 
get parentIdMemberPath(): string

Returns string 

set parentIdMemberPath(v: string): void

Parameters

  • v: string

Returns void

parentNodeBottomMargin

Section titled "parentNodeBottomMargin"

Gets or sets the bottom margin to use for the parent nodes.

 
get parentNodeBottomMargin(): number

Returns number 

set parentNodeBottomMargin(v: number): void

Parameters

  • v: number

Returns void

parentNodeBottomPadding

Section titled "parentNodeBottomPadding"

Gets or sets the bottom padding to use for the parent nodes.

 
get parentNodeBottomPadding(): number

Returns number 

set parentNodeBottomPadding(v: number): void

Parameters

  • v: number

Returns void

parentNodeLeftMargin

Section titled "parentNodeLeftMargin"

Gets or sets the left margin to use for the parent nodes.

 
get parentNodeLeftMargin(): number

Returns number 

set parentNodeLeftMargin(v: number): void

Parameters

  • v: number

Returns void

parentNodeLeftPadding

Section titled "parentNodeLeftPadding"

Gets or sets the left padding to use for the parent nodes.

 
get parentNodeLeftPadding(): number

Returns number 

set parentNodeLeftPadding(v: number): void

Parameters

  • v: number

Returns void

parentNodeRightMargin

Section titled "parentNodeRightMargin"

Gets or sets the right margin to use for the parent nodes.

 
get parentNodeRightMargin(): number

Returns number 

set parentNodeRightMargin(v: number): void

Parameters

  • v: number

Returns void

parentNodeRightPadding

Section titled "parentNodeRightPadding"

Gets or sets the right padding to use for the parent nodes.

 
get parentNodeRightPadding(): number

Returns number 

set parentNodeRightPadding(v: number): void

Parameters

  • v: number

Returns void

parentNodeTopMargin

Section titled "parentNodeTopMargin"

Gets or sets the top margin to use for the parent nodes.

 
get parentNodeTopMargin(): number

Returns number 

set parentNodeTopMargin(v: number): void

Parameters

  • v: number

Returns void

parentNodeTopPadding

Section titled "parentNodeTopPadding"

Gets or sets the top padding to use for the parent nodes.

 
get parentNodeTopPadding(): number

Returns number 

set parentNodeTopPadding(v: number): void

Parameters

  • v: number

Returns void

pixelScalingRatio

Section titled "pixelScalingRatio"

Gets or sets the scaling value used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

 
get pixelScalingRatio(): number

Returns number 

set pixelScalingRatio(v: number): void

Parameters

  • v: number

Returns void

rootTitle

Section titled "rootTitle"

Gets or sets the root title to use for breadcrumbs.

 
get rootTitle(): string

Returns string 

set rootTitle(v: string): void

Parameters

  • v: string

Returns void

strokeThickness

Section titled "strokeThickness"

Gets or sets the stroke thickness to use for the node outline.

 
get strokeThickness(): number

Returns number 

set strokeThickness(v: number): void

Parameters

  • v: number

Returns void

styleMappings

Section titled "styleMappings"

A collection of manually added style mappings for the treemap.

 
get styleMappings(): IgrTreemapNodeStyleMappingCollection

Returns IgrTreemapNodeStyleMappingCollection

textColor

Section titled "textColor"

Gets or sets the text color to use for the nodes.

 
get textColor(): string

Returns string 

set textColor(v: string): void

Parameters

  • v: string

Returns void

textStyle

Section titled "textStyle"

Gets or sets the font to use for content nodes

 
get textStyle(): string

Returns string 

set textStyle(v: string): void

Parameters

  • v: string

Returns void

transitionDuration

Section titled "transitionDuration"

Gets or sets the number of milliseconds over which changes to the gauge should be animated.

 
get transitionDuration(): number

Returns number 

set transitionDuration(v: number): void

Parameters

  • v: number

Returns void

valueMemberPath

Section titled "valueMemberPath"

Gets or sets path to use to get the values from the items.

 
get valueMemberPath(): string

Returns string 

set valueMemberPath(v: string): void

Parameters

  • v: string

Returns void

width

Section titled "width" 
get width(): string

Returns string 

set width(value: string): void

Parameters

  • value: string

Returns void

Methods

Section titled "Methods"

componentDidMount

Section titled "componentDidMount" 
componentDidMount(): void

Returns void

componentWillUnmount

Section titled "componentWillUnmount" 
componentWillUnmount(): void

Returns void

destroy

Section titled "destroy" 
destroy(): void

Returns void

exportSerializedVisualData

Section titled "exportSerializedVisualData"

Returns visuals as a serialized string.

 
exportSerializedVisualData(): string

Returns string

findByName

Section titled "findByName" 
findByName(name: string): any

Parameters

  • name: string

Returns any

flush

Section titled "flush" 
flush(): void

Returns void

initializeContent

Section titled "initializeContent" 
initializeContent(): void

Returns void

markDirty

Section titled "markDirty" 
markDirty(): void

Returns void

notifyClearItems

Section titled "notifyClearItems"

Manually notifies the treemap's data source that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the pie chart is bound to is already observable.

 
notifyClearItems(source_: any): void

Parameters

  • source_: any
    • The data source.

Returns void

notifyInsertItem

Section titled "notifyInsertItem" 
notifyInsertItem(source_: any, index: number, newItem: any): void

Parameters

  • source_: any
  • index: number
  • newItem: any

Returns void

notifyRemoveItem

Section titled "notifyRemoveItem" 
notifyRemoveItem(source_: any, index: number, oldItem: any): void

Parameters

  • source_: any
  • index: number
  • oldItem: any

Returns void

notifySetItem

Section titled "notifySetItem" 
notifySetItem(source_: any, index: number, oldItem: any, newItem: any): void

Parameters

  • source_: any
  • index: number
  • oldItem: any
  • newItem: any

Returns void

notifySizeChanged

Section titled "notifySizeChanged" 
notifySizeChanged(): void

Returns void

onAttachedToUI

Section titled "onAttachedToUI" 
onAttachedToUI(): void

Returns void

onDetachedFromUI

Section titled "onDetachedFromUI" 
onDetachedFromUI(): void

Returns void

render

Section titled "render" 
render(): DetailedReactHTMLElement<object, any>

Returns DetailedReactHTMLElement<object, any>

shouldComponentUpdate

Section titled "shouldComponentUpdate" 
shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

simulateHover

Section titled "simulateHover" 
simulateHover(point: IgPoint): void

Parameters

  • point: IgPoint

Returns void

updateStyle

Section titled "updateStyle" 
updateStyle(): void

Returns void