Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxTreemapComponent

Hierarchy

Hierarchy

  • IgxTreemapComponent

Implements

  • AfterContentInit

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • renderer: Renderer2
    • _elRef: ViewContainerRef
    • ngZone: NgZone
    • injector: Injector
    • componentFactoryResolver: ComponentFactoryResolver

    Returns IgxTreemapComponent

Properties

_dynamicContent

_dynamicContent: ViewContainerRef

actualStyleMappings

actualStyleMappings: IgxTreemapNodeStyleMappingComponent[]

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

container

container: Element

contentStyleMappings

contentStyleMappings: QueryList<IgxTreemapNodeStyleMappingComponent>

Static ngAcceptInputType_actualInteractionPixelScalingRatio

ngAcceptInputType_actualInteractionPixelScalingRatio: string | number

Static ngAcceptInputType_actualPixelScalingRatio

ngAcceptInputType_actualPixelScalingRatio: string | number

Static ngAcceptInputType_animating

ngAcceptInputType_animating: string | boolean

Static ngAcceptInputType_fillBrushes

ngAcceptInputType_fillBrushes: string | string[]

Static ngAcceptInputType_fillScaleLogarithmBase

ngAcceptInputType_fillScaleLogarithmBase: string | number

Static ngAcceptInputType_fillScaleMaximumValue

ngAcceptInputType_fillScaleMaximumValue: string | number

Static ngAcceptInputType_fillScaleMinimumValue

ngAcceptInputType_fillScaleMinimumValue: string | number

Static ngAcceptInputType_fillScaleMode

ngAcceptInputType_fillScaleMode: string | TreemapFillScaleMode

Static ngAcceptInputType_headerDisplayMode

ngAcceptInputType_headerDisplayMode: string | TreemapHeaderDisplayMode

Static ngAcceptInputType_headerHeight

ngAcceptInputType_headerHeight: string | number

Static ngAcceptInputType_headerLabelBottomMargin

ngAcceptInputType_headerLabelBottomMargin: string | number

Static ngAcceptInputType_headerLabelLeftMargin

ngAcceptInputType_headerLabelLeftMargin: string | number

Static ngAcceptInputType_headerLabelRightMargin

ngAcceptInputType_headerLabelRightMargin: string | number

Static ngAcceptInputType_headerLabelTopMargin

ngAcceptInputType_headerLabelTopMargin: string | number

Static ngAcceptInputType_interactionPixelScalingRatio

ngAcceptInputType_interactionPixelScalingRatio: string | number

Static ngAcceptInputType_isFillScaleLogarithmic

ngAcceptInputType_isFillScaleLogarithmic: string | boolean

Static ngAcceptInputType_labelBottomMargin

ngAcceptInputType_labelBottomMargin: string | number

Static ngAcceptInputType_labelHorizontalAlignment

ngAcceptInputType_labelHorizontalAlignment: string | HorizontalAlignment

Static ngAcceptInputType_labelHorizontalFitMode

ngAcceptInputType_labelHorizontalFitMode: string | TreemapLabelHorizontalFitMode

Static ngAcceptInputType_labelLeftMargin

ngAcceptInputType_labelLeftMargin: string | number

Static ngAcceptInputType_labelRightMargin

ngAcceptInputType_labelRightMargin: string | number

Static ngAcceptInputType_labelTopMargin

ngAcceptInputType_labelTopMargin: string | number

Static ngAcceptInputType_labelVerticalAlignment

ngAcceptInputType_labelVerticalAlignment: string | VerticalAlignment

Static ngAcceptInputType_labelVerticalFitMode

ngAcceptInputType_labelVerticalFitMode: string | TreemapLabelVerticalFitMode

Static ngAcceptInputType_layoutOrientation

ngAcceptInputType_layoutOrientation: string | TreemapOrientation

Static ngAcceptInputType_layoutType

ngAcceptInputType_layoutType: string | TreemapLayoutType

Static ngAcceptInputType_minimumDisplaySize

ngAcceptInputType_minimumDisplaySize: string | number

Static ngAcceptInputType_overlayHeaderLabelBottomMargin

ngAcceptInputType_overlayHeaderLabelBottomMargin: string | number

Static ngAcceptInputType_overlayHeaderLabelLeftMargin

ngAcceptInputType_overlayHeaderLabelLeftMargin: string | number

Static ngAcceptInputType_overlayHeaderLabelRightMargin

ngAcceptInputType_overlayHeaderLabelRightMargin: string | number

Static ngAcceptInputType_overlayHeaderLabelTopMargin

ngAcceptInputType_overlayHeaderLabelTopMargin: string | number

Static ngAcceptInputType_parentNodeBottomMargin

ngAcceptInputType_parentNodeBottomMargin: string | number

Static ngAcceptInputType_parentNodeBottomPadding

ngAcceptInputType_parentNodeBottomPadding: string | number

Static ngAcceptInputType_parentNodeLeftMargin

ngAcceptInputType_parentNodeLeftMargin: string | number

Static ngAcceptInputType_parentNodeLeftPadding

ngAcceptInputType_parentNodeLeftPadding: string | number

Static ngAcceptInputType_parentNodeRightMargin

ngAcceptInputType_parentNodeRightMargin: string | number

Static ngAcceptInputType_parentNodeRightPadding

ngAcceptInputType_parentNodeRightPadding: string | number

Static ngAcceptInputType_parentNodeTopMargin

ngAcceptInputType_parentNodeTopMargin: string | number

Static ngAcceptInputType_parentNodeTopPadding

ngAcceptInputType_parentNodeTopPadding: string | number

Static ngAcceptInputType_pixelScalingRatio

ngAcceptInputType_pixelScalingRatio: string | number

Static ngAcceptInputType_strokeThickness

ngAcceptInputType_strokeThickness: string | number

Static ngAcceptInputType_transitionDuration

ngAcceptInputType_transitionDuration: string | number

Static ɵcmp

ɵcmp: unknown

Static ɵfac

ɵfac: unknown

Accessors

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: number): void

  • Parameters

    • v: number

    Returns void

actualPixelScalingRatio

  • get actualPixelScalingRatio(): number

  • Returns number

  • set actualPixelScalingRatio(v: number): 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: string): 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: string): 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: any[]): 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: string[]): 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: number): 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: number): 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: number): void

  • Parameters

    • v: number

    Returns void

fillScaleMode

focusItem

  • get focusItem(): any

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

    Returns any

  • set focusItem(v: any): 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: string): 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: string): 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: number): 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: string): 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: string): 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: string): 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: number): 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: number): 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: number): 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: number): 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: string): 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: string): void

  • Parameters

    • v: string

    Returns void

height

  • get height(): string

  • Returns string

  • set height(value: string): void

  • Parameters

    • value: string

    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: string): 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: number): void

  • Parameters

    • v: number

    Returns void

isFillScaleLogarithmic

  • get isFillScaleLogarithmic(): boolean

  • Gets or sets whether the fill scale is logarithmic.

    Returns boolean

  • set isFillScaleLogarithmic(v: boolean): 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: number): 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: HorizontalAlignment): void

  • Parameters

    Returns void

labelHorizontalFitMode

labelLeftMargin

  • get labelLeftMargin(): number

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

    Returns number

  • set labelLeftMargin(v: number): 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: string): 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: number): 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: number): 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: VerticalAlignment): void

  • Parameters

    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: TreemapOrientation): 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: TreemapLayoutType): 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: number): void

  • Parameters

    • v: number

    Returns void

nodePointerEnter

  • get nodePointerEnter(): EventEmitter<{
        args: IgxTreemapNodePointerEventArgs;
        sender: any;
    }>

  • Fired when the pointer enters a node.

    Returns EventEmitter<{
        args: IgxTreemapNodePointerEventArgs;
        sender: any;
    }>

nodePointerLeave

  • get nodePointerLeave(): EventEmitter<{
        args: IgxTreemapNodePointerEventArgs;
        sender: any;
    }>

  • Fired when the pointer leaved a node.

    Returns EventEmitter<{
        args: IgxTreemapNodePointerEventArgs;
        sender: any;
    }>

nodePointerOver

  • get nodePointerOver(): EventEmitter<{
        args: IgxTreemapNodePointerEventArgs;
        sender: any;
    }>

  • Fired with the pointer is moving over a node.

    Returns EventEmitter<{
        args: IgxTreemapNodePointerEventArgs;
        sender: any;
    }>

nodePointerPressed

  • get nodePointerPressed(): EventEmitter<{
        args: IgxTreemapNodePointerEventArgs;
        sender: any;
    }>

  • Fired when the pointer is pressed on a node.

    Returns EventEmitter<{
        args: IgxTreemapNodePointerEventArgs;
        sender: any;
    }>

nodePointerReleased

  • get nodePointerReleased(): EventEmitter<{
        args: IgxTreemapNodePointerEventArgs;
        sender: any;
    }>

  • Fired when the pointer is released on a node.

    Returns EventEmitter<{
        args: IgxTreemapNodePointerEventArgs;
        sender: any;
    }>

nodeStyling

  • get nodeStyling(): EventEmitter<{
        args: IgxTreemapNodeStylingEventArgs;
        sender: any;
    }>

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

    Returns EventEmitter<{
        args: IgxTreemapNodeStylingEventArgs;
        sender: any;
    }>

outline

  • get outline(): string

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

    Returns string

  • set outline(v: string): 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: string): 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: string): 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: number): 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: number): 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: number): 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: number): 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: string): 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: number): 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: number): 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: number): 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: number): 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: number): 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: number): 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: number): 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: number): 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: number): 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: string): 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: number): 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: string): 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: string): 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: number): 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: string): void

  • Parameters

    • v: string

    Returns void

width

  • get width(): string

  • Returns string

  • set width(value: string): void

  • Parameters

    • value: string

    Returns void

Methods

exportSerializedVisualData

  • Returns visuals as a serialized string.

    Returns string

findByName

  • Parameters

    • name: string

    Returns any

flush

  • Returns void

markDirty

  • Returns void

ngAfterContentInit

  • Returns void

ngOnDestroy

  • 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

simulateHover

  • Parameters

    Returns void

updateStyle

  • Returns void