toolbar.d.ts 7.8 KB

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