scroll-view.d.ts 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  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 DxScrollView from 'devextreme/ui/scroll_view';
  16. import { DxComponent } from '../core/component';
  17. import { DxTemplateHost } from '../core/template-host';
  18. import { NestedOptionHost } from '../core/nested-option';
  19. import { WatcherHelper } from '../core/watcher-helper';
  20. /**
  21. * The ScrollView is a widget that enables a user to scroll its content.
  22. */
  23. export declare class DxScrollViewComponent extends DxComponent implements OnDestroy {
  24. instance: DxScrollView;
  25. /**
  26. * A Boolean value specifying whether to enable or disable the bounce-back effect.
  27. */
  28. bounceEnabled: boolean;
  29. /**
  30. * A string value specifying the available scrolling directions.
  31. */
  32. direction: string;
  33. /**
  34. * A Boolean value specifying whether or not the widget can respond to user interaction.
  35. */
  36. disabled: boolean;
  37. /**
  38. * Specifies the attributes to be attached to the widget's root element.
  39. */
  40. elementAttr: any;
  41. /**
  42. * Specifies the widget's height.
  43. */
  44. height: number | Function | string;
  45. /**
  46. * Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold.
  47. */
  48. pulledDownText: string;
  49. /**
  50. * Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold.
  51. */
  52. pullingDownText: string;
  53. /**
  54. * Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom.
  55. */
  56. reachBottomText: string;
  57. /**
  58. * Specifies the text shown in the pullDown panel displayed when the content is being refreshed.
  59. */
  60. refreshingText: string;
  61. /**
  62. * Switches the widget to a right-to-left representation.
  63. */
  64. rtlEnabled: boolean;
  65. /**
  66. * A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. Applies only if useNative is false
  67. */
  68. scrollByContent: boolean;
  69. /**
  70. * A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar.
  71. */
  72. scrollByThumb: boolean;
  73. /**
  74. * Specifies when the widget shows the scrollbar.
  75. */
  76. showScrollbar: string;
  77. /**
  78. * Indicates whether to use native or simulated scrolling.
  79. */
  80. useNative: boolean;
  81. /**
  82. * Specifies the widget's width.
  83. */
  84. width: number | Function | string;
  85. /**
  86. * A function that is executed before the widget is disposed of.
  87. */
  88. onDisposing: EventEmitter<any>;
  89. /**
  90. * A function used in JavaScript frameworks to save the widget instance.
  91. */
  92. onInitialized: EventEmitter<any>;
  93. /**
  94. * A function that is executed after a widget option is changed.
  95. */
  96. onOptionChanged: EventEmitter<any>;
  97. /**
  98. * A function that is executed when the "pull to refresh" gesture is performed. Supported in mobile themes only.
  99. */
  100. onPullDown: EventEmitter<any>;
  101. /**
  102. * A function that is executed when the content is scrolled down to the bottom.
  103. */
  104. onReachBottom: EventEmitter<any>;
  105. /**
  106. * A function that is executed on each scroll gesture.
  107. */
  108. onScroll: EventEmitter<any>;
  109. /**
  110. * A function that is executed each time the widget is updated.
  111. */
  112. onUpdated: EventEmitter<any>;
  113. /**
  114. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  115. */
  116. bounceEnabledChange: EventEmitter<boolean>;
  117. /**
  118. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  119. */
  120. directionChange: EventEmitter<string>;
  121. /**
  122. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  123. */
  124. disabledChange: EventEmitter<boolean>;
  125. /**
  126. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  127. */
  128. elementAttrChange: EventEmitter<any>;
  129. /**
  130. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  131. */
  132. heightChange: EventEmitter<number | Function | string>;
  133. /**
  134. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  135. */
  136. pulledDownTextChange: EventEmitter<string>;
  137. /**
  138. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  139. */
  140. pullingDownTextChange: EventEmitter<string>;
  141. /**
  142. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  143. */
  144. reachBottomTextChange: EventEmitter<string>;
  145. /**
  146. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  147. */
  148. refreshingTextChange: EventEmitter<string>;
  149. /**
  150. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  151. */
  152. rtlEnabledChange: EventEmitter<boolean>;
  153. /**
  154. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  155. */
  156. scrollByContentChange: EventEmitter<boolean>;
  157. /**
  158. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  159. */
  160. scrollByThumbChange: EventEmitter<boolean>;
  161. /**
  162. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  163. */
  164. showScrollbarChange: EventEmitter<string>;
  165. /**
  166. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  167. */
  168. useNativeChange: EventEmitter<boolean>;
  169. /**
  170. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  171. */
  172. widthChange: EventEmitter<number | Function | string>;
  173. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  174. protected _createInstance(element: any, options: any): DxScrollView;
  175. ngOnDestroy(): void;
  176. }
  177. export declare class DxScrollViewModule {
  178. }