utils.d.ts 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. export declare const _: {
  2. utf8_encode(s: string): string;
  3. camelCaseToHyphen(str: string): string;
  4. hyphenToCamelCase(str: string): string;
  5. capitalise(str: string): string;
  6. escape(toEscape: string): string;
  7. camelCaseToHumanText(camelCase: string): string;
  8. convertToSet<T>(list: T[]): Set<T>;
  9. sortRowNodesByOrder(rowNodes: import("../main").RowNode[], rowNodeOrder: {
  10. [id: string]: number;
  11. }): void;
  12. traverseNodesWithKey(nodes: import("../main").RowNode[], callback: (node: import("../main").RowNode, key: string) => void): void;
  13. iterateObject<T_1>(object: {
  14. [p: string]: T_1;
  15. } | T_1[], callback: (key: string, value: T_1) => void): void;
  16. cloneObject<T_2>(object: T_2): T_2;
  17. deepCloneObject<T_3>(object: T_3): T_3;
  18. getProperty<T_4, K extends keyof T_4>(object: T_4, key: K): any;
  19. setProperty<T_5, K_1 extends keyof T_5>(object: T_5, key: K_1, value: any): void;
  20. copyPropertiesIfPresent<S, T_6 extends S, K_2 extends keyof S>(source: S, target: T_6, ...properties: K_2[]): void;
  21. copyPropertyIfPresent<S_1, T_7 extends S_1, K_3 extends keyof S_1>(source: S_1, target: T_7, property: K_3, transform?: (value: S_1[K_3]) => any): void;
  22. getAllKeysInObjects(objects: any[]): string[];
  23. mergeDeep(dest: any, source: any, copyUndefined?: boolean): void;
  24. assign<T_8, U>(target: T_8, source: U): T_8 & U;
  25. assign<T_9, U_1, V>(target: T_9, source1: U_1, source2: V): T_9 & U_1 & V;
  26. assign<T_10, U_2, V_1, W>(target: T_10, source1: U_2, source2: V_1, source3: W): T_10 & U_2 & V_1 & W;
  27. missingOrEmptyObject(value: any): boolean;
  28. get(source: any, expression: string, defaultValue: any): any;
  29. set(target: any, expression: string, value: any): void;
  30. deepFreeze(object: any): any;
  31. getValueUsingField(data: any, field: string, fieldContainsDots: boolean): any;
  32. padStart(value: number, totalStringSize: number): string;
  33. createArrayOfNumbers(first: number, last: number): number[];
  34. isNumeric(value: any): boolean;
  35. getMaxSafeInteger(): number;
  36. cleanNumber(value: any): number;
  37. decToHex(number: number, bytes: number): string;
  38. formatNumberTwoDecimalPlacesAndCommas(value: number): string;
  39. formatNumberCommas(value: number): string;
  40. sum(values: number[]): number;
  41. normalizeWheel(event: any): any;
  42. isLeftClick(mouseEvent: MouseEvent): boolean;
  43. areEventsNear(e1: Touch | MouseEvent, e2: Touch | MouseEvent, pixelCount: number): boolean;
  44. keys<T_11>(map: Map<T_11, any>): T_11[];
  45. isKeyPressed(event: KeyboardEvent, keyToCheck: number): boolean;
  46. isCharacterKey(event: KeyboardEvent): boolean;
  47. isEventFromPrintableCharacter(event: KeyboardEvent): boolean;
  48. isUserSuppressingKeyboardEvent(gridOptionsWrapper: import("../gridOptionsWrapper").GridOptionsWrapper, keyboardEvent: KeyboardEvent, rowNode: import("../main").RowNode, column: import("../main").Column, editing: boolean): boolean;
  49. createIcon(iconName: string, gridOptionsWrapper: import("../gridOptionsWrapper").GridOptionsWrapper, column: import("../main").Column): HTMLElement;
  50. createIconNoSpan(iconName: string, gridOptionsWrapper: import("../gridOptionsWrapper").GridOptionsWrapper, column?: import("../main").Column, forceCreate?: boolean): HTMLElement;
  51. iconNameClassMap: {
  52. [key: string]: string;
  53. };
  54. makeNull<T_12>(value?: T_12): T_12;
  55. exists<T_13>(value: T_13, allowEmptyString?: boolean): boolean;
  56. missing<T_14>(value: T_14): boolean;
  57. missingOrEmpty<T_15>(value?: string | T_15[]): boolean;
  58. toStringOrNull(value: any): string;
  59. referenceCompare<T_16>(left: T_16, right: T_16): boolean;
  60. jsonEquals<T1, T2>(val1: T1, val2: T2): boolean;
  61. defaultComparator(valueA: any, valueB: any, accentedCompare?: boolean): number;
  62. find<T_17>(collection: {
  63. [id: string]: T_17;
  64. } | T_17[], predicate: string | boolean | ((item: T_17) => boolean), value?: any): T_17;
  65. values<T_18>(object: {
  66. [key: string]: T_18;
  67. } | Set<T_18> | Map<any, T_18>): T_18[];
  68. fuzzyCheckStrings(inputValues: string[], validValues: string[], allSuggestions: string[]): {
  69. [p: string]: string[];
  70. };
  71. fuzzySuggestions(inputValue: string, allSuggestions: string[], hideIrrelevant?: boolean, weighted?: true): string[];
  72. get_bigrams(from: string): any[];
  73. string_distances(str1: string, str2: string): number;
  74. string_weighted_distances(str1: string, str2: string): number;
  75. doOnce(func: () => void, key: string): void;
  76. getFunctionParameters(func: any): any;
  77. isFunction(val: any): boolean;
  78. executeInAWhile(funcs: Function[]): void;
  79. executeNextVMTurn(funcs: Function[]): void;
  80. executeAfter(funcs: Function[], milliseconds?: number): void;
  81. debounce(func: (...args: any[]) => void, wait: number, immediate?: boolean): (...args: any[]) => void;
  82. compose(...fns: Function[]): (arg: any) => any;
  83. callIfPresent(func: Function): void;
  84. stopPropagationForAgGrid(event: Event): void;
  85. isStopPropagationForAgGrid(event: Event): boolean;
  86. getCellCompForEvent(gridOptionsWrapper: import("../gridOptionsWrapper").GridOptionsWrapper, event: Event): import("../main").CellComp;
  87. addChangeListener(element: HTMLElement, listener: EventListener): void;
  88. getTarget(event: Event): Element;
  89. isElementInEventPath(element: HTMLElement, event: Event): boolean;
  90. createEventPath(event: Event): EventTarget[];
  91. addAgGridEventPath(event: Event): void;
  92. getEventPath(event: Event): EventTarget[];
  93. addSafePassiveEventListener(frameworkOverrides: import("../main").IFrameworkOverrides, eElement: HTMLElement, event: string, listener: (event?: any) => void): void;
  94. isEventSupported: (eventName: any) => boolean;
  95. addCssClass(element: HTMLElement, className: string): HTMLElement;
  96. removeCssClass(element: HTMLElement, className: string): void;
  97. addOrRemoveCssClass(element: HTMLElement, className: string, addOrRemove: boolean): void;
  98. radioCssClass(element: HTMLElement, elementClass: string, otherElementClass?: string): void;
  99. containsClass(element: HTMLElement, className: string): boolean;
  100. setDisplayed(element: HTMLElement, displayed: boolean): void;
  101. setVisible(element: HTMLElement, visible: boolean): void;
  102. setDisabled(element: HTMLElement, disabled: boolean): void;
  103. isElementChildOfClass(element: HTMLElement, cls: string, maxNest?: number): boolean;
  104. getElementSize(el: HTMLElement): {
  105. height: number;
  106. width: number;
  107. paddingTop: number;
  108. paddingRight: number;
  109. paddingBottom: number;
  110. paddingLeft: number;
  111. marginTop: number;
  112. marginRight: number;
  113. marginBottom: number;
  114. marginLeft: number;
  115. boxSizing: string;
  116. };
  117. getInnerHeight(el: HTMLElement): number;
  118. getInnerWidth(el: HTMLElement): number;
  119. getAbsoluteHeight(el: HTMLElement): number;
  120. getAbsoluteWidth(el: HTMLElement): number;
  121. getScrollLeft(element: HTMLElement, rtl: boolean): number;
  122. setScrollLeft(element: HTMLElement, value: number, rtl: boolean): void;
  123. clearElement(el: HTMLElement): void;
  124. removeElement(parent: HTMLElement, cssSelector: string): void;
  125. removeFromParent(node: Element): void;
  126. isVisible(element: HTMLElement): boolean;
  127. loadTemplate(template: string): HTMLElement;
  128. appendHtml(eContainer: HTMLElement, htmlTemplate: string): void;
  129. getElementAttribute(element: any, attributeName: string): string;
  130. offsetHeight(element: HTMLElement): number;
  131. offsetWidth(element: HTMLElement): number;
  132. ensureDomOrder(eContainer: HTMLElement, eChild: HTMLElement, eChildBefore: HTMLElement): void;
  133. setDomChildOrder(eContainer: HTMLElement, orderedChildren: HTMLElement[]): void;
  134. insertTemplateWithDomOrder(eContainer: HTMLElement, htmlTemplate: string, eChildBefore: HTMLElement): HTMLElement;
  135. prependDC(parent: HTMLElement, documentFragment: DocumentFragment): void;
  136. addStylesToElement(eElement: any, styles: any): void;
  137. isHorizontalScrollShowing(element: HTMLElement): boolean;
  138. isVerticalScrollShowing(element: HTMLElement): boolean;
  139. setElementWidth(element: HTMLElement, width: string | number): void;
  140. setFixedWidth(element: HTMLElement, width: string | number): void;
  141. setElementHeight(element: HTMLElement, height: string | number): void;
  142. setFixedHeight(element: HTMLElement, height: string | number): void;
  143. formatSize(size: string | number): string;
  144. isNode(o: any): boolean;
  145. isElement(o: any): boolean;
  146. isNodeOrElement(o: any): boolean;
  147. copyNodeList(nodeList: NodeList): Node[];
  148. iterateNamedNodeMap(map: NamedNodeMap, callback: (key: string, value: string) => void): void;
  149. setCheckboxState(eCheckbox: HTMLInputElement, state: any): void;
  150. serialiseDate(date: Date, includeTime?: boolean, separator?: string): string;
  151. parseDateTimeFromString(value: string): Date;
  152. stringToArray(strData: string, delimiter?: string): string[][];
  153. isBrowserIE(): boolean;
  154. isBrowserEdge(): boolean;
  155. isBrowserSafari(): boolean;
  156. isBrowserChrome(): boolean;
  157. isBrowserFirefox(): boolean;
  158. isIOSUserAgent(): boolean;
  159. getTabIndex(el: HTMLElement): string;
  160. getMaxDivHeight(): number;
  161. getScrollbarWidth(): number;
  162. hasOverflowScrolling(): boolean;
  163. getBodyWidth(): number;
  164. getBodyHeight(): number;
  165. firstExistingValue<A>(...values: A[]): A;
  166. anyExists(values: any[]): boolean;
  167. existsAndNotEmpty<T_19>(value?: T_19[]): boolean;
  168. last<T_20>(arr: T_20[]): T_20;
  169. areEqual<T_21>(a: T_21[], b: T_21[], comparator?: (a: T_21, b: T_21) => boolean): boolean;
  170. compareArrays(array1?: any[], array2?: any[]): boolean;
  171. shallowCompare(arr1: any[], arr2: any[]): boolean;
  172. sortNumerically(array: number[]): number[];
  173. removeRepeatsFromArray<T_22>(array: T_22[], object: T_22): void;
  174. removeFromArray<T_23>(array: T_23[], object: T_23): void;
  175. removeAllFromArray<T_24>(array: T_24[], toRemove: T_24[]): void;
  176. insertIntoArray<T_25>(array: T_25[], object: T_25, toIndex: number): void;
  177. insertArrayIntoArray<T_26>(dest: T_26[], src: T_26[], toIndex: number): void;
  178. moveInArray<T_27>(array: T_27[], objectsToMove: T_27[], toIndex: number): void;
  179. includes<T_28>(array: T_28[], value: T_28): boolean;
  180. flatten(arrayOfArrays: any[]): any[];
  181. pushAll<T_29>(target: T_29[], source: T_29[]): void;
  182. toStrings<T_30>(array: T_30[]): string[];
  183. findIndex<T_31>(collection: T_31[], predicate: (item: T_31, idx: number, collection: T_31[]) => boolean): number;
  184. every<T_32>(list: T_32[], predicate: (value: T_32, index: number) => boolean): boolean;
  185. some<T_33>(list: T_33[], predicate: (value: T_33, index: number) => boolean): boolean;
  186. forEach<T_34>(list: T_34[], action: (value: T_34, index: number) => void): void;
  187. map<T_35, V_2>(list: T_35[], process: (value: T_35, index: number) => V_2): V_2[];
  188. filter<T_36>(list: T_36[], predicate: (value: T_36, index: number) => boolean): T_36[];
  189. reduce<T_37, V_3>(list: T_37[], step: (acc: V_3, value: T_37, index: number) => V_3, initial: V_3): V_3;
  190. forEachSnapshotFirst<T_38>(list: T_38[], callback: (item: T_38) => void): void;
  191. getNameOfClass(theClass: any): string;
  192. findLineByLeastSquares(values: number[]): any[];
  193. cssStyleObjectToMarkup(stylesToUse: any): string;
  194. message(msg: string): void;
  195. bindCellRendererToHtmlElement(cellRendererPromise: import("./promise").Promise<import("../main").ICellRendererComp>, eTarget: HTMLElement): void;
  196. };