tooltip.d.ts 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265
  1. /*!
  2. * devextreme-angular
  3. * Version: 19.1.16
  4. * Build date: Tue Oct 18 2022
  5. *
  6. * Copyright (c) 2012 - 2022 Developer Express Inc. ALL RIGHTS RESERVED
  7. *
  8. * This software may be modified and distributed under the terms
  9. * of the MIT license. See the LICENSE file in the root of the project for details.
  10. *
  11. * https://github.com/DevExpress/devextreme-angular
  12. */
  13. import { TransferState } from '@angular/platform-browser';
  14. import { ElementRef, NgZone, OnDestroy, EventEmitter } from '@angular/core';
  15. import DevExpress from 'devextreme/bundles/dx.all';
  16. import DxTooltip from 'devextreme/ui/tooltip';
  17. import { DxComponent } from '../core/component';
  18. import { DxTemplateHost } from '../core/template-host';
  19. import { NestedOptionHost } from '../core/nested-option';
  20. import { WatcherHelper } from '../core/watcher-helper';
  21. /**
  22. * The Tooltip widget displays a tooltip for a specified element on the page.
  23. */
  24. export declare class DxTooltipComponent extends DxComponent implements OnDestroy {
  25. instance: DxTooltip;
  26. /**
  27. * Configures widget visibility animations. This object contains two fields: show and hide.
  28. */
  29. animation: {
  30. hide?: DevExpress.animationConfig;
  31. show?: DevExpress.animationConfig;
  32. };
  33. /**
  34. * A Boolean value specifying whether or not the widget is closed if a user clicks outside of the popover window and outside the target element.
  35. */
  36. closeOnOutsideClick: boolean | Function;
  37. /**
  38. * Specifies the container in which to place the widget.
  39. */
  40. container: Element | JQuery;
  41. /**
  42. * Specifies a custom template for the widget content.
  43. */
  44. contentTemplate: any;
  45. /**
  46. * Specifies whether to render the widget's content when it is displayed. If false, the content is rendered immediately.
  47. */
  48. deferRendering: boolean;
  49. /**
  50. * Specifies whether the widget responds to user interaction.
  51. */
  52. disabled: boolean;
  53. /**
  54. * Specifies the attributes to be attached to the widget's root element.
  55. */
  56. elementAttr: any;
  57. /**
  58. * Specifies the widget's height.
  59. */
  60. height: number | Function | string;
  61. /**
  62. * Specifies options of popover hiding.
  63. */
  64. hideEvent: string | {
  65. delay?: number;
  66. name?: string;
  67. };
  68. /**
  69. * Specifies text for a hint that appears when a user pauses on the widget.
  70. */
  71. hint: string;
  72. /**
  73. * Specifies whether the widget changes its state when a user pauses on it.
  74. */
  75. hoverStateEnabled: boolean;
  76. /**
  77. * Specifies the maximum height the widget can reach while resizing.
  78. */
  79. maxHeight: number | Function | string;
  80. /**
  81. * Specifies the maximum width the widget can reach while resizing.
  82. */
  83. maxWidth: number | Function | string;
  84. /**
  85. * Specifies the minimum height the widget can reach while resizing.
  86. */
  87. minHeight: number | Function | string;
  88. /**
  89. * Specifies the minimum width the widget can reach while resizing.
  90. */
  91. minWidth: number | Function | string;
  92. /**
  93. * An object defining widget positioning options.
  94. */
  95. position: DevExpress.positionConfig | string;
  96. /**
  97. * Switches the widget to a right-to-left representation.
  98. */
  99. rtlEnabled: boolean;
  100. /**
  101. * Specifies whether to shade the background when the widget is active.
  102. */
  103. shading: boolean;
  104. /**
  105. * Specifies the shading color.
  106. */
  107. shadingColor: string;
  108. /**
  109. * Specifies options for displaying the widget.
  110. */
  111. showEvent: string | {
  112. delay?: number;
  113. name?: string;
  114. };
  115. /**
  116. * The target element associated with the widget.
  117. */
  118. target: Element | JQuery;
  119. /**
  120. * A Boolean value specifying whether or not the widget is visible.
  121. */
  122. visible: boolean;
  123. /**
  124. * Specifies the widget's width.
  125. */
  126. width: number | Function | string;
  127. /**
  128. * A function that is executed when the widget's content is ready and each time the content is changed.
  129. */
  130. onContentReady: EventEmitter<any>;
  131. /**
  132. * A function that is executed before the widget is disposed of.
  133. */
  134. onDisposing: EventEmitter<any>;
  135. /**
  136. * A function that is executed after the widget is hidden.
  137. */
  138. onHidden: EventEmitter<any>;
  139. /**
  140. * A function that is executed before the widget is hidden.
  141. */
  142. onHiding: EventEmitter<any>;
  143. /**
  144. * A function used in JavaScript frameworks to save the widget instance.
  145. */
  146. onInitialized: EventEmitter<any>;
  147. /**
  148. * A function that is executed after a widget option is changed.
  149. */
  150. onOptionChanged: EventEmitter<any>;
  151. /**
  152. * A function that is executed before the widget is displayed.
  153. */
  154. onShowing: EventEmitter<any>;
  155. /**
  156. * A function that is executed after the widget is displayed.
  157. */
  158. onShown: EventEmitter<any>;
  159. /**
  160. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  161. */
  162. animationChange: EventEmitter<{
  163. hide?: DevExpress.animationConfig;
  164. show?: DevExpress.animationConfig;
  165. }>;
  166. /**
  167. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  168. */
  169. closeOnOutsideClickChange: EventEmitter<boolean | Function>;
  170. /**
  171. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  172. */
  173. containerChange: EventEmitter<Element | JQuery>;
  174. /**
  175. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  176. */
  177. contentTemplateChange: EventEmitter<any>;
  178. /**
  179. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  180. */
  181. deferRenderingChange: EventEmitter<boolean>;
  182. /**
  183. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  184. */
  185. disabledChange: EventEmitter<boolean>;
  186. /**
  187. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  188. */
  189. elementAttrChange: EventEmitter<any>;
  190. /**
  191. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  192. */
  193. heightChange: EventEmitter<number | Function | string>;
  194. /**
  195. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  196. */
  197. hideEventChange: EventEmitter<string | {
  198. delay?: number;
  199. name?: string;
  200. }>;
  201. /**
  202. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  203. */
  204. hintChange: EventEmitter<string>;
  205. /**
  206. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  207. */
  208. hoverStateEnabledChange: EventEmitter<boolean>;
  209. /**
  210. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  211. */
  212. maxHeightChange: EventEmitter<number | Function | string>;
  213. /**
  214. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  215. */
  216. maxWidthChange: EventEmitter<number | Function | string>;
  217. /**
  218. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  219. */
  220. minHeightChange: EventEmitter<number | Function | string>;
  221. /**
  222. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  223. */
  224. minWidthChange: EventEmitter<number | Function | string>;
  225. /**
  226. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  227. */
  228. positionChange: EventEmitter<DevExpress.positionConfig | string>;
  229. /**
  230. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  231. */
  232. rtlEnabledChange: EventEmitter<boolean>;
  233. /**
  234. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  235. */
  236. shadingChange: EventEmitter<boolean>;
  237. /**
  238. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  239. */
  240. shadingColorChange: EventEmitter<string>;
  241. /**
  242. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  243. */
  244. showEventChange: EventEmitter<string | {
  245. delay?: number;
  246. name?: string;
  247. }>;
  248. /**
  249. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  250. */
  251. targetChange: EventEmitter<Element | JQuery>;
  252. /**
  253. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  254. */
  255. visibleChange: EventEmitter<boolean>;
  256. /**
  257. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  258. */
  259. widthChange: EventEmitter<number | Function | string>;
  260. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  261. protected _createInstance(element: any, options: any): DxTooltip;
  262. ngOnDestroy(): void;
  263. }
  264. export declare class DxTooltipModule {
  265. }