range-slider.d.ts 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
  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 } from '@angular/core';
  15. import DevExpress from 'devextreme/bundles/dx.all';
  16. import DxRangeSlider from 'devextreme/ui/range_slider';
  17. import { ControlValueAccessor } from '@angular/forms';
  18. import { DxComponent } from '../core/component';
  19. import { DxTemplateHost } from '../core/template-host';
  20. import { NestedOptionHost } from '../core/nested-option';
  21. import { WatcherHelper } from '../core/watcher-helper';
  22. import { IterableDifferHelper } from '../core/iterable-differ-helper';
  23. /**
  24. * The RangeSlider is a widget that allows an end user to choose a range of numeric values.
  25. */
  26. export declare class DxRangeSliderComponent extends DxComponent implements OnDestroy, ControlValueAccessor, OnChanges, DoCheck {
  27. private _watcherHelper;
  28. private _idh;
  29. instance: DxRangeSlider;
  30. /**
  31. * Specifies the shortcut key that sets focus on the widget.
  32. */
  33. accessKey: string;
  34. /**
  35. * Specifies whether or not the widget changes its state when interacting with a user.
  36. */
  37. activeStateEnabled: boolean;
  38. /**
  39. * Specifies whether the widget responds to user interaction.
  40. */
  41. disabled: boolean;
  42. /**
  43. * Specifies the attributes to be attached to the widget's root element.
  44. */
  45. elementAttr: any;
  46. /**
  47. * The right edge of the interval currently selected using the range slider.
  48. */
  49. end: number;
  50. /**
  51. * The value to be assigned to the name attribute of the underlying `` element.
  52. */
  53. endName: string;
  54. /**
  55. * Specifies whether the widget can be focused using keyboard navigation.
  56. */
  57. focusStateEnabled: boolean;
  58. /**
  59. * Specifies the widget's height.
  60. */
  61. height: number | Function | string;
  62. /**
  63. * Specifies text for a hint that appears when a user pauses on the widget.
  64. */
  65. hint: string;
  66. /**
  67. * Specifies whether the widget changes its state when a user pauses on it.
  68. */
  69. hoverStateEnabled: boolean;
  70. /**
  71. * Specifies whether the editor's value is valid.
  72. */
  73. isValid: boolean;
  74. /**
  75. * Specifies the step by which a handle moves when a user presses Page Up or Page Down.
  76. */
  77. keyStep: number;
  78. /**
  79. * Configures the labels displayed at the min and max values.
  80. */
  81. label: {
  82. format?: DevExpress.ui.format | string;
  83. position?: string;
  84. visible?: boolean;
  85. };
  86. /**
  87. * The maximum value the widget can accept.
  88. */
  89. max: number;
  90. /**
  91. * The minimum value the widget can accept.
  92. */
  93. min: number;
  94. /**
  95. * Specifies whether the editor is read-only.
  96. */
  97. readOnly: boolean;
  98. /**
  99. * Switches the widget to a right-to-left representation.
  100. */
  101. rtlEnabled: boolean;
  102. /**
  103. * Specifies whether to highlight the selected range.
  104. */
  105. showRange: boolean;
  106. /**
  107. * The left edge of the interval currently selected using the range slider.
  108. */
  109. start: number;
  110. /**
  111. * The value to be assigned to the name attribute of the underlying `` element.
  112. */
  113. startName: string;
  114. /**
  115. * Specifies the step by which the widget's value changes when a user drags a handler.
  116. */
  117. step: number;
  118. /**
  119. * Specifies the number of the element when the Tab key is used for navigating.
  120. */
  121. tabIndex: number;
  122. /**
  123. * Configures a tooltip.
  124. */
  125. tooltip: {
  126. enabled?: boolean;
  127. format?: DevExpress.ui.format | string;
  128. position?: string;
  129. showMode?: string;
  130. };
  131. /**
  132. * Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option.
  133. */
  134. validationError: any;
  135. /**
  136. * Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
  137. */
  138. validationMessageMode: string;
  139. /**
  140. * Specifies the widget's value.
  141. */
  142. value: Array<number>;
  143. /**
  144. * Specifies whether the widget is visible.
  145. */
  146. visible: boolean;
  147. /**
  148. * Specifies the widget's width.
  149. */
  150. width: number | Function | string;
  151. /**
  152. * A function that is executed when the widget's content is ready and each time the content is changed.
  153. */
  154. onContentReady: EventEmitter<any>;
  155. /**
  156. * A function that is executed before the widget is disposed of.
  157. */
  158. onDisposing: EventEmitter<any>;
  159. /**
  160. * A function used in JavaScript frameworks to save the widget instance.
  161. */
  162. onInitialized: EventEmitter<any>;
  163. /**
  164. * A function that is executed after a widget option is changed.
  165. */
  166. onOptionChanged: EventEmitter<any>;
  167. /**
  168. * A function that is executed after the widget's value is changed.
  169. */
  170. onValueChanged: EventEmitter<any>;
  171. /**
  172. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  173. */
  174. accessKeyChange: EventEmitter<string>;
  175. /**
  176. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  177. */
  178. activeStateEnabledChange: EventEmitter<boolean>;
  179. /**
  180. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  181. */
  182. disabledChange: EventEmitter<boolean>;
  183. /**
  184. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  185. */
  186. elementAttrChange: EventEmitter<any>;
  187. /**
  188. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  189. */
  190. endChange: EventEmitter<number>;
  191. /**
  192. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  193. */
  194. endNameChange: EventEmitter<string>;
  195. /**
  196. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  197. */
  198. focusStateEnabledChange: EventEmitter<boolean>;
  199. /**
  200. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  201. */
  202. heightChange: EventEmitter<number | Function | string>;
  203. /**
  204. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  205. */
  206. hintChange: EventEmitter<string>;
  207. /**
  208. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  209. */
  210. hoverStateEnabledChange: EventEmitter<boolean>;
  211. /**
  212. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  213. */
  214. isValidChange: EventEmitter<boolean>;
  215. /**
  216. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  217. */
  218. keyStepChange: EventEmitter<number>;
  219. /**
  220. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  221. */
  222. labelChange: EventEmitter<{
  223. format?: DevExpress.ui.format | string;
  224. position?: string;
  225. visible?: boolean;
  226. }>;
  227. /**
  228. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  229. */
  230. maxChange: EventEmitter<number>;
  231. /**
  232. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  233. */
  234. minChange: EventEmitter<number>;
  235. /**
  236. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  237. */
  238. readOnlyChange: EventEmitter<boolean>;
  239. /**
  240. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  241. */
  242. rtlEnabledChange: EventEmitter<boolean>;
  243. /**
  244. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  245. */
  246. showRangeChange: EventEmitter<boolean>;
  247. /**
  248. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  249. */
  250. startChange: EventEmitter<number>;
  251. /**
  252. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  253. */
  254. startNameChange: EventEmitter<string>;
  255. /**
  256. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  257. */
  258. stepChange: EventEmitter<number>;
  259. /**
  260. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  261. */
  262. tabIndexChange: EventEmitter<number>;
  263. /**
  264. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  265. */
  266. tooltipChange: EventEmitter<{
  267. enabled?: boolean;
  268. format?: DevExpress.ui.format | string;
  269. position?: string;
  270. showMode?: string;
  271. }>;
  272. /**
  273. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  274. */
  275. validationErrorChange: EventEmitter<any>;
  276. /**
  277. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  278. */
  279. validationMessageModeChange: EventEmitter<string>;
  280. /**
  281. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  282. */
  283. valueChange: EventEmitter<Array<number>>;
  284. /**
  285. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  286. */
  287. visibleChange: EventEmitter<boolean>;
  288. /**
  289. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  290. */
  291. widthChange: EventEmitter<number | Function | string>;
  292. onBlur: EventEmitter<any>;
  293. change(_: any): void;
  294. touched: (_: any) => void;
  295. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  296. protected _createInstance(element: any, options: any): DxRangeSlider;
  297. writeValue(value: any): void;
  298. setDisabledState(isDisabled: boolean): void;
  299. registerOnChange(fn: (_: any) => void): void;
  300. registerOnTouched(fn: () => void): void;
  301. _createWidget(element: any): void;
  302. ngOnDestroy(): void;
  303. ngOnChanges(changes: SimpleChanges): void;
  304. setupChanges(prop: string, changes: SimpleChanges): void;
  305. ngDoCheck(): void;
  306. _setOption(name: string, value: any): void;
  307. }
  308. export declare class DxRangeSliderModule {
  309. }