クラス IgxTreeComponent

階層

実装

  • IgxTree
  • OnInit
  • AfterViewInit
  • OnDestroy

Index

コンストラクタ

constructor

  • new IgxTreeComponent(navService: IgxTreeNavigationService, selectionService: IgxTreeSelectionService, treeService: IgxTreeService, element: ElementRef<HTMLElement>, _displayDensityOptions?: IDisplayDensityOptions): IgxTreeComponent

プロパティ

activeNodeChanged

activeNodeChanged: EventEmitter<IgxTreeNode<any>> = ...

アクティブなノードが変更されたときに発生します。

@例:
<igx-tree (activeNodeChanged)="activeNodeChanged($event)"></igx-tree>

animationSettings

animationSettings: ToggleAnimationSettings = ...

ブランチが展開/折りたたみ時に使用するアニメーション設定を取得/設定します。

<igx-tree [animationSettings]="customAnimationSettings">
</igx-tree>
const animationSettings: ToggleAnimationSettings = {
     openAnimation: growVerIn,
     closeAnimation: growVerOut
};
this.tree.animationSettings = animationSettings;

cssClass

cssClass: string = 'igx-tree'

expandIndicator

expandIndicator: TemplateRef<any>

ノードの展開インジケーターに使用されるカスタム テンプレート

<igx-tree>
 <ng-template igxTreeExpandIndicator let-expanded>
     <igx-icon>{{ expanded ? "close_fullscreen": "open_in_full"}}</igx-icon>
 </ng-template>
</igx-tree>

nodeCollapsed

nodeCollapsed: EventEmitter<ITreeNodeToggledEventArgs> = ...

ノードが完了した後にノードが縮小されたときに発生されます。

@例:
<igx-tree (nodeCollapsed)="handleNodeCollapsed($event)">
</igx-tree>
public handleNodeCollapsed(event: ITreeNodeToggledEventArgs) {
 const collapsedNode: IgxTreeNode<any> = event.node;
 console.log("Node is collapsed: ", collapsedNode.data);
}

nodeCollapsing

nodeCollapsing: EventEmitter<ITreeNodeTogglingEventArgs> = ...

ノードが縮小するときに終了する前に発生します。

<igx-tree (nodeCollapsing)="handleNodeCollapsing($event)">
</igx-tree>
public handleNodeCollapsing(event: ITreeNodeTogglingEventArgs) {
 const collapsedNode: IgxTreeNode<any> = event.node;
 if (collapsedNode.alwaysOpen) {
     event.cancel = true;
 }
}

nodeExpanded

nodeExpanded: EventEmitter<ITreeNodeToggledEventArgs> = ...

ノードが完了した後にノードが展開されたときに発生されます。

<igx-tree (nodeExpanded)="handleNodeExpanded($event)">
</igx-tree>
public handleNodeExpanded(event: ITreeNodeToggledEventArgs) {
 const expandedNode: IgxTreeNode<any> = event.node;
 console.log("Node is expanded: ", expandedNode.data);
}

nodeExpanding

nodeExpanding: EventEmitter<ITreeNodeTogglingEventArgs> = ...

ノードが展開するときに終了する前に発生します。

<igx-tree (nodeExpanding)="handleNodeExpanding($event)">
</igx-tree>
public handleNodeExpanding(event: ITreeNodeTogglingEventArgs) {
 const expandedNode: IgxTreeNode<any> = event.node;
 if (expandedNode.disabled) {
     event.cancel = true;
 }
}

nodeSelection

nodeSelection: EventEmitter<ITreeNodeSelectionEvent> = ...

ノードの選択が操作によって変更されたときに発生されます。

<igx-tree (nodeSelection)="handleNodeSelection($event)">
</igx-tree>
public handleNodeSelection(event: ITreeNodeSelectionEvent) {
 const newSelection: IgxTreeNode<any>[] = event.newSelection;
 const added: IgxTreeNode<any>[] = event.added;
 console.log("New selection will be: ", newSelection);
 console.log("Added nodes: ", event.added);
}

onDensityChanged

onDensityChanged: EventEmitter<IDensityChangedEventArgs> = ...

singleBranchExpand

singleBranchExpand: boolean = false

ツリーがブランチ展開を処理する方法を取得または設定します。 true に設定すると、一度に展開できるブランチは 1 つのみで、その他のブランチはすべて縮小されます。

<igx-tree [singleBranchExpand]="true">
...
</igx-tree>
const tree: IgxTree = this.tree;
this.tree.singleBranchExpand = false;

アクセサー

displayDensity

rootNodes

selection

メソッド

collapseAll

  • 渡されたすべてのノードを縮小します。 渡されたノードがない場合、すべてのノードを縮小します。

    パラメーター

    • オプション nodes: IgxTreeNode<any>[]

      縮小されるノード

      const targetNodes: IgxTreeNode<any> = this.tree.findNodes(true, (_data: any, node: IgxTreeNode<any>) => node.data.collapsible);
      tree.collapseAll(nodes);
      

    返却 void

deselectAll

  • ノード コレクションが空の場合、すべてのノードの選択を解除します。それ以外の場合は、ノード コレクションのノードを選択解除します。

    @例:
     const arr = [
         this.tree.nodes.toArray()[0],
         this.tree.nodes.toArray()[1]
     ];
     this.tree.deselectAll(arr);
    

    パラメーター

    返却 void

expandAll

  • 渡されたすべてのノードを展開します。 渡されたノードがない場合、すべてのノードを展開します。

    パラメーター

    • オプション nodes: IgxTreeNode<any>[]

      展開するノード

      const targetNodes: IgxTreeNode<any> = this.tree.findNodes(true, (_data: any, node: IgxTreeNode<any>) => node.data.expandable);
      tree.expandAll(nodes);
      

    返却 void

findNodes

  • 渡された searchTerm に一致するすべてのノードを返します。 ノードに対して検索語を評価するためのカスタム比較関数を受け入れます。

    @備考:

    デフォルトの検索では、渡された searchTerm をノードの data 入力と比較します。 比較演算子なしで findNodes を使用する場合、すべてのノードに data が渡されることを確認してください。

    パラメーター

    • searchTerm: any

      検索されたノードのデータ

    • オプション comparer: IgxTreeSearchResolver

      渡された searchTerm をすべてのノードに対して評価するカスタム比較関数。

    返却 IgxTreeNodeComponent<any>[]

    検索に一致するノードの配列。ノードが見つからない場合は null

    <igx-tree>
        <igx-tree-node *ngFor="let node of data" [data]="node">
             {{ node.label }}
        </igx-tree-node>
    </igx-tree>
    
    public data: DataEntry[] = FETCHED_DATA;
    ...
    const matchedNodes: IgxTreeNode<DataEntry>[] = this.tree.findNodes<DataEntry>(searchTerm: data[5]);
    

    Using a custom comparer

    public data: DataEntry[] = FETCHED_DATA;
    ...
    const comparer: IgxTreeSearchResolver = (data: any, node: IgxTreeNode<DataEntry>) {
         return node.data.index % 2 === 0;
    }
    const evenIndexNodes: IgxTreeNode<DataEntry>[] = this.tree.findNodes<DataEntry>(null, comparer);
    

ngDoCheck

  • ngDoCheck(): void