tile-view.d.ts 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264
  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 DxTileView from 'devextreme/ui/tile_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 TileView widget contains a collection of tiles. Tiles can store much more information than ordinary buttons, that is why they are very popular in apps designed for touch devices.
  25. */
  26. export declare class DxTileViewComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
  27. private _watcherHelper;
  28. private _idh;
  29. instance: DxTileView;
  30. /**
  31. * Specifies the shortcut key that sets focus on the widget.
  32. */
  33. accessKey: string;
  34. /**
  35. * A Boolean value specifying whether or not the widget changes its state when interacting with a user.
  36. */
  37. activeStateEnabled: boolean;
  38. /**
  39. * Specifies the height of the base tile view item.
  40. */
  41. baseItemHeight: number;
  42. /**
  43. * Specifies the width of the base tile view item.
  44. */
  45. baseItemWidth: number;
  46. /**
  47. * Binds the widget to data.
  48. */
  49. dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.CollectionWidgetItem>;
  50. /**
  51. * Specifies whether tiles are placed horizontally or vertically.
  52. */
  53. direction: string;
  54. /**
  55. * Specifies whether the widget responds to user interaction.
  56. */
  57. disabled: boolean;
  58. /**
  59. * Specifies the attributes to be attached to the widget's root element.
  60. */
  61. elementAttr: any;
  62. /**
  63. * Specifies whether the widget can be focused using keyboard navigation.
  64. */
  65. focusStateEnabled: boolean;
  66. /**
  67. * Specifies the widget's height.
  68. */
  69. height: number | string;
  70. /**
  71. * Specifies text for a hint that appears when a user pauses on the widget.
  72. */
  73. hint: string;
  74. /**
  75. * Specifies whether the widget changes its state when a user pauses on it.
  76. */
  77. hoverStateEnabled: boolean;
  78. /**
  79. * The time period in milliseconds before the onItemHold event is raised.
  80. */
  81. itemHoldTimeout: number;
  82. /**
  83. * Specifies the distance in pixels between adjacent tiles.
  84. */
  85. itemMargin: number;
  86. /**
  87. * An array of items displayed by the widget.
  88. */
  89. items: Array<string | any | {
  90. disabled?: boolean;
  91. heightRatio?: number;
  92. html?: string;
  93. template?: any;
  94. text?: string;
  95. visible?: boolean;
  96. widthRatio?: number;
  97. }>;
  98. /**
  99. * Specifies a custom template for items.
  100. */
  101. itemTemplate: any;
  102. /**
  103. * The text or HTML markup displayed by the widget if the item collection is empty.
  104. */
  105. noDataText: string;
  106. /**
  107. * Switches the widget to a right-to-left representation.
  108. */
  109. rtlEnabled: boolean;
  110. /**
  111. * A Boolean value specifying whether or not to display a scrollbar.
  112. */
  113. showScrollbar: boolean;
  114. /**
  115. * Specifies the number of the element when the Tab key is used for navigating.
  116. */
  117. tabIndex: number;
  118. /**
  119. * Specifies whether the widget is visible.
  120. */
  121. visible: boolean;
  122. /**
  123. * Specifies the widget's width.
  124. */
  125. width: number | Function | string;
  126. /**
  127. * A function that is executed when the widget's content is ready and each time the content is changed.
  128. */
  129. onContentReady: EventEmitter<any>;
  130. /**
  131. * A function that is executed before the widget is disposed of.
  132. */
  133. onDisposing: EventEmitter<any>;
  134. /**
  135. * A function used in JavaScript frameworks to save the widget instance.
  136. */
  137. onInitialized: EventEmitter<any>;
  138. /**
  139. * A function that is executed when a collection item is clicked or tapped.
  140. */
  141. onItemClick: EventEmitter<any>;
  142. /**
  143. * A function that is executed when a collection item is right-clicked or pressed.
  144. */
  145. onItemContextMenu: EventEmitter<any>;
  146. /**
  147. * A function that is executed when a collection item has been held for a specified period.
  148. */
  149. onItemHold: EventEmitter<any>;
  150. /**
  151. * A function that is executed after a collection item is rendered.
  152. */
  153. onItemRendered: EventEmitter<any>;
  154. /**
  155. * A function that is executed after a widget option is changed.
  156. */
  157. onOptionChanged: EventEmitter<any>;
  158. /**
  159. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  160. */
  161. accessKeyChange: EventEmitter<string>;
  162. /**
  163. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  164. */
  165. activeStateEnabledChange: EventEmitter<boolean>;
  166. /**
  167. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  168. */
  169. baseItemHeightChange: EventEmitter<number>;
  170. /**
  171. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  172. */
  173. baseItemWidthChange: EventEmitter<number>;
  174. /**
  175. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  176. */
  177. dataSourceChange: EventEmitter<DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.CollectionWidgetItem>>;
  178. /**
  179. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  180. */
  181. directionChange: EventEmitter<string>;
  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. focusStateEnabledChange: EventEmitter<boolean>;
  194. /**
  195. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  196. */
  197. heightChange: EventEmitter<number | string>;
  198. /**
  199. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  200. */
  201. hintChange: EventEmitter<string>;
  202. /**
  203. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  204. */
  205. hoverStateEnabledChange: EventEmitter<boolean>;
  206. /**
  207. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  208. */
  209. itemHoldTimeoutChange: EventEmitter<number>;
  210. /**
  211. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  212. */
  213. itemMarginChange: EventEmitter<number>;
  214. /**
  215. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  216. */
  217. itemsChange: EventEmitter<Array<string | any | {
  218. disabled?: boolean;
  219. heightRatio?: number;
  220. html?: string;
  221. template?: any;
  222. text?: string;
  223. visible?: boolean;
  224. widthRatio?: number;
  225. }>>;
  226. /**
  227. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  228. */
  229. itemTemplateChange: EventEmitter<any>;
  230. /**
  231. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  232. */
  233. noDataTextChange: EventEmitter<string>;
  234. /**
  235. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  236. */
  237. rtlEnabledChange: EventEmitter<boolean>;
  238. /**
  239. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  240. */
  241. showScrollbarChange: EventEmitter<boolean>;
  242. /**
  243. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  244. */
  245. tabIndexChange: EventEmitter<number>;
  246. /**
  247. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  248. */
  249. visibleChange: EventEmitter<boolean>;
  250. /**
  251. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  252. */
  253. widthChange: EventEmitter<number | Function | string>;
  254. itemsChildren: QueryList<DxiItemComponent>;
  255. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  256. protected _createInstance(element: any, options: any): DxTileView;
  257. ngOnDestroy(): void;
  258. ngOnChanges(changes: SimpleChanges): void;
  259. setupChanges(prop: string, changes: SimpleChanges): void;
  260. ngDoCheck(): void;
  261. _setOption(name: string, value: any): void;
  262. }
  263. export declare class DxTileViewModule {
  264. }