multi-view.d.ts 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  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 DxMultiView from 'devextreme/ui/multi_view';
  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 { DxiItemComponent } from './nested/item-dxi';
  23. /**
  24. * The MultiView is a widget that contains several views. An end user navigates through the views by swiping them in the horizontal direction.
  25. */
  26. export declare class DxMultiViewComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
  27. private _watcherHelper;
  28. private _idh;
  29. instance: DxMultiView;
  30. /**
  31. * Specifies the shortcut key that sets focus on the widget.
  32. */
  33. accessKey: string;
  34. /**
  35. * Specifies whether or not the widget changes its state when interacting with a user.
  36. */
  37. activeStateEnabled: boolean;
  38. /**
  39. * Specifies whether or not to animate the displayed item change.
  40. */
  41. animationEnabled: boolean;
  42. /**
  43. * Binds the widget to data.
  44. */
  45. dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.CollectionWidgetItem>;
  46. /**
  47. * Specifies whether to render the view's content when it is displayed. If false, the content is rendered immediately.
  48. */
  49. deferRendering: boolean;
  50. /**
  51. * Specifies whether the widget responds to user interaction.
  52. */
  53. disabled: boolean;
  54. /**
  55. * Specifies the attributes to be attached to the widget's root element.
  56. */
  57. elementAttr: any;
  58. /**
  59. * Specifies whether the widget can be focused using keyboard navigation.
  60. */
  61. focusStateEnabled: boolean;
  62. /**
  63. * Specifies the widget's height.
  64. */
  65. height: number | Function | string;
  66. /**
  67. * Specifies text for a hint that appears when a user pauses on the widget.
  68. */
  69. hint: string;
  70. /**
  71. * Specifies whether the widget changes its state when a user pauses on it.
  72. */
  73. hoverStateEnabled: boolean;
  74. /**
  75. * The time period in milliseconds before the onItemHold event is raised.
  76. */
  77. itemHoldTimeout: number;
  78. /**
  79. * An array of items displayed by the widget.
  80. */
  81. items: Array<string | any | {
  82. disabled?: boolean;
  83. html?: string;
  84. template?: any;
  85. text?: string;
  86. }>;
  87. /**
  88. * Specifies a custom template for items.
  89. */
  90. itemTemplate: any;
  91. /**
  92. * A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped.
  93. */
  94. loop: boolean;
  95. /**
  96. * The text or HTML markup displayed by the widget if the item collection is empty.
  97. */
  98. noDataText: string;
  99. /**
  100. * Switches the widget to a right-to-left representation.
  101. */
  102. rtlEnabled: boolean;
  103. /**
  104. * The index of the currently displayed item.
  105. */
  106. selectedIndex: number;
  107. /**
  108. * The selected item object.
  109. */
  110. selectedItem: any;
  111. /**
  112. * A Boolean value specifying whether or not to allow users to change the selected index by swiping.
  113. */
  114. swipeEnabled: boolean;
  115. /**
  116. * Specifies the number of the element when the Tab key is used for navigating.
  117. */
  118. tabIndex: number;
  119. /**
  120. * Specifies whether 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 used in JavaScript frameworks to save the widget instance.
  137. */
  138. onInitialized: EventEmitter<any>;
  139. /**
  140. * A function that is executed when a collection item is clicked or tapped.
  141. */
  142. onItemClick: EventEmitter<any>;
  143. /**
  144. * A function that is executed when a collection item is right-clicked or pressed.
  145. */
  146. onItemContextMenu: EventEmitter<any>;
  147. /**
  148. * A function that is executed when a collection item has been held for a specified period.
  149. */
  150. onItemHold: EventEmitter<any>;
  151. /**
  152. * A function that is executed after a collection item is rendered.
  153. */
  154. onItemRendered: EventEmitter<any>;
  155. /**
  156. * A function that is executed after a widget option is changed.
  157. */
  158. onOptionChanged: EventEmitter<any>;
  159. /**
  160. * A function that is executed when a collection item is selected or selection is canceled.
  161. */
  162. onSelectionChanged: EventEmitter<any>;
  163. /**
  164. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  165. */
  166. accessKeyChange: EventEmitter<string>;
  167. /**
  168. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  169. */
  170. activeStateEnabledChange: EventEmitter<boolean>;
  171. /**
  172. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  173. */
  174. animationEnabledChange: EventEmitter<boolean>;
  175. /**
  176. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  177. */
  178. dataSourceChange: EventEmitter<DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.CollectionWidgetItem>>;
  179. /**
  180. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  181. */
  182. deferRenderingChange: EventEmitter<boolean>;
  183. /**
  184. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  185. */
  186. disabledChange: EventEmitter<boolean>;
  187. /**
  188. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  189. */
  190. elementAttrChange: EventEmitter<any>;
  191. /**
  192. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  193. */
  194. focusStateEnabledChange: EventEmitter<boolean>;
  195. /**
  196. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  197. */
  198. heightChange: EventEmitter<number | Function | string>;
  199. /**
  200. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  201. */
  202. hintChange: EventEmitter<string>;
  203. /**
  204. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  205. */
  206. hoverStateEnabledChange: EventEmitter<boolean>;
  207. /**
  208. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  209. */
  210. itemHoldTimeoutChange: EventEmitter<number>;
  211. /**
  212. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  213. */
  214. itemsChange: EventEmitter<Array<string | any | {
  215. disabled?: boolean;
  216. html?: string;
  217. template?: any;
  218. text?: string;
  219. }>>;
  220. /**
  221. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  222. */
  223. itemTemplateChange: EventEmitter<any>;
  224. /**
  225. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  226. */
  227. loopChange: EventEmitter<boolean>;
  228. /**
  229. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  230. */
  231. noDataTextChange: EventEmitter<string>;
  232. /**
  233. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  234. */
  235. rtlEnabledChange: EventEmitter<boolean>;
  236. /**
  237. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  238. */
  239. selectedIndexChange: EventEmitter<number>;
  240. /**
  241. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  242. */
  243. selectedItemChange: EventEmitter<any>;
  244. /**
  245. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  246. */
  247. swipeEnabledChange: EventEmitter<boolean>;
  248. /**
  249. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  250. */
  251. tabIndexChange: EventEmitter<number>;
  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. itemsChildren: QueryList<DxiItemComponent>;
  261. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  262. protected _createInstance(element: any, options: any): DxMultiView;
  263. ngOnDestroy(): void;
  264. ngOnChanges(changes: SimpleChanges): void;
  265. setupChanges(prop: string, changes: SimpleChanges): void;
  266. ngDoCheck(): void;
  267. _setOption(name: string, value: any): void;
  268. }
  269. export declare class DxMultiViewModule {
  270. }