NativeScript/nativescript-core/data/virtual-array/virtual-array.d.ts

/**
 * Contains the VirtualArray class, which is an advanced array like class that helps loading items on demand.
 * @module "data/virtual-array"
 */ /** */

import { Observable, EventData } from "../observable";
import { ObservableArray, ChangedData, ChangeType } from "../observable-array";
export { ChangedData, ChangeType } from "../observable-array";

/**
 * Advanced array like class that helps loading items on demand.
 */
export class VirtualArray<T> extends Observable {
    /**
     * String value used when hooking to change event.
     */
    public static changeEvent: string;

    /**
     * String value used when hooking to itemsLoading event.
     */
    public static itemsLoadingEvent: string;

    constructor(arrayLength?: number);

    /**
     * Gets or sets length for the virtual array.
     */
    length: number;

    /**
     * Gets or sets load size for the virtual array.
     */
    loadSize: number;

    /**
     * Returns item at specified index.
     */
    getItem(index: number): T;

    /**
     * Sets item at specified index.
     */
    setItem(index: number, value: T): void;

    /**
     * Loads items from an array starting at index.
     */
    load(index: number, items: T[]): void;

    /**
     * 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: EventData) => void, thisArg?: any);

    /**
     * Raised when still not loaded items are requested.
     */
    on(event: "itemsLoading", callback: (args: ItemsLoading) => void, thisArg?: any);

    /**
     * Raised when a change occurs.
     */
    on(event: "change", callback: (args: ChangedData<T>) => void, thisArg?: any);
}

/**
 * Event args for "itemsLoading" event.
 */
export interface ItemsLoading extends EventData {
    /**
     * Start index.
     */
    index: number;

    /**
     * Number of items to load.
     */
    count: number;
}