calendar.d.ts 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286
  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 DxCalendar from 'devextreme/ui/calendar';
  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. import { IterableDifferHelper } from '../core/iterable-differ-helper';
  22. /**
  23. * The Calendar is a widget that displays a calendar and allows an end user to select the required date within a specified date range.
  24. */
  25. export declare class DxCalendarComponent extends DxComponent implements OnDestroy, ControlValueAccessor, OnChanges, DoCheck {
  26. private _watcherHelper;
  27. private _idh;
  28. instance: DxCalendar;
  29. /**
  30. * Specifies the shortcut key that sets focus on the widget.
  31. */
  32. accessKey: string;
  33. /**
  34. * Specifies whether or not the widget changes its state when interacting with a user.
  35. */
  36. activeStateEnabled: boolean;
  37. /**
  38. * Specifies a custom template for calendar cells.
  39. */
  40. cellTemplate: any;
  41. /**
  42. * Specifies the date-time value serialization format. Use it only if you do not specify the value at design time.
  43. */
  44. dateSerializationFormat: string;
  45. /**
  46. * Specifies whether the widget responds to user interaction.
  47. */
  48. disabled: boolean;
  49. /**
  50. * Specifies dates to be disabled.
  51. */
  52. disabledDates: Function | Array<Date>;
  53. /**
  54. * Specifies the attributes to be attached to the widget's root element.
  55. */
  56. elementAttr: any;
  57. /**
  58. * Specifies the first day of a week.
  59. */
  60. firstDayOfWeek: number | string;
  61. /**
  62. * Specifies whether the widget can be focused using keyboard navigation.
  63. */
  64. focusStateEnabled: boolean;
  65. /**
  66. * Specifies the widget's height.
  67. */
  68. height: number | Function | string;
  69. /**
  70. * Specifies text for a hint that appears when a user pauses on the widget.
  71. */
  72. hint: string;
  73. /**
  74. * Specifies whether the widget changes its state when a user pauses on it.
  75. */
  76. hoverStateEnabled: boolean;
  77. /**
  78. * Specifies whether the editor's value is valid.
  79. */
  80. isValid: boolean;
  81. /**
  82. * The latest date the widget allows to select.
  83. */
  84. max: Date | number | string;
  85. /**
  86. * Specifies the maximum zoom level of the calendar.
  87. */
  88. maxZoomLevel: string;
  89. /**
  90. * The earliest date the widget allows to select.
  91. */
  92. min: Date | number | string;
  93. /**
  94. * Specifies the minimum zoom level of the calendar.
  95. */
  96. minZoomLevel: string;
  97. /**
  98. * The value to be assigned to the `name` attribute of the underlying HTML element.
  99. */
  100. name: string;
  101. /**
  102. * Specifies whether the editor is read-only.
  103. */
  104. readOnly: boolean;
  105. /**
  106. * Switches the widget to a right-to-left representation.
  107. */
  108. rtlEnabled: boolean;
  109. /**
  110. * Specifies whether or not the widget displays a button that selects the current date.
  111. */
  112. showTodayButton: boolean;
  113. /**
  114. * Specifies the number of the element when the Tab key is used for navigating.
  115. */
  116. tabIndex: number;
  117. /**
  118. * Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option.
  119. */
  120. validationError: any;
  121. /**
  122. * Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
  123. */
  124. validationMessageMode: string;
  125. /**
  126. * An object or a value specifying the date and time currently selected in the calendar.
  127. */
  128. value: Date | number | string;
  129. /**
  130. * Specifies whether the widget is visible.
  131. */
  132. visible: boolean;
  133. /**
  134. * Specifies the widget's width.
  135. */
  136. width: number | Function | string;
  137. /**
  138. * Specifies the current calendar zoom level.
  139. */
  140. zoomLevel: string;
  141. /**
  142. * A function that is executed before the widget is disposed of.
  143. */
  144. onDisposing: EventEmitter<any>;
  145. /**
  146. * A function used in JavaScript frameworks to save the widget instance.
  147. */
  148. onInitialized: EventEmitter<any>;
  149. /**
  150. * A function that is executed after a widget option is changed.
  151. */
  152. onOptionChanged: EventEmitter<any>;
  153. /**
  154. * A function that is executed after the widget's value is changed.
  155. */
  156. onValueChanged: EventEmitter<any>;
  157. /**
  158. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  159. */
  160. accessKeyChange: EventEmitter<string>;
  161. /**
  162. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  163. */
  164. activeStateEnabledChange: EventEmitter<boolean>;
  165. /**
  166. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  167. */
  168. cellTemplateChange: EventEmitter<any>;
  169. /**
  170. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  171. */
  172. dateSerializationFormatChange: EventEmitter<string>;
  173. /**
  174. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  175. */
  176. disabledChange: EventEmitter<boolean>;
  177. /**
  178. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  179. */
  180. disabledDatesChange: EventEmitter<Function | Array<Date>>;
  181. /**
  182. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  183. */
  184. elementAttrChange: EventEmitter<any>;
  185. /**
  186. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  187. */
  188. firstDayOfWeekChange: EventEmitter<number | string>;
  189. /**
  190. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  191. */
  192. focusStateEnabledChange: EventEmitter<boolean>;
  193. /**
  194. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  195. */
  196. heightChange: EventEmitter<number | Function | string>;
  197. /**
  198. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  199. */
  200. hintChange: EventEmitter<string>;
  201. /**
  202. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  203. */
  204. hoverStateEnabledChange: EventEmitter<boolean>;
  205. /**
  206. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  207. */
  208. isValidChange: EventEmitter<boolean>;
  209. /**
  210. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  211. */
  212. maxChange: EventEmitter<Date | number | string>;
  213. /**
  214. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  215. */
  216. maxZoomLevelChange: EventEmitter<string>;
  217. /**
  218. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  219. */
  220. minChange: EventEmitter<Date | number | string>;
  221. /**
  222. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  223. */
  224. minZoomLevelChange: EventEmitter<string>;
  225. /**
  226. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  227. */
  228. nameChange: EventEmitter<string>;
  229. /**
  230. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  231. */
  232. readOnlyChange: EventEmitter<boolean>;
  233. /**
  234. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  235. */
  236. rtlEnabledChange: EventEmitter<boolean>;
  237. /**
  238. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  239. */
  240. showTodayButtonChange: EventEmitter<boolean>;
  241. /**
  242. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  243. */
  244. tabIndexChange: EventEmitter<number>;
  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<Date | number | string>;
  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. /**
  266. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  267. */
  268. zoomLevelChange: EventEmitter<string>;
  269. onBlur: EventEmitter<any>;
  270. change(_: any): void;
  271. touched: (_: any) => void;
  272. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  273. protected _createInstance(element: any, options: any): DxCalendar;
  274. writeValue(value: any): void;
  275. setDisabledState(isDisabled: boolean): void;
  276. registerOnChange(fn: (_: any) => void): void;
  277. registerOnTouched(fn: () => void): void;
  278. _createWidget(element: any): void;
  279. ngOnDestroy(): void;
  280. ngOnChanges(changes: SimpleChanges): void;
  281. setupChanges(prop: string, changes: SimpleChanges): void;
  282. ngDoCheck(): void;
  283. _setOption(name: string, value: any): void;
  284. }
  285. export declare class DxCalendarModule {
  286. }