progress-bar.d.ts 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  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 } from '@angular/core';
  15. import DxProgressBar from 'devextreme/ui/progress_bar';
  16. import { ControlValueAccessor } from '@angular/forms';
  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. /**
  22. * The ProgressBar is a widget that shows current progress.
  23. */
  24. export declare class DxProgressBarComponent extends DxComponent implements OnDestroy, ControlValueAccessor {
  25. instance: DxProgressBar;
  26. /**
  27. * Specifies whether the widget responds to user interaction.
  28. */
  29. disabled: boolean;
  30. /**
  31. * Specifies the attributes to be attached to the widget's root element.
  32. */
  33. elementAttr: any;
  34. /**
  35. * Specifies the widget's height.
  36. */
  37. height: number | Function | string;
  38. /**
  39. * Specifies text for a hint that appears when a user pauses on the widget.
  40. */
  41. hint: string;
  42. /**
  43. * Specifies whether the widget changes its state when a user pauses on it.
  44. */
  45. hoverStateEnabled: boolean;
  46. /**
  47. * Specifies whether the editor's value is valid.
  48. */
  49. isValid: boolean;
  50. /**
  51. * The maximum value the widget can accept.
  52. */
  53. max: number;
  54. /**
  55. * The minimum value the widget can accept.
  56. */
  57. min: number;
  58. /**
  59. * Specifies whether the editor is read-only.
  60. */
  61. readOnly: boolean;
  62. /**
  63. * Switches the widget to a right-to-left representation.
  64. */
  65. rtlEnabled: boolean;
  66. /**
  67. * Specifies whether or not the widget displays a progress status.
  68. */
  69. showStatus: boolean;
  70. /**
  71. * Specifies a format for the progress status.
  72. */
  73. statusFormat: Function | string;
  74. /**
  75. * Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option.
  76. */
  77. validationError: any;
  78. /**
  79. * Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
  80. */
  81. validationMessageMode: string;
  82. /**
  83. * The current widget value.
  84. */
  85. value: number;
  86. /**
  87. * Specifies whether the widget is visible.
  88. */
  89. visible: boolean;
  90. /**
  91. * Specifies the widget's width.
  92. */
  93. width: number | Function | string;
  94. /**
  95. * A function that is executed when the value reaches the maximum.
  96. */
  97. onComplete: EventEmitter<any>;
  98. /**
  99. * A function that is executed when the widget's content is ready and each time the content is changed.
  100. */
  101. onContentReady: EventEmitter<any>;
  102. /**
  103. * A function that is executed before the widget is disposed of.
  104. */
  105. onDisposing: EventEmitter<any>;
  106. /**
  107. * A function used in JavaScript frameworks to save the widget instance.
  108. */
  109. onInitialized: EventEmitter<any>;
  110. /**
  111. * A function that is executed after a widget option is changed.
  112. */
  113. onOptionChanged: EventEmitter<any>;
  114. /**
  115. * A function that is executed after the widget's value is changed.
  116. */
  117. onValueChanged: EventEmitter<any>;
  118. /**
  119. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  120. */
  121. disabledChange: EventEmitter<boolean>;
  122. /**
  123. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  124. */
  125. elementAttrChange: EventEmitter<any>;
  126. /**
  127. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  128. */
  129. heightChange: EventEmitter<number | Function | string>;
  130. /**
  131. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  132. */
  133. hintChange: EventEmitter<string>;
  134. /**
  135. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  136. */
  137. hoverStateEnabledChange: EventEmitter<boolean>;
  138. /**
  139. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  140. */
  141. isValidChange: EventEmitter<boolean>;
  142. /**
  143. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  144. */
  145. maxChange: EventEmitter<number>;
  146. /**
  147. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  148. */
  149. minChange: EventEmitter<number>;
  150. /**
  151. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  152. */
  153. readOnlyChange: EventEmitter<boolean>;
  154. /**
  155. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  156. */
  157. rtlEnabledChange: EventEmitter<boolean>;
  158. /**
  159. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  160. */
  161. showStatusChange: EventEmitter<boolean>;
  162. /**
  163. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  164. */
  165. statusFormatChange: EventEmitter<Function | string>;
  166. /**
  167. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  168. */
  169. validationErrorChange: EventEmitter<any>;
  170. /**
  171. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  172. */
  173. validationMessageModeChange: EventEmitter<string>;
  174. /**
  175. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  176. */
  177. valueChange: EventEmitter<number>;
  178. /**
  179. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  180. */
  181. visibleChange: EventEmitter<boolean>;
  182. /**
  183. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  184. */
  185. widthChange: EventEmitter<number | Function | string>;
  186. onBlur: EventEmitter<any>;
  187. change(_: any): void;
  188. touched: (_: any) => void;
  189. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  190. protected _createInstance(element: any, options: any): DxProgressBar;
  191. writeValue(value: any): void;
  192. setDisabledState(isDisabled: boolean): void;
  193. registerOnChange(fn: (_: any) => void): void;
  194. registerOnTouched(fn: () => void): void;
  195. _createWidget(element: any): void;
  196. ngOnDestroy(): void;
  197. }
  198. export declare class DxProgressBarModule {
  199. }