Class IgrTreemap<S, SS, S>

Type parameters

  • S

  • SS

  • S

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    Returns IgrTreemap

Properties

actualStyleMappings

actualStyleMappings: IgrTreemapNodeStyleMapping[] = []

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.

contentStyleMappings

contentStyleMappings: IgrTreemapNodeStyleMapping[] = []

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

props

props: Readonly<IIgrTreemapProps> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<S>

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Accessors

actualInteractionPixelScalingRatio

  • get actualInteractionPixelScalingRatio(): number
  • set actualInteractionPixelScalingRatio(v: number): void
  • 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.

    Returns number

  • 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.

    Parameters

    • v: number

    Returns void

actualPixelScalingRatio

  • get actualPixelScalingRatio(): number
  • set actualPixelScalingRatio(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

animating

  • get animating(): boolean
  • Returns boolean

breadcrumbSequence

  • get breadcrumbSequence(): string
  • set breadcrumbSequence(v: string): void
  • Gets or sets the root title to use for breadcrumbs.

    Returns string

  • Gets or sets the root title to use for breadcrumbs.

    Parameters

    • v: string

    Returns void

customValueMemberPath

  • get customValueMemberPath(): string
  • set customValueMemberPath(v: string): void
  • Gets or sets the path to use to get the custom value of the items.

    Returns string

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

    Parameters

    • v: string

    Returns void

darkTextColor

  • get darkTextColor(): string
  • set darkTextColor(v: string): void
  • Gets or sets the dark text color to use for the nodes.

    Returns string

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

    Parameters

    • v: string

    Returns void

dataSource

  • get dataSource(): any[]
  • set dataSource(v: any[]): void
  • Gets or sets the (possibly hierarchical) data to assign to the TreeMap.

    Returns any[]

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

    Parameters

    • v: any[]

    Returns void

fillBrushes

  • get fillBrushes(): string[]
  • set fillBrushes(v: string[]): void
  • Gets or sets brushes to use for the fill scale.

    Returns string[]

  • Gets or sets brushes to use for the fill scale.

    Parameters

    • v: string[]

    Returns void

fillScaleLogarithmBase

  • get fillScaleLogarithmBase(): number
  • set fillScaleLogarithmBase(v: number): void
  • Gets or sets the logarithm base to use if the fill scale is logarithmic.

    Returns number

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

    Parameters

    • v: number

    Returns void

fillScaleMaximumValue

  • get fillScaleMaximumValue(): number
  • set fillScaleMaximumValue(v: number): void
  • Gets or sets the maximum value to use for the fill scale.

    Returns number

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

    Parameters

    • v: number

    Returns void

fillScaleMinimumValue

  • get fillScaleMinimumValue(): number
  • set fillScaleMinimumValue(v: number): void
  • Gets or sets the minimum value to use for the fill scale.

    Returns number

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

    Parameters

    • v: number

    Returns void

fillScaleMode

  • Gets or sets mode to use for the fill scale.

    Returns TreemapFillScaleMode

  • Gets or sets mode to use for the fill scale.

    Parameters

    Returns void

focusItem

  • get focusItem(): any
  • set focusItem(v: any): void
  • Gets or sets the item to drill to in the treemap.

    Returns any

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

    Parameters

    • v: any

    Returns void

headerBackground

  • get headerBackground(): string
  • set headerBackground(v: string): void
  • Gets or sets the background to use for the header.

    Returns string

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

    Parameters

    • v: string

    Returns void

headerDarkTextColor

  • get headerDarkTextColor(): string
  • set headerDarkTextColor(v: string): void
  • Gets or sets the dark text color to use for the header.

    Returns string

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

    Parameters

    • v: string

    Returns void

headerDisplayMode

  • Gets or sets the font to use for header nodes

    Returns TreemapHeaderDisplayMode

  • Gets or sets the font to use for header nodes

    Parameters

    Returns void

headerHeight

  • get headerHeight(): number
  • set headerHeight(v: number): void
  • Gets or sets the height to use for the header.

    Returns number

  • Gets or sets the height to use for the header.

    Parameters

    • v: number

    Returns void

headerHoverBackground

  • get headerHoverBackground(): string
  • set headerHoverBackground(v: string): void
  • Gets or sets the background to use for the header when it is hovered.

    Returns string

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

    Parameters

    • v: string

    Returns void

headerHoverDarkTextColor

  • get headerHoverDarkTextColor(): string
  • set headerHoverDarkTextColor(v: string): void
  • Gets or sets the dark text color to use for the header when hovered.

    Returns string

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

    Parameters

    • v: string

    Returns void

headerHoverTextColor

  • get headerHoverTextColor(): string
  • set headerHoverTextColor(v: string): void
  • Gets or sets the text color to use for the header.

    Returns string

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

    Parameters

    • v: string

    Returns void

headerLabelBottomMargin

  • get headerLabelBottomMargin(): number
  • set headerLabelBottomMargin(v: number): void
  • Gets or sets the bottom margin to use for the header.

    Returns number

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

    Parameters

    • v: number

    Returns void

headerLabelLeftMargin

  • get headerLabelLeftMargin(): number
  • set headerLabelLeftMargin(v: number): void
  • Gets or sets the left margin to use for the header.

    Returns number

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

    Parameters

    • v: number

    Returns void

headerLabelRightMargin

  • get headerLabelRightMargin(): number
  • set headerLabelRightMargin(v: number): void
  • Gets or sets the right margin to use for the header.

    Returns number

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

    Parameters

    • v: number

    Returns void

headerLabelTopMargin

  • get headerLabelTopMargin(): number
  • set headerLabelTopMargin(v: number): void
  • Gets or sets the top margin to use for the header.

    Returns number

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

    Parameters

    • v: number

    Returns void

headerTextColor

  • get headerTextColor(): string
  • set headerTextColor(v: string): void
  • Gets or sets the text color to use for the header.

    Returns string

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

    Parameters

    • v: string

    Returns void

headerTextStyle

  • get headerTextStyle(): string
  • set headerTextStyle(v: string): void
  • Gets or sets the font to use for header nodes

    Returns string

  • Gets or sets the font to use for header nodes

    Parameters

    • v: string

    Returns void

height

  • get height(): string
  • set height(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

i

  • get i(): Treemap
  • Returns Treemap

idMemberPath

  • get idMemberPath(): string
  • set idMemberPath(v: string): void
  • Gets or sets the path to use to get the id of the items.

    Returns string

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

    Parameters

    • v: string

    Returns void

interactionPixelScalingRatio

  • get interactionPixelScalingRatio(): number
  • set interactionPixelScalingRatio(v: number): void
  • 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.

    Returns number

  • 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.

    Parameters

    • v: number

    Returns void

isFillScaleLogarithmic

  • get isFillScaleLogarithmic(): boolean
  • set isFillScaleLogarithmic(v: boolean): void
  • Gets or sets whether the fill scale is logarithmic.

    Returns boolean

  • Gets or sets whether the fill scale is logarithmic.

    Parameters

    • v: boolean

    Returns void

labelBottomMargin

  • get labelBottomMargin(): number
  • set labelBottomMargin(v: number): void
  • Gets or sets the bottom margin to use for the labels.

    Returns number

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

    Parameters

    • v: number

    Returns void

labelHorizontalAlignment

  • get labelHorizontalAlignment(): HorizontalAlignment
  • set labelHorizontalAlignment(v: HorizontalAlignment): void
  • Gets or sets the horizontal alignment to use for the node labels.

    Returns HorizontalAlignment

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

    Parameters

    • v: HorizontalAlignment

    Returns void

labelHorizontalFitMode

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

    Returns TreemapLabelHorizontalFitMode

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

    Parameters

    Returns void

labelLeftMargin

  • get labelLeftMargin(): number
  • set labelLeftMargin(v: number): void
  • Gets or sets the left margin to use for the labels.

    Returns number

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

    Parameters

    • v: number

    Returns void

labelMemberPath

  • get labelMemberPath(): string
  • set labelMemberPath(v: string): void
  • Gets or sets the path to use to get the Label of the items.

    Returns string

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

    Parameters

    • v: string

    Returns void

labelRightMargin

  • get labelRightMargin(): number
  • set labelRightMargin(v: number): void
  • Gets or sets the right margin to use for the labels.

    Returns number

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

    Parameters

    • v: number

    Returns void

labelTopMargin

  • get labelTopMargin(): number
  • set labelTopMargin(v: number): void
  • Gets or sets the top margin to use for the labels.

    Returns number

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

    Parameters

    • v: number

    Returns void

labelVerticalAlignment

  • get labelVerticalAlignment(): VerticalAlignment
  • set labelVerticalAlignment(v: VerticalAlignment): void
  • Gets or sets the vertical alignment to use for the node labels.

    Returns VerticalAlignment

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

    Parameters

    • v: VerticalAlignment

    Returns void

labelVerticalFitMode

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

    Returns TreemapLabelVerticalFitMode

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

    Parameters

    Returns void

layoutOrientation

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

    Returns TreemapOrientation

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

    Parameters

    Returns void

layoutType

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

    Returns TreemapLayoutType

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

    Parameters

    Returns void

minimumDisplaySize

  • get minimumDisplaySize(): number
  • set minimumDisplaySize(v: number): void
  • Gets or sets the minimum size (width or height) to display a node.

    Returns number

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

    Parameters

    • v: number

    Returns void

nodePointerEnter

  • get nodePointerEnter(): function
  • set nodePointerEnter(ev: function): void

nodePointerLeave

  • get nodePointerLeave(): function
  • set nodePointerLeave(ev: function): void

nodePointerOver

  • get nodePointerOver(): function
  • set nodePointerOver(ev: function): void

nodePointerPressed

  • get nodePointerPressed(): function
  • set nodePointerPressed(ev: function): void

nodePointerReleased

  • get nodePointerReleased(): function
  • set nodePointerReleased(ev: function): void

nodeStyling

  • get nodeStyling(): function
  • set nodeStyling(ev: function): void

outline

  • get outline(): string
  • set outline(v: string): void
  • Gets or sets the outline to use for the nodes.

    Returns string

  • Gets or sets the outline to use for the nodes.

    Parameters

    • v: string

    Returns void

overlayHeaderBackground

  • get overlayHeaderBackground(): string
  • set overlayHeaderBackground(v: string): void
  • Gets or sets the background to use for the overlay header.

    Returns string

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

    Parameters

    • v: string

    Returns void

overlayHeaderHoverBackground

  • get overlayHeaderHoverBackground(): string
  • set overlayHeaderHoverBackground(v: string): void
  • Gets or sets the background to use for the overlay header when it is hovered.

    Returns string

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

    Parameters

    • v: string

    Returns void

overlayHeaderLabelBottomMargin

  • get overlayHeaderLabelBottomMargin(): number
  • set overlayHeaderLabelBottomMargin(v: number): void
  • Gets or sets the bottom margin to use for the overlay header.

    Returns number

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

    Parameters

    • v: number

    Returns void

overlayHeaderLabelLeftMargin

  • get overlayHeaderLabelLeftMargin(): number
  • set overlayHeaderLabelLeftMargin(v: number): void
  • Gets or sets the left margin to use for the overlay header.

    Returns number

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

    Parameters

    • v: number

    Returns void

overlayHeaderLabelRightMargin

  • get overlayHeaderLabelRightMargin(): number
  • set overlayHeaderLabelRightMargin(v: number): void
  • Gets or sets the right margin to use for the overlay header.

    Returns number

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

    Parameters

    • v: number

    Returns void

overlayHeaderLabelTopMargin

  • get overlayHeaderLabelTopMargin(): number
  • set overlayHeaderLabelTopMargin(v: number): void
  • Gets or sets the top margin to use for the overlay header.

    Returns number

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

    Parameters

    • v: number

    Returns void

parentIdMemberPath

  • get parentIdMemberPath(): string
  • set parentIdMemberPath(v: string): void
  • Gets or sets the path to use to get the Parent of the items.

    Returns string

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

    Parameters

    • v: string

    Returns void

parentNodeBottomMargin

  • get parentNodeBottomMargin(): number
  • set parentNodeBottomMargin(v: number): void
  • Gets or sets the bottom margin to use for the parent nodes.

    Returns number

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

    Parameters

    • v: number

    Returns void

parentNodeBottomPadding

  • get parentNodeBottomPadding(): number
  • set parentNodeBottomPadding(v: number): void
  • Gets or sets the bottom padding to use for the parent nodes.

    Returns number

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

    Parameters

    • v: number

    Returns void

parentNodeLeftMargin

  • get parentNodeLeftMargin(): number
  • set parentNodeLeftMargin(v: number): void
  • Gets or sets the left margin to use for the parent nodes.

    Returns number

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

    Parameters

    • v: number

    Returns void

parentNodeLeftPadding

  • get parentNodeLeftPadding(): number
  • set parentNodeLeftPadding(v: number): void
  • Gets or sets the left padding to use for the parent nodes.

    Returns number

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

    Parameters

    • v: number

    Returns void

parentNodeRightMargin

  • get parentNodeRightMargin(): number
  • set parentNodeRightMargin(v: number): void
  • Gets or sets the right margin to use for the parent nodes.

    Returns number

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

    Parameters

    • v: number

    Returns void

parentNodeRightPadding

  • get parentNodeRightPadding(): number
  • set parentNodeRightPadding(v: number): void
  • Gets or sets the right padding to use for the parent nodes.

    Returns number

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

    Parameters

    • v: number

    Returns void

parentNodeTopMargin

  • get parentNodeTopMargin(): number
  • set parentNodeTopMargin(v: number): void
  • Gets or sets the top margin to use for the parent nodes.

    Returns number

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

    Parameters

    • v: number

    Returns void

parentNodeTopPadding

  • get parentNodeTopPadding(): number
  • set parentNodeTopPadding(v: number): void
  • Gets or sets the top padding to use for the parent nodes.

    Returns number

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

    Parameters

    • v: number

    Returns void

pixelScalingRatio

  • get pixelScalingRatio(): number
  • set pixelScalingRatio(v: number): void
  • 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.

    Returns number

  • 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.

    Parameters

    • v: number

    Returns void

rootTitle

  • get rootTitle(): string
  • set rootTitle(v: string): void
  • Gets or sets the root title to use for breadcrumbs.

    Returns string

  • Gets or sets the root title to use for breadcrumbs.

    Parameters

    • v: string

    Returns void

strokeThickness

  • get strokeThickness(): number
  • set strokeThickness(v: number): void
  • Gets or sets the stroke thickness to use for the node outline.

    Returns number

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

    Parameters

    • v: number

    Returns void

styleMappings

textColor

  • get textColor(): string
  • set textColor(v: string): void
  • Gets or sets the text color to use for the nodes.

    Returns string

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

    Parameters

    • v: string

    Returns void

textStyle

  • get textStyle(): string
  • set textStyle(v: string): void
  • Gets or sets the font to use for content nodes

    Returns string

  • Gets or sets the font to use for content nodes

    Parameters

    • v: string

    Returns void

transitionDuration

  • get transitionDuration(): number
  • set transitionDuration(v: number): void
  • Gets or sets the number of milliseconds over which changes to the gauge should be animated.

    Returns number

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

    Parameters

    • v: number

    Returns void

valueMemberPath

  • get valueMemberPath(): string
  • set valueMemberPath(v: string): void
  • Gets or sets path to use to get the values from the items.

    Returns string

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

    Parameters

    • v: string

    Returns void

width

  • get width(): string
  • set width(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IIgrTreemapProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IIgrTreemapProps>, nextState: Readonly<S>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void
  • Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<IIgrTreemapProps>, prevState: Readonly<S>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<IIgrTreemapProps>
    • prevState: Readonly<S>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IIgrTreemapProps>, nextContext: any): void

componentWillUnmount

  • componentWillUnmount(): void
  • Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IIgrTreemapProps>, nextState: Readonly<S>, nextContext: any): void

exportSerializedVisualData

  • exportSerializedVisualData(): string
  • Returns visuals as a serialized string.

    Returns string

flush

  • flush(): void
  • Returns void

forceUpdate

  • forceUpdate(callBack?: function): void
  • Parameters

    • Optional callBack: function
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IIgrTreemapProps>, prevState: Readonly<S>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

initializeContent

  • initializeContent(): void
  • Returns void

markDirty

  • markDirty(): void
  • Returns void

notifyClearItems

  • notifyClearItems(source_: any): void
  • 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.

    Parameters

    • source_: any
      • The data source.

    Returns void

notifyInsertItem

  • notifyInsertItem(source_: any, index: number, newItem: any): void
  • Parameters

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

    Returns void

notifyRemoveItem

  • notifyRemoveItem(source_: any, index: number, oldItem: any): void
  • Parameters

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

    Returns void

notifySetItem

  • notifySetItem(source_: any, index: number, oldItem: any, newItem: any): void
  • Parameters

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

    Returns void

onAttachedToUI

  • onAttachedToUI(): void
  • Returns void

onDetachedFromUI

  • onDetachedFromUI(): void
  • Returns void

render

  • render(): DetailedReactHTMLElement<object, any>
  • Returns DetailedReactHTMLElement<object, any>

setState

  • setState<K>(state: function | S | object, callback?: function): void
  • Type parameters

    • K: keyof S

    Parameters

    • state: function | S | object
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

shouldComponentUpdate

  • shouldComponentUpdate(nextProps: any, nextState: any): boolean
  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

updateStyle

  • updateStyle(): void
  • Returns void