nz-tree-base-node.d.ts 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  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 { NzTreeNodeBaseComponent } from './nz-tree-base.definitions';
  7. import { NzTreeBaseService } from './nz-tree-base.service';
  8. export type NzTreeNodeKey = string | number;
  9. export interface FlattenNode {
  10. parent: FlattenNode | null;
  11. children: FlattenNode[];
  12. pos: string;
  13. data: NzTreeNode;
  14. isStart: boolean[];
  15. isEnd: boolean[];
  16. }
  17. export interface NzTreeNodeOptions {
  18. title: string;
  19. key: string;
  20. icon?: string;
  21. isLeaf?: boolean;
  22. checked?: boolean;
  23. selected?: boolean;
  24. selectable?: boolean;
  25. disabled?: boolean;
  26. disableCheckbox?: boolean;
  27. expanded?: boolean;
  28. children?: NzTreeNodeOptions[];
  29. [key: string]: NzSafeAny;
  30. }
  31. export declare class NzTreeNode {
  32. private _title;
  33. key: string;
  34. level: number;
  35. origin: NzTreeNodeOptions;
  36. parentNode: NzTreeNode | null;
  37. private _icon;
  38. private _children;
  39. private _isLeaf;
  40. private _isChecked;
  41. private _isSelectable;
  42. private _isDisabled;
  43. private _isDisableCheckbox;
  44. private _isExpanded;
  45. private _isHalfChecked;
  46. private _isSelected;
  47. private _isLoading;
  48. canHide: boolean;
  49. isMatched: boolean;
  50. service: NzTreeBaseService | null;
  51. component: NzTreeNodeBaseComponent;
  52. /** New added in Tree for easy data access */
  53. isStart?: boolean[];
  54. isEnd?: boolean[];
  55. get treeService(): NzTreeBaseService | null;
  56. /**
  57. * Init nzTreeNode
  58. *
  59. * @param option option user's input
  60. * @param parent parent node
  61. * @param service base nzTreeService
  62. */
  63. constructor(option: NzTreeNodeOptions | NzTreeNode, parent?: NzTreeNode | null, service?: NzTreeBaseService | null);
  64. /**
  65. * auto generate
  66. * get
  67. * set
  68. */
  69. get title(): string;
  70. set title(value: string);
  71. get icon(): string;
  72. set icon(value: string);
  73. get children(): NzTreeNode[];
  74. set children(value: NzTreeNode[]);
  75. get isLeaf(): boolean;
  76. set isLeaf(value: boolean);
  77. get isChecked(): boolean;
  78. set isChecked(value: boolean);
  79. get isHalfChecked(): boolean;
  80. set isHalfChecked(value: boolean);
  81. get isSelectable(): boolean;
  82. set isSelectable(value: boolean);
  83. get isDisabled(): boolean;
  84. set isDisabled(value: boolean);
  85. get isDisableCheckbox(): boolean;
  86. set isDisableCheckbox(value: boolean);
  87. get isExpanded(): boolean;
  88. set isExpanded(value: boolean);
  89. get isSelected(): boolean;
  90. set isSelected(value: boolean);
  91. get isLoading(): boolean;
  92. set isLoading(value: boolean);
  93. setSyncChecked(checked?: boolean, halfChecked?: boolean): void;
  94. setChecked(checked?: boolean, halfChecked?: boolean): void;
  95. setExpanded(value: boolean): void;
  96. getParentNode(): NzTreeNode | null;
  97. getChildren(): NzTreeNode[];
  98. /**
  99. * Support appending child nodes by position. Leaf node cannot be appended.
  100. */
  101. addChildren(children: NzSafeAny[], childPos?: number): void;
  102. clearChildren(): void;
  103. remove(): void;
  104. afterValueChange(key: string): void;
  105. update(): void;
  106. }