Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrTreemap

Hierarchy

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

See

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

Readonly props

props: Readonly<IIgrTreemapProps> & Readonly<{
    children?: ReactNode;
}>

refs

refs: {
    [key: string]: ReactInstance;
}

Deprecated

https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<{}>

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

actualHighlightingMode

actualInteractionPixelScalingRatio

  • 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

actualPixelScalingRatio

  • get actualPixelScalingRatio(): number

  • Returns number

  • set actualPixelScalingRatio(v): void

  • Parameters

    • v: number

    Returns void

animating

  • get animating(): boolean

  • Returns boolean

breadcrumbSequence

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

    Returns string

  • Parameters

    • v: string

    Returns void

customValueMemberPath

  • 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

darkTextColor

  • 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

dataSource

  • 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

fillBrushes

  • get fillBrushes(): string[]

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

    Returns string[]

  • set fillBrushes(v): void

  • Parameters

    • v: string[]

    Returns void

fillScaleLogarithmBase

  • 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

fillScaleMaximumValue

  • 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

fillScaleMinimumValue

  • 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

fillScaleMode

  • get fillScaleMode(): TreemapFillScaleMode

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

    Returns TreemapFillScaleMode

  • set fillScaleMode(v): void

  • Parameters

    Returns void

focusItem

  • 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

headerBackground

  • get headerBackground(): string

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

    Returns string

  • set headerBackground(v): void

  • Parameters

    • v: string

    Returns void

headerDarkTextColor

  • 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

headerDisplayMode

headerHeight

  • get headerHeight(): number

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

    Returns number

  • set headerHeight(v): void

  • Parameters

    • v: number

    Returns void

headerHoverBackground

  • 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

headerHoverDarkTextColor

  • 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

headerHoverTextColor

  • 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

headerLabelBottomMargin

  • 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

headerLabelLeftMargin

  • 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

headerLabelRightMargin

  • 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

headerLabelTopMargin

  • 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

headerTextColor

  • 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

headerTextStyle

  • get headerTextStyle(): string

  • Gets or sets the font to use for header nodes

    Returns string

  • set headerTextStyle(v): void

  • Parameters

    • v: string

    Returns void

height

  • get height(): string

  • Returns string

  • set height(value): void

  • Parameters

    • value: string

    Returns void

highlightingMode

highlightingTransitionDuration

  • 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

i

  • get i(): Treemap

  • Returns Treemap

idMemberPath

  • 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

interactionPixelScalingRatio

  • 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

isFillScaleLogarithmic

  • get isFillScaleLogarithmic(): boolean

  • Gets or sets whether the fill scale is logarithmic.

    Returns boolean

  • set isFillScaleLogarithmic(v): void

  • Parameters

    • v: boolean

    Returns void

labelBottomMargin

  • 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

labelHorizontalAlignment

  • 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

labelHorizontalFitMode

labelLeftMargin

  • 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

labelMemberPath

  • 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

labelRightMargin

  • 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

labelTopMargin

  • 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

labelVerticalAlignment

  • 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

labelVerticalFitMode

layoutOrientation

  • 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

layoutType

  • get layoutType(): TreemapLayoutType

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

    Returns TreemapLayoutType

  • set layoutType(v): void

  • Parameters

    Returns void

minimumDisplaySize

  • 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

nodeOpacity

  • get nodeOpacity(): number

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

    Returns number

  • set nodeOpacity(v): void

  • Parameters

    • v: number

    Returns void

nodePointerEnter

  • get nodePointerEnter(): ((s, e) => void)

  • Fired when the pointer enters a node.

    Returns ((s, e) => void)

  • set nodePointerEnter(ev): void

  • Parameters

    Returns void

nodePointerLeave

  • get nodePointerLeave(): ((s, e) => void)

  • Fired when the pointer leaved a node.

    Returns ((s, e) => void)

  • set nodePointerLeave(ev): void

  • Parameters

    Returns void

nodePointerOver

  • 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

nodePointerPressed

  • 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

nodePointerReleased

  • 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

nodeRenderStyling

  • 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

nodeStyling

  • 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

outline

  • get outline(): string

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

    Returns string

  • set outline(v): void

  • Parameters

    • v: string

    Returns void

overlayHeaderBackground

  • 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

overlayHeaderHoverBackground

  • 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

overlayHeaderLabelBottomMargin

  • 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

overlayHeaderLabelLeftMargin

  • 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

overlayHeaderLabelRightMargin

  • 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

overlayHeaderLabelTopMargin

  • 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

parentIdMemberPath

  • 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

parentNodeBottomMargin

  • 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

parentNodeBottomPadding

  • 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

parentNodeLeftMargin

  • 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

parentNodeLeftPadding

  • 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

parentNodeRightMargin

  • 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

parentNodeRightPadding

  • 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

parentNodeTopMargin

  • 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

parentNodeTopPadding

  • 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

pixelScalingRatio

  • 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

rootTitle

  • get rootTitle(): string

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

    Returns string

  • set rootTitle(v): void

  • Parameters

    • v: string

    Returns void

strokeThickness

  • 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

styleMappings

textColor

  • 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

textStyle

  • get textStyle(): string

  • Gets or sets the font to use for content nodes

    Returns string

  • set textStyle(v): void

  • Parameters

    • v: string

    Returns void

transitionDuration

  • 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

valueMemberPath

  • 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

width

  • get width(): string

  • Returns string

  • set width(value): void

  • Parameters

    • value: string

    Returns void

Methods

Optional UNSAFE_componentWillMount

Optional UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillUpdate

Optional componentDidCatch

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

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • Returns void

Optional componentDidUpdate

  • 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

Optional componentWillMount

Optional componentWillReceiveProps

componentWillUnmount

  • Returns void

Optional componentWillUpdate

destroy

  • Returns void

exportSerializedVisualData

  • Returns visuals as a serialized string.

    Returns string

findByName

  • Parameters

    • name: string

    Returns any

flush

  • Returns void

forceUpdate

  • Parameters

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

        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • 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

initializeContent

  • Returns void

markDirty

  • Returns void

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.

    Parameters

    • source_: any
      • The data source.

    Returns void

notifyInsertItem

  • Parameters

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

    Returns void

notifyRemoveItem

  • Parameters

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

    Returns void

notifySetItem

  • Parameters

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

    Returns void

notifySizeChanged

  • Returns void

onAttachedToUI

  • Returns void

onDetachedFromUI

  • Returns void

render

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

setState

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

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

        • Returns void

    Returns void

shouldComponentUpdate

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

simulateHover

  • Parameters

    • point: IgPoint

    Returns void

updateStyle

  • Returns void