responsive-box.d.ts 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242
  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 DxResponsiveBox from 'devextreme/ui/responsive_box';
  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 { DxiColComponent } from './nested/col-dxi';
  23. import { DxiItemComponent } from './nested/item-dxi';
  24. import { DxiRowComponent } from './nested/row-dxi';
  25. /**
  26. * The ResponsiveBox widget allows you to create an application or a website with a layout adapted to different screen sizes.
  27. */
  28. export declare class DxResponsiveBoxComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
  29. private _watcherHelper;
  30. private _idh;
  31. instance: DxResponsiveBox;
  32. /**
  33. * Specifies the collection of columns for the grid used to position layout elements.
  34. */
  35. cols: Array<any | {
  36. baseSize?: number | string;
  37. ratio?: number;
  38. screen?: string;
  39. shrink?: number;
  40. }>;
  41. /**
  42. * Binds the widget to data.
  43. */
  44. dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.CollectionWidgetItem>;
  45. /**
  46. * Specifies whether the widget responds to user interaction.
  47. */
  48. disabled: boolean;
  49. /**
  50. * Specifies the attributes to be attached to the widget's root element.
  51. */
  52. elementAttr: any;
  53. /**
  54. * Specifies the widget's height.
  55. */
  56. height: number | Function | string;
  57. /**
  58. * Specifies whether the widget changes its state when a user pauses on it.
  59. */
  60. hoverStateEnabled: boolean;
  61. /**
  62. * The time period in milliseconds before the onItemHold event is raised.
  63. */
  64. itemHoldTimeout: number;
  65. /**
  66. * An array of items displayed by the widget.
  67. */
  68. items: Array<string | any | {
  69. disabled?: boolean;
  70. html?: string;
  71. location?: Array<any | {
  72. col?: number;
  73. colspan?: number;
  74. row?: number;
  75. rowspan?: number;
  76. screen?: string;
  77. }>;
  78. template?: any;
  79. text?: string;
  80. visible?: boolean;
  81. }>;
  82. /**
  83. * Specifies a custom template for items.
  84. */
  85. itemTemplate: any;
  86. /**
  87. * Specifies the collection of rows for the grid used to position layout elements.
  88. */
  89. rows: Array<any | {
  90. baseSize?: number | string;
  91. ratio?: number;
  92. screen?: string;
  93. shrink?: number;
  94. }>;
  95. /**
  96. * Switches the widget to a right-to-left representation.
  97. */
  98. rtlEnabled: boolean;
  99. /**
  100. * Specifies the function returning the size qualifier depending on the screen's width.
  101. */
  102. screenByWidth: Function;
  103. /**
  104. * Specifies on which screens all layout elements should be arranged in a single column. Accepts a single or several size qualifiers separated by a space.
  105. */
  106. singleColumnScreen: string;
  107. /**
  108. * Specifies whether the widget is visible.
  109. */
  110. visible: boolean;
  111. /**
  112. * Specifies the widget's width.
  113. */
  114. width: number | Function | string;
  115. /**
  116. * A function that is executed when the widget's content is ready and each time the content is changed.
  117. */
  118. onContentReady: EventEmitter<any>;
  119. /**
  120. * A function that is executed before the widget is disposed of.
  121. */
  122. onDisposing: EventEmitter<any>;
  123. /**
  124. * A function used in JavaScript frameworks to save the widget instance.
  125. */
  126. onInitialized: EventEmitter<any>;
  127. /**
  128. * A function that is executed when a collection item is clicked or tapped.
  129. */
  130. onItemClick: EventEmitter<any>;
  131. /**
  132. * A function that is executed when a collection item is right-clicked or pressed.
  133. */
  134. onItemContextMenu: EventEmitter<any>;
  135. /**
  136. * A function that is executed when a collection item has been held for a specified period.
  137. */
  138. onItemHold: EventEmitter<any>;
  139. /**
  140. * A function that is executed after a collection item is rendered.
  141. */
  142. onItemRendered: EventEmitter<any>;
  143. /**
  144. * A function that is executed after a widget option is changed.
  145. */
  146. onOptionChanged: EventEmitter<any>;
  147. /**
  148. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  149. */
  150. colsChange: EventEmitter<Array<any | {
  151. baseSize?: number | string;
  152. ratio?: number;
  153. screen?: string;
  154. shrink?: number;
  155. }>>;
  156. /**
  157. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  158. */
  159. dataSourceChange: EventEmitter<DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.CollectionWidgetItem>>;
  160. /**
  161. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  162. */
  163. disabledChange: EventEmitter<boolean>;
  164. /**
  165. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  166. */
  167. elementAttrChange: EventEmitter<any>;
  168. /**
  169. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  170. */
  171. heightChange: EventEmitter<number | Function | string>;
  172. /**
  173. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  174. */
  175. hoverStateEnabledChange: EventEmitter<boolean>;
  176. /**
  177. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  178. */
  179. itemHoldTimeoutChange: EventEmitter<number>;
  180. /**
  181. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  182. */
  183. itemsChange: EventEmitter<Array<string | any | {
  184. disabled?: boolean;
  185. html?: string;
  186. location?: Array<any | {
  187. col?: number;
  188. colspan?: number;
  189. row?: number;
  190. rowspan?: number;
  191. screen?: string;
  192. }>;
  193. template?: any;
  194. text?: string;
  195. visible?: boolean;
  196. }>>;
  197. /**
  198. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  199. */
  200. itemTemplateChange: EventEmitter<any>;
  201. /**
  202. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  203. */
  204. rowsChange: EventEmitter<Array<any | {
  205. baseSize?: number | string;
  206. ratio?: number;
  207. screen?: string;
  208. shrink?: number;
  209. }>>;
  210. /**
  211. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  212. */
  213. rtlEnabledChange: EventEmitter<boolean>;
  214. /**
  215. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  216. */
  217. screenByWidthChange: EventEmitter<Function>;
  218. /**
  219. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  220. */
  221. singleColumnScreenChange: EventEmitter<string>;
  222. /**
  223. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  224. */
  225. visibleChange: EventEmitter<boolean>;
  226. /**
  227. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  228. */
  229. widthChange: EventEmitter<number | Function | string>;
  230. colsChildren: QueryList<DxiColComponent>;
  231. itemsChildren: QueryList<DxiItemComponent>;
  232. rowsChildren: QueryList<DxiRowComponent>;
  233. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  234. protected _createInstance(element: any, options: any): DxResponsiveBox;
  235. ngOnDestroy(): void;
  236. ngOnChanges(changes: SimpleChanges): void;
  237. setupChanges(prop: string, changes: SimpleChanges): void;
  238. ngDoCheck(): void;
  239. _setOption(name: string, value: any): void;
  240. }
  241. export declare class DxResponsiveBoxModule {
  242. }