Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

  • Parameters

    Returns IgrTreemap

Properties

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: IgrTreemapNodeStyleMapping[]
context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<IIgrTreemapProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
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}</>;
}
}

Accessors

  • get actualInteractionPixelScalingRatio(): 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.

    Returns number

  • set actualInteractionPixelScalingRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get actualPixelScalingRatio(): number
  • Returns number

  • set actualPixelScalingRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get animating(): boolean
  • Returns boolean

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

    Returns string

  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set customValueMemberPath(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set darkTextColor(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns any[]

  • set dataSource(v): void
  • Parameters

    • v: any[]

    Returns void

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

    Returns string[]

  • set fillBrushes(v): void
  • Parameters

    • v: string[]

    Returns void

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

    Returns number

  • set fillScaleLogarithmBase(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set fillScaleMaximumValue(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set fillScaleMinimumValue(v): void
  • Parameters

    • v: number

    Returns void

  • get fillScaleMode(): TreemapFillScaleMode
  • Gets or sets mode to use for the fill scale.

    Returns TreemapFillScaleMode

  • set fillScaleMode(v): void
  • Parameters

    Returns void

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

    Returns any

  • set focusItem(v): void
  • Parameters

    • v: any

    Returns void

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

    Returns string

  • set headerBackground(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set headerDarkTextColor(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set headerHeight(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set headerHoverBackground(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set headerHoverDarkTextColor(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set headerHoverTextColor(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set headerLabelBottomMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set headerLabelLeftMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set headerLabelRightMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set headerLabelTopMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set headerTextColor(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set headerTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: string

    Returns void

  • get highlightedDataSource(): any[]
  • Gets or sets the data to highlight.

    Returns any[]

  • set highlightedDataSource(v): void
  • Parameters

    • v: any[]

    Returns void

  • get highlightedValueMemberPath(): string
  • Gets or sets the highlighted value mapping property.

    Returns string

  • set highlightedValueMemberPath(v): void
  • Parameters

    • v: string

    Returns void

  • get highlightedValueOpacity(): number
  • Gets or sets the opacity applied to the node underneath the highlighted value.

    Returns number

  • set highlightedValueOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get highlightingFadeOpacity(): number
  • Gets or sets the opacity to use for nodes that are not highlighted when HighlightingMode is set to FadeOthers.

    Returns number

  • set highlightingFadeOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get highlightingTransitionDuration(): number
  • Gets or sets the number of milliseconds over which the highlighting effect will render.

    Returns number

  • set highlightingTransitionDuration(v): void
  • Parameters

    • v: number

    Returns void

  • get i(): Treemap
  • Returns Treemap

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

    Returns string

  • set idMemberPath(v): void
  • Parameters

    • v: string

    Returns void

  • get interactionPixelScalingRatio(): 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.

    Returns number

  • set interactionPixelScalingRatio(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns boolean

  • set isFillScaleLogarithmic(v): void
  • Parameters

    • v: boolean

    Returns void

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

    Returns number

  • set labelBottomMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns HorizontalAlignment

  • set labelHorizontalAlignment(v): void
  • Parameters

    • v: HorizontalAlignment

    Returns void

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

    Returns number

  • set labelLeftMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set labelMemberPath(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set labelRightMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set labelTopMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns VerticalAlignment

  • set labelVerticalAlignment(v): void
  • Parameters

    • v: VerticalAlignment

    Returns void

  • get layoutOrientation(): TreemapOrientation
  • Gets or sets the orientation to use for the stripped and slice and dice layout types.

    Returns TreemapOrientation

  • set layoutOrientation(v): void
  • Parameters

    Returns void

  • get layoutType(): TreemapLayoutType
  • Gets or sets the type of layout to use for the nodes.

    Returns TreemapLayoutType

  • set layoutType(v): void
  • Parameters

    Returns void

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

    Returns number

  • set minimumDisplaySize(v): void
  • Parameters

    • v: number

    Returns void

  • get nodeOpacity(): number
  • Gets or sets the opacity to use for the nodes.

    Returns number

  • set nodeOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get nodePointerEnter(): ((s, e) => void)
  • Fired when the pointer enters a node.

    Returns ((s, e) => void)

  • set nodePointerEnter(ev): void
  • Parameters

    Returns void

  • get nodePointerLeave(): ((s, e) => void)
  • Fired when the pointer leaved a node.

    Returns ((s, e) => void)

  • set nodePointerLeave(ev): void
  • Parameters

    Returns void

  • get nodePointerOver(): ((s, e) => void)
  • Fired with the pointer is moving over a node.

    Returns ((s, e) => void)

  • set nodePointerOver(ev): void
  • Parameters

    Returns void

  • get nodePointerPressed(): ((s, e) => void)
  • Fired when the pointer is pressed on a node.

    Returns ((s, e) => void)

  • set nodePointerPressed(ev): void
  • Parameters

    Returns void

  • get nodePointerReleased(): ((s, e) => void)
  • Fired when the pointer is released on a node.

    Returns ((s, e) => void)

  • set nodePointerReleased(ev): void
  • Parameters

    Returns void

  • get nodeRenderStyling(): ((s, e) => void)
  • Fired before a node is rendered for last minute style changes.

    Returns ((s, e) => void)

  • set nodeRenderStyling(ev): void
  • Parameters

    Returns void

  • get nodeStyling(): ((s, e) => void)
  • Fired when a node is being styled. Provides an opportunity to customize node styling.

    Returns ((s, e) => void)

  • set nodeStyling(ev): void
  • Parameters

    Returns void

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

    Returns string

  • set outline(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set overlayHeaderBackground(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set overlayHeaderHoverBackground(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set overlayHeaderLabelBottomMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set overlayHeaderLabelLeftMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set overlayHeaderLabelRightMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set overlayHeaderLabelTopMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set parentIdMemberPath(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set parentNodeBottomMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set parentNodeBottomPadding(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set parentNodeLeftMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set parentNodeLeftPadding(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set parentNodeRightMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set parentNodeRightPadding(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set parentNodeTopMargin(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set parentNodeTopPadding(v): void
  • Parameters

    • v: number

    Returns void

  • get pixelScalingRatio(): 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.

    Returns number

  • set pixelScalingRatio(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set rootTitle(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set strokeThickness(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set textColor(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set textStyle(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set transitionDuration(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set valueMemberPath(v): void
  • Parameters

    • v: string

    Returns void

  • get width(): string
  • Returns string

  • set width(value): void
  • Parameters

    • value: string

    Returns void

Methods

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns 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<{}>
    • Optional snapshot: any

    Returns void

  • Returns void

  • Returns void

  • Returns visuals as a serialized string.

    Returns string

  • Parameters

    • name: string

    Returns any

  • Returns void

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

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

  • Returns void

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

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns DetailedReactHTMLElement<{
        children: any[];
        className: string;
        ref: ((ref) => void);
    }, any>

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Parameters

    • point: IgPoint

    Returns void

  • Returns void