forked from NativeScript/NativeScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathscroll-view.d.ts
More file actions
79 lines (66 loc) · 2.85 KB
/
scroll-view.d.ts
File metadata and controls
79 lines (66 loc) · 2.85 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/**
* Contains the ScrollView class, which represents a scrollable area that can have content that is larger than its bounds.
*/
declare module "ui/scroll-view" {
import contentView = require("ui/content-view");
import observable = require("data/observable");
import dependencyObservable = require("ui/core/dependency-observable");
export var orientationProperty: dependencyObservable.Property;
/**
* Represents a scrollable area that can have content that is larger than its bounds.
*/
class ScrollView extends contentView.ContentView {
public static orientationProperty: dependencyObservable.Property;
/**
* String value used when hooking to scroll event.
*/
public static scrollEvent: string;
/**
* Gets a value that contains the vertical offset of the scrolled content.
*/
verticalOffset: number;
/**
* Gets a value that contains the horizontal offset of the scrolled content.
*/
horizontalOffset: number;
/**
* Gets the maximum value for the verticalOffset.
*/
scrollableHeight: number;
/**
* Gets the maximum value for the horizontalOffset.
*/
scrollableWidth: number;
/**
* Scrolls the content the specified vertical offset position.
* @param value The offset value
* @param animated true for animated scroll, false for immediate scroll.
*/
scrollToVerticalOffset(value: number, animated: boolean);
/**
* Scrolls the content the specified horizontal offset position.
* @param value The offset value
* @param animated true for animated scroll, false for immediate scroll.
*/
scrollToHorizontalOffset(value: number, animated: boolean);
/**
* Gets or sets direction in which the content can be scrolled.
*/
orientation: string;
/**
* A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
* @param eventNames - String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change").
* @param callback - Callback function which will be executed when event is raised.
* @param thisArg - An optional parameter which will be used as `this` context for callback execution.
*/
on(eventNames: string, callback: (data: observable.EventData) => void, thisArg?: any);
/**
* Raised when a scroll event occurs.
*/
on(event: "scroll", callback: (args: ScrollEventData) => void, thisArg?: any);
}
interface ScrollEventData extends observable.EventData {
scrollX: number;
scrollY: number;
}
}