popover.d.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338
  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, OnChanges, DoCheck, SimpleChanges, QueryList } from '@angular/core';
  15. import DevExpress from 'devextreme/bundles/dx.all';
  16. import DxPopover from 'devextreme/ui/popover';
  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. import { IterableDifferHelper } from '../core/iterable-differ-helper';
  22. import { DxiToolbarItemComponent } from './nested/toolbar-item-dxi';
  23. /**
  24. * The Popover is a widget that shows notifications within a box with an arrow pointing to a specified UI element.
  25. */
  26. export declare class DxPopoverComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
  27. private _watcherHelper;
  28. private _idh;
  29. instance: DxPopover;
  30. /**
  31. * Configures widget visibility animations. This object contains two fields: show and hide.
  32. */
  33. animation: {
  34. hide?: DevExpress.animationConfig;
  35. show?: DevExpress.animationConfig;
  36. };
  37. /**
  38. * 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.
  39. */
  40. closeOnOutsideClick: boolean | Function;
  41. /**
  42. * Specifies the container in which to place the widget.
  43. */
  44. container: Element | JQuery;
  45. /**
  46. * Specifies a custom template for the widget content.
  47. */
  48. contentTemplate: any;
  49. /**
  50. * Specifies whether to render the widget's content when it is displayed. If false, the content is rendered immediately.
  51. */
  52. deferRendering: boolean;
  53. /**
  54. * Specifies whether the widget responds to user interaction.
  55. */
  56. disabled: boolean;
  57. /**
  58. * Specifies the attributes to be attached to the widget's root element.
  59. */
  60. elementAttr: any;
  61. /**
  62. * Specifies the widget's height.
  63. */
  64. height: number | Function | string;
  65. /**
  66. * Specifies options of popover hiding.
  67. */
  68. hideEvent: string | {
  69. delay?: number;
  70. name?: string;
  71. };
  72. /**
  73. * Specifies text for a hint that appears when a user pauses on the widget.
  74. */
  75. hint: string;
  76. /**
  77. * Specifies whether the widget changes its state when a user pauses on it.
  78. */
  79. hoverStateEnabled: boolean;
  80. /**
  81. * Specifies the maximum height the widget can reach while resizing.
  82. */
  83. maxHeight: number | Function | string;
  84. /**
  85. * Specifies the maximum width the widget can reach while resizing.
  86. */
  87. maxWidth: number | Function | string;
  88. /**
  89. * Specifies the minimum height the widget can reach while resizing.
  90. */
  91. minHeight: number | Function | string;
  92. /**
  93. * Specifies the minimum width the widget can reach while resizing.
  94. */
  95. minWidth: number | Function | string;
  96. /**
  97. * An object defining widget positioning options.
  98. */
  99. position: DevExpress.positionConfig | string;
  100. /**
  101. * Switches the widget to a right-to-left representation.
  102. */
  103. rtlEnabled: boolean;
  104. /**
  105. * Specifies whether to shade the background when the widget is active.
  106. */
  107. shading: boolean;
  108. /**
  109. * Specifies the shading color.
  110. */
  111. shadingColor: string;
  112. /**
  113. * Specifies whether or not the widget displays the Close button.
  114. */
  115. showCloseButton: boolean;
  116. /**
  117. * Specifies options for displaying the widget.
  118. */
  119. showEvent: string | {
  120. delay?: number;
  121. name?: string;
  122. };
  123. /**
  124. * A Boolean value specifying whether or not to display the title in the overlay window.
  125. */
  126. showTitle: boolean;
  127. /**
  128. * The target element associated with the widget.
  129. */
  130. target: Element | JQuery;
  131. /**
  132. * The title in the overlay window.
  133. */
  134. title: string;
  135. /**
  136. * Specifies a custom template for the widget title. Does not apply if the title is defined.
  137. */
  138. titleTemplate: any;
  139. /**
  140. * Configures toolbar items.
  141. */
  142. toolbarItems: Array<any | {
  143. disabled?: boolean;
  144. html?: string;
  145. location?: string;
  146. options?: any;
  147. template?: any;
  148. text?: string;
  149. toolbar?: string;
  150. visible?: boolean;
  151. widget?: string;
  152. }>;
  153. /**
  154. * A Boolean value specifying whether or not the widget is visible.
  155. */
  156. visible: boolean;
  157. /**
  158. * Specifies the widget's width.
  159. */
  160. width: number | Function | string;
  161. /**
  162. * A function that is executed when the widget's content is ready and each time the content is changed.
  163. */
  164. onContentReady: EventEmitter<any>;
  165. /**
  166. * A function that is executed before the widget is disposed of.
  167. */
  168. onDisposing: EventEmitter<any>;
  169. /**
  170. * A function that is executed after the widget is hidden.
  171. */
  172. onHidden: EventEmitter<any>;
  173. /**
  174. * A function that is executed before the widget is hidden.
  175. */
  176. onHiding: EventEmitter<any>;
  177. /**
  178. * A function used in JavaScript frameworks to save the widget instance.
  179. */
  180. onInitialized: EventEmitter<any>;
  181. /**
  182. * A function that is executed after a widget option is changed.
  183. */
  184. onOptionChanged: EventEmitter<any>;
  185. /**
  186. * A function that is executed before the widget is displayed.
  187. */
  188. onShowing: EventEmitter<any>;
  189. /**
  190. * A function that is executed after the widget is displayed.
  191. */
  192. onShown: EventEmitter<any>;
  193. /**
  194. * A function that is executed when the widget's title is rendered.
  195. */
  196. onTitleRendered: EventEmitter<any>;
  197. /**
  198. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  199. */
  200. animationChange: EventEmitter<{
  201. hide?: DevExpress.animationConfig;
  202. show?: DevExpress.animationConfig;
  203. }>;
  204. /**
  205. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  206. */
  207. closeOnOutsideClickChange: EventEmitter<boolean | Function>;
  208. /**
  209. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  210. */
  211. containerChange: EventEmitter<Element | JQuery>;
  212. /**
  213. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  214. */
  215. contentTemplateChange: EventEmitter<any>;
  216. /**
  217. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  218. */
  219. deferRenderingChange: EventEmitter<boolean>;
  220. /**
  221. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  222. */
  223. disabledChange: EventEmitter<boolean>;
  224. /**
  225. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  226. */
  227. elementAttrChange: EventEmitter<any>;
  228. /**
  229. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  230. */
  231. heightChange: EventEmitter<number | Function | string>;
  232. /**
  233. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  234. */
  235. hideEventChange: EventEmitter<string | {
  236. delay?: number;
  237. name?: string;
  238. }>;
  239. /**
  240. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  241. */
  242. hintChange: EventEmitter<string>;
  243. /**
  244. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  245. */
  246. hoverStateEnabledChange: EventEmitter<boolean>;
  247. /**
  248. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  249. */
  250. maxHeightChange: EventEmitter<number | Function | string>;
  251. /**
  252. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  253. */
  254. maxWidthChange: EventEmitter<number | Function | string>;
  255. /**
  256. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  257. */
  258. minHeightChange: EventEmitter<number | Function | string>;
  259. /**
  260. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  261. */
  262. minWidthChange: EventEmitter<number | Function | string>;
  263. /**
  264. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  265. */
  266. positionChange: EventEmitter<DevExpress.positionConfig | string>;
  267. /**
  268. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  269. */
  270. rtlEnabledChange: EventEmitter<boolean>;
  271. /**
  272. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  273. */
  274. shadingChange: EventEmitter<boolean>;
  275. /**
  276. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  277. */
  278. shadingColorChange: EventEmitter<string>;
  279. /**
  280. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  281. */
  282. showCloseButtonChange: EventEmitter<boolean>;
  283. /**
  284. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  285. */
  286. showEventChange: EventEmitter<string | {
  287. delay?: number;
  288. name?: string;
  289. }>;
  290. /**
  291. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  292. */
  293. showTitleChange: EventEmitter<boolean>;
  294. /**
  295. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  296. */
  297. targetChange: EventEmitter<Element | JQuery>;
  298. /**
  299. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  300. */
  301. titleChange: EventEmitter<string>;
  302. /**
  303. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  304. */
  305. titleTemplateChange: EventEmitter<any>;
  306. /**
  307. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  308. */
  309. toolbarItemsChange: EventEmitter<Array<any | {
  310. disabled?: boolean;
  311. html?: string;
  312. location?: string;
  313. options?: any;
  314. template?: any;
  315. text?: string;
  316. toolbar?: string;
  317. visible?: boolean;
  318. widget?: string;
  319. }>>;
  320. /**
  321. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  322. */
  323. visibleChange: EventEmitter<boolean>;
  324. /**
  325. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  326. */
  327. widthChange: EventEmitter<number | Function | string>;
  328. toolbarItemsChildren: QueryList<DxiToolbarItemComponent>;
  329. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  330. protected _createInstance(element: any, options: any): DxPopover;
  331. ngOnDestroy(): void;
  332. ngOnChanges(changes: SimpleChanges): void;
  333. setupChanges(prop: string, changes: SimpleChanges): void;
  334. ngDoCheck(): void;
  335. _setOption(name: string, value: any): void;
  336. }
  337. export declare class DxPopoverModule {
  338. }