nz-tree-base.service.d.ts 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. import { BehaviorSubject } from 'rxjs';
  2. import { NzSafeAny } from 'ng-zorro-antd/core/types';
  3. import { NzTreeNode, NzTreeNodeKey } from './nz-tree-base-node';
  4. import { NzFormatEmitEvent } from './nz-tree-base.definitions';
  5. import * as i0 from "@angular/core";
  6. export declare class NzTreeBaseService {
  7. DRAG_SIDE_RANGE: number;
  8. DRAG_MIN_GAP: number;
  9. isCheckStrictly: boolean;
  10. isMultiple: boolean;
  11. selectedNode: NzTreeNode;
  12. rootNodes: NzTreeNode[];
  13. flattenNodes$: BehaviorSubject<NzTreeNode[]>;
  14. selectedNodeList: NzTreeNode[];
  15. expandedNodeList: NzTreeNode[];
  16. checkedNodeList: NzTreeNode[];
  17. halfCheckedNodeList: NzTreeNode[];
  18. matchedNodeList: NzTreeNode[];
  19. /**
  20. * handle to post process a tree node when it's instantiating, note that its children haven't been initiated yet
  21. */
  22. treeNodePostProcessor?: (node: NzTreeNode) => void;
  23. /**
  24. * reset tree nodes will clear default node list
  25. */
  26. initTree(nzNodes: NzTreeNode[]): void;
  27. flattenTreeData(nzNodes: NzTreeNode[], expandedKeys?: NzTreeNodeKey[] | true): void;
  28. getSelectedNode(): NzTreeNode | null;
  29. /**
  30. * get some list
  31. */
  32. getSelectedNodeList(): NzTreeNode[];
  33. /**
  34. * get checked node keys
  35. */
  36. getCheckedNodeKeys(): NzTreeNodeKey[];
  37. /**
  38. * return checked nodes
  39. */
  40. getCheckedNodeList(): NzTreeNode[];
  41. getHalfCheckedNodeList(): NzTreeNode[];
  42. /**
  43. * return expanded nodes
  44. */
  45. getExpandedNodeList(): NzTreeNode[];
  46. /**
  47. * return search matched nodes
  48. */
  49. getMatchedNodeList(): NzTreeNode[];
  50. isArrayOfNzTreeNode(value: NzSafeAny[]): boolean;
  51. /**
  52. * set drag node
  53. */
  54. setSelectedNode(node: NzTreeNode): void;
  55. /**
  56. * set node selected status
  57. */
  58. setNodeActive(node: NzTreeNode): void;
  59. /**
  60. * add or remove node to selectedNodeList
  61. */
  62. setSelectedNodeList(node: NzTreeNode, isMultiple?: boolean): void;
  63. /**
  64. * merge checked nodes
  65. */
  66. setHalfCheckedNodeList(node: NzTreeNode): void;
  67. setCheckedNodeList(node: NzTreeNode): void;
  68. /**
  69. * conduct checked/selected/expanded keys
  70. */
  71. conductNodeState(type?: string): NzTreeNode[];
  72. /**
  73. * set expanded nodes
  74. */
  75. setExpandedNodeList(node: NzTreeNode): void;
  76. setMatchedNodeList(node: NzTreeNode): void;
  77. /**
  78. * check state
  79. *
  80. * @param isCheckStrictly
  81. */
  82. refreshCheckState(isCheckStrictly?: boolean): void;
  83. conduct(node: NzTreeNode, isCheckStrictly?: boolean): void;
  84. /**
  85. * 1、children half checked
  86. * 2、children all checked, parent checked
  87. * 3、no children checked
  88. */
  89. conductUp(node: NzTreeNode): void;
  90. /**
  91. * reset child check state
  92. */
  93. conductDown(node: NzTreeNode, value: boolean): void;
  94. /**
  95. * flush after delete node
  96. */
  97. afterRemove(nodes: NzTreeNode[]): void;
  98. /**
  99. * drag event
  100. */
  101. refreshDragNode(node: NzTreeNode): void;
  102. resetNodeLevel(node: NzTreeNode): void;
  103. calcDropPosition(event: DragEvent): number;
  104. /**
  105. * drop
  106. * 0: inner -1: pre 1: next
  107. */
  108. dropAndApply(targetNode: NzTreeNode, dragPos?: number): void;
  109. /**
  110. * emit Structure
  111. * eventName
  112. * node
  113. * event: MouseEvent / DragEvent
  114. * dragNode
  115. */
  116. formatEvent(eventName: string, node: NzTreeNode | null, event: MouseEvent | DragEvent | null): NzFormatEmitEvent;
  117. /**
  118. * New functions for flatten nodes
  119. */
  120. getIndexOfArray(list: NzTreeNode[], key: string): number;
  121. /**
  122. * Render by nzCheckedKeys
  123. * When keys equals null, just render with checkStrictly
  124. *
  125. * @param keys
  126. * @param checkStrictly
  127. */
  128. conductCheck(keys: NzTreeNodeKey[] | null, checkStrictly: boolean): void;
  129. conductExpandedKeys(keys?: NzTreeNodeKey[] | true): void;
  130. conductSelectedKeys(keys: NzTreeNodeKey[], isMulti: boolean): void;
  131. /**
  132. * Expand parent nodes by child node
  133. *
  134. * @param node
  135. */
  136. expandNodeAllParentBySearch(node: NzTreeNode): void;
  137. static ɵfac: i0.ɵɵFactoryDeclaration<NzTreeBaseService, never>;
  138. static ɵprov: i0.ɵɵInjectableDeclaration<NzTreeBaseService>;
  139. }