nz-tree-base.d.ts 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. /**
  2. * Use of this source code is governed by an MIT-style license that can be
  3. * found in the LICENSE file at https://github.com/NG-ZORRO/ng-zorro-antd/blob/master/LICENSE
  4. */
  5. import { NzSafeAny } from 'ng-zorro-antd/core/types';
  6. import { NzTreeNode } from './nz-tree-base-node';
  7. import { NzTreeBaseService } from './nz-tree-base.service';
  8. export declare class NzTreeBase {
  9. nzTreeService: NzTreeBaseService;
  10. constructor(nzTreeService: NzTreeBaseService);
  11. /**
  12. * Coerces a value({@link any[]}) to a TreeNodes({@link NzTreeNode[]})
  13. */
  14. coerceTreeNodes(value: NzSafeAny[]): NzTreeNode[];
  15. /**
  16. * Get all nodes({@link NzTreeNode})
  17. */
  18. getTreeNodes(): NzTreeNode[];
  19. /**
  20. * Get {@link NzTreeNode} with key
  21. */
  22. getTreeNodeByKey(key: string): NzTreeNode | null;
  23. /**
  24. * Get checked nodes(merged)
  25. */
  26. getCheckedNodeList(): NzTreeNode[];
  27. /**
  28. * Get selected nodes
  29. */
  30. getSelectedNodeList(): NzTreeNode[];
  31. /**
  32. * Get half checked nodes
  33. */
  34. getHalfCheckedNodeList(): NzTreeNode[];
  35. /**
  36. * Get expanded nodes
  37. */
  38. getExpandedNodeList(): NzTreeNode[];
  39. /**
  40. * Get matched nodes(if nzSearchValue is not null)
  41. */
  42. getMatchedNodeList(): NzTreeNode[];
  43. }