slider.d.ts 9.7 KB

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