mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-11-04 12:58:38 +08:00
100 lines
2.5 KiB
TypeScript
100 lines
2.5 KiB
TypeScript
import { ContentView } from '../content-view';
|
|
import { Property } from '../core/properties';
|
|
import { EventData } from '../../data/observable';
|
|
import { CoreTypes } from '../../core-types';
|
|
|
|
/**
|
|
* Represents a scrollable area that can have content that is larger than its bounds.
|
|
*
|
|
* @nsView ScrollView
|
|
*/
|
|
export class ScrollView extends ContentView {
|
|
/**
|
|
* String value used when hooking to scroll event.
|
|
*
|
|
* @nsEvent {ScrollEventData} scroll
|
|
*/
|
|
public static scrollEvent: string;
|
|
|
|
/**
|
|
* Gets or sets a value indicating whether scroll is enabled.
|
|
*
|
|
* @nsProperty
|
|
*/
|
|
isScrollEnabled: boolean;
|
|
|
|
/**
|
|
* 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;
|
|
|
|
/**
|
|
* Toggles scrollbar indicator visibility
|
|
*
|
|
* @nsProperty
|
|
*/
|
|
scrollBarIndicatorVisible: boolean;
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @nsProperty
|
|
*/
|
|
orientation: CoreTypes.OrientationType;
|
|
|
|
/**
|
|
* Adds a listener for the specified event name.
|
|
*
|
|
* @param eventName The name of the event.
|
|
* @param callback The event listener to add. Will be called when an event of
|
|
* the given name is raised.
|
|
* @param thisArg An optional parameter which, when set, will be bound as the
|
|
* `this` context when the callback is called. Falsy values will be not be
|
|
* bound.
|
|
*/
|
|
on(eventName: string, callback: (data: EventData) => void, thisArg?: any): void;
|
|
|
|
/**
|
|
* Raised when a scroll event occurs.
|
|
*/
|
|
on(event: 'scroll', callback: (args: ScrollEventData) => void, thisArg?: any): void;
|
|
|
|
_onOrientationChanged(): void;
|
|
}
|
|
|
|
export interface ScrollEventData extends EventData {
|
|
scrollX: number;
|
|
scrollY: number;
|
|
}
|
|
|
|
export const orientationProperty: Property<ScrollView, CoreTypes.OrientationType>;
|