Note: You are on the beta version of our docs. This is a work in progress and may contain broken links and pages.
Classes
ScrollView
ScrollView
Represents a scrollable area that can have content that is larger than its bounds.
Summary
Constructors
Properties
- horizontalOffset
- isScrollEnabled
- orientation
- scrollableHeight
- scrollableWidth
- scrollBarIndicatorVisible
- scrollEvent
- verticalOffset
155 properties inherited from ContentView
Click to expand
Methods
113 methods inherited from ContentView
Click to expand
Constructors
constructor
new ScrollView(): ScrollView
Returns ScrollView
Properties
horizontalOffset
Gets a value that contains the horizontal offset of the scrolled content.
isScrollEnabled
Gets or sets a value indicating whether scroll is enabled.
orientation
orientation: OrientationType
Gets or sets direction in which the content can be scrolled.
scrollBarIndicatorVisible
Toggles scrollbar indicator visibility
scrollableHeight
Gets the maximum value for the verticalOffset.
scrollableWidth
Gets the maximum value for the horizontalOffset.
verticalOffset
Gets a value that contains the vertical offset of the scrolled content.
scrollEvent
Static
String value used when hooking to scroll event.
Methods
_onOrientationChanged
Returns void
on
on(eventNames: string, callback: (data: EventData) => void, thisArg?: any): void
A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
| Parameter | Default | Description |
eventNames | | stringString corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change"). |
callback | | (data: EventData) => voidCallback function which will be executed when event is raised. |
thisArg | | anyAn optional parameter which will be used as `this` context for callback execution. |
Returns void
on(event: "scroll", callback: (args: ScrollEventData) => void, thisArg?: any): void
Raised when a scroll event occurs.
| Parameter | Default | Description |
event | | "scroll" |
callback | | (args: ScrollEventData) => void |
thisArg | | any |
Returns void
scrollToHorizontalOffset
Scrolls the content the specified horizontal offset position.
| Parameter | Default | Description |
value | | numberThe offset value |
animated | | booleantrue for animated scroll, false for immediate scroll. |
Returns any
scrollToVerticalOffset
Scrolls the content the specified vertical offset position.
| Parameter | Default | Description |
value | | numberThe offset value |
animated | | booleantrue for animated scroll, false for immediate scroll. |
Returns any