box.d.ts 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  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 DxBox from 'devextreme/ui/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 { DxiItemComponent } from './nested/item-dxi';
  23. /**
  24. * The Box widget allows you to arrange various elements within it. Separate and adaptive, the Box widget acts as a building block for the layout.
  25. */
  26. export declare class DxBoxComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
  27. private _watcherHelper;
  28. private _idh;
  29. instance: DxBox;
  30. /**
  31. * Specifies how widget items are aligned along the main direction.
  32. */
  33. align: string;
  34. /**
  35. * Specifies how widget items are aligned cross-wise.
  36. */
  37. crossAlign: string;
  38. /**
  39. * Binds the widget to data.
  40. */
  41. dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.CollectionWidgetItem>;
  42. /**
  43. * Specifies the direction of item positioning in the widget.
  44. */
  45. direction: string;
  46. /**
  47. * Specifies whether the widget responds to user interaction.
  48. */
  49. disabled: boolean;
  50. /**
  51. * Specifies the attributes to be attached to the widget's root element.
  52. */
  53. elementAttr: any;
  54. /**
  55. * Specifies the widget's height.
  56. */
  57. height: number | Function | string;
  58. /**
  59. * Specifies whether the widget changes its state when a user pauses on it.
  60. */
  61. hoverStateEnabled: boolean;
  62. /**
  63. * The time period in milliseconds before the onItemHold event is raised.
  64. */
  65. itemHoldTimeout: number;
  66. /**
  67. * An array of items displayed by the widget.
  68. */
  69. items: Array<string | any | {
  70. baseSize?: number | string;
  71. box?: DevExpress.ui.dxBoxOptions;
  72. disabled?: boolean;
  73. html?: string;
  74. ratio?: number;
  75. shrink?: number;
  76. template?: any;
  77. text?: string;
  78. visible?: boolean;
  79. }>;
  80. /**
  81. * Specifies a custom template for items.
  82. */
  83. itemTemplate: any;
  84. /**
  85. * Switches the widget to a right-to-left representation.
  86. */
  87. rtlEnabled: boolean;
  88. /**
  89. * Specifies whether the widget is visible.
  90. */
  91. visible: boolean;
  92. /**
  93. * Specifies the widget's width.
  94. */
  95. width: number | Function | string;
  96. /**
  97. * A function that is executed when the widget's content is ready and each time the content is changed.
  98. */
  99. onContentReady: EventEmitter<any>;
  100. /**
  101. * A function that is executed before the widget is disposed of.
  102. */
  103. onDisposing: EventEmitter<any>;
  104. /**
  105. * A function used in JavaScript frameworks to save the widget instance.
  106. */
  107. onInitialized: EventEmitter<any>;
  108. /**
  109. * A function that is executed when a collection item is clicked or tapped.
  110. */
  111. onItemClick: EventEmitter<any>;
  112. /**
  113. * A function that is executed when a collection item is right-clicked or pressed.
  114. */
  115. onItemContextMenu: EventEmitter<any>;
  116. /**
  117. * A function that is executed when a collection item has been held for a specified period.
  118. */
  119. onItemHold: EventEmitter<any>;
  120. /**
  121. * A function that is executed after a collection item is rendered.
  122. */
  123. onItemRendered: EventEmitter<any>;
  124. /**
  125. * A function that is executed after a widget option is changed.
  126. */
  127. onOptionChanged: EventEmitter<any>;
  128. /**
  129. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  130. */
  131. alignChange: EventEmitter<string>;
  132. /**
  133. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  134. */
  135. crossAlignChange: EventEmitter<string>;
  136. /**
  137. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  138. */
  139. dataSourceChange: EventEmitter<DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.CollectionWidgetItem>>;
  140. /**
  141. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  142. */
  143. directionChange: EventEmitter<string>;
  144. /**
  145. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  146. */
  147. disabledChange: EventEmitter<boolean>;
  148. /**
  149. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  150. */
  151. elementAttrChange: EventEmitter<any>;
  152. /**
  153. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  154. */
  155. heightChange: EventEmitter<number | Function | string>;
  156. /**
  157. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  158. */
  159. hoverStateEnabledChange: EventEmitter<boolean>;
  160. /**
  161. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  162. */
  163. itemHoldTimeoutChange: EventEmitter<number>;
  164. /**
  165. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  166. */
  167. itemsChange: EventEmitter<Array<string | any | {
  168. baseSize?: number | string;
  169. box?: DevExpress.ui.dxBoxOptions;
  170. disabled?: boolean;
  171. html?: string;
  172. ratio?: number;
  173. shrink?: number;
  174. template?: any;
  175. text?: string;
  176. visible?: boolean;
  177. }>>;
  178. /**
  179. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  180. */
  181. itemTemplateChange: EventEmitter<any>;
  182. /**
  183. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  184. */
  185. rtlEnabledChange: EventEmitter<boolean>;
  186. /**
  187. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  188. */
  189. visibleChange: EventEmitter<boolean>;
  190. /**
  191. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  192. */
  193. widthChange: EventEmitter<number | Function | string>;
  194. itemsChildren: QueryList<DxiItemComponent>;
  195. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  196. protected _createInstance(element: any, options: any): DxBox;
  197. ngOnDestroy(): void;
  198. ngOnChanges(changes: SimpleChanges): void;
  199. setupChanges(prop: string, changes: SimpleChanges): void;
  200. ngDoCheck(): void;
  201. _setOption(name: string, value: any): void;
  202. }
  203. export declare class DxBoxModule {
  204. }