mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-11-05 13:26:48 +08:00
chore: cleanup reexports
This commit is contained in:
@@ -1,25 +1,59 @@
|
||||
import * as observable from "../observable";
|
||||
import * as observableArrayDef from ".";
|
||||
import { Observable, EventData } from "../observable";
|
||||
import * as types from "../../utils/types";
|
||||
|
||||
export class ChangeType implements observableArrayDef.ChangeType {
|
||||
export class ChangeType {
|
||||
static Add = "add";
|
||||
static Delete = "delete";
|
||||
static Update = "update";
|
||||
static Splice = "splice";
|
||||
static Change = "change";
|
||||
}
|
||||
|
||||
/**
|
||||
* Event args for "changed" event.
|
||||
*/
|
||||
export interface ChangedData<T> extends EventData {
|
||||
/**
|
||||
* Change type.
|
||||
*/
|
||||
action: string;
|
||||
|
||||
/**
|
||||
* Start index.
|
||||
*/
|
||||
index: number;
|
||||
|
||||
/**
|
||||
* Removed items.
|
||||
*/
|
||||
removed: Array<T>;
|
||||
|
||||
/**
|
||||
* Number of added items.
|
||||
*/
|
||||
addedCount: number;
|
||||
}
|
||||
|
||||
const CHANGE = "change";
|
||||
|
||||
export class ObservableArray<T> extends observable.Observable implements observableArrayDef.ObservableArray<T> { // implements Array<T> {
|
||||
/**
|
||||
* Advanced array like class used when you want to be notified when a change occurs.
|
||||
*/
|
||||
export class ObservableArray<T> extends Observable {
|
||||
|
||||
/**
|
||||
* String value used when hooking to change event.
|
||||
*/
|
||||
public static changeEvent = CHANGE;
|
||||
|
||||
private _array: Array<any>;
|
||||
private _addArgs: observableArrayDef.ChangedData<T>;
|
||||
private _deleteArgs: observableArrayDef.ChangedData<T>;
|
||||
private _addArgs: ChangedData<T>;
|
||||
private _deleteArgs: ChangedData<T>;
|
||||
|
||||
constructor(_args?: any) {
|
||||
/**
|
||||
* Create ObservableArray<T> with specified length or from source Array<T>.
|
||||
*/
|
||||
constructor(_args?: number | T[]) {
|
||||
super();
|
||||
|
||||
if (arguments.length === 1 && Array.isArray(arguments[0])) {
|
||||
@@ -46,15 +80,21 @@ export class ObservableArray<T> extends observable.Observable implements observa
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns item at specified index.
|
||||
*/
|
||||
getItem(index: number): T {
|
||||
return this._array[index];
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets item at specified index.
|
||||
*/
|
||||
setItem(index: number, value: T) {
|
||||
let oldValue = this._array[index];
|
||||
this._array[index] = value;
|
||||
|
||||
this.notify(<observableArrayDef.ChangedData<T>>{
|
||||
this.notify(<ChangedData<T>>{
|
||||
eventName: CHANGE, object: this,
|
||||
action: ChangeType.Update,
|
||||
index: index,
|
||||
@@ -202,7 +242,7 @@ export class ObservableArray<T> extends observable.Observable implements observa
|
||||
const length = this._array.length;
|
||||
const result = this._array.splice.apply(this._array, arguments);
|
||||
|
||||
this.notify(<observableArrayDef.ChangedData<T>>{
|
||||
this.notify(<ChangedData<T>>{
|
||||
eventName: CHANGE, object: this,
|
||||
action: ChangeType.Splice,
|
||||
index: start,
|
||||
@@ -331,7 +371,13 @@ export class ObservableArray<T> extends observable.Observable implements observa
|
||||
}
|
||||
|
||||
export interface ObservableArray<T> {
|
||||
on(eventNames: string, callback: (data: observable.EventData) => void, thisArg?: any);
|
||||
/**
|
||||
* 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): void;
|
||||
|
||||
on(event: "change", callback: (args: observableArrayDef.ChangedData<T>) => void, thisArg?: any);
|
||||
on(event: "change", callback: (args: ChangedData<T>) => void, thisArg?: any): void;
|
||||
}
|
||||
@@ -1,239 +0,0 @@
|
||||
// Test: http://jsperf.com/array-vs-observable-array-vs-array-observe
|
||||
import { Observable, EventData } from "../observable";
|
||||
|
||||
/**
|
||||
* Event args for "changed" event.
|
||||
*/
|
||||
export interface ChangedData<T> extends EventData {
|
||||
/**
|
||||
* Change type.
|
||||
*/
|
||||
action: string;
|
||||
|
||||
/**
|
||||
* Start index.
|
||||
*/
|
||||
index: number;
|
||||
|
||||
/**
|
||||
* Removed items.
|
||||
*/
|
||||
removed: Array<T>;
|
||||
|
||||
/**
|
||||
* Number of added items.
|
||||
*/
|
||||
addedCount: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Change types.
|
||||
*/
|
||||
export class ChangeType {
|
||||
static Add: string;
|
||||
static Delete: string;
|
||||
static Update: string;
|
||||
static Splice: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Advanced array like class used when you want to be notified when a change occurs.
|
||||
*/
|
||||
export class ObservableArray<T> extends Observable {
|
||||
/**
|
||||
* String value used when hooking to change event.
|
||||
*/
|
||||
public static changeEvent: 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: EventData) => void, thisArg?: any);
|
||||
|
||||
/**
|
||||
* Raised when a change occurs.
|
||||
*/
|
||||
on(event: "change", callback: (args: ChangedData<T>) => void, thisArg?: any);
|
||||
|
||||
/**
|
||||
* Create ObservableArray<T> with specified length.
|
||||
*/
|
||||
constructor(arrayLength?: number);
|
||||
|
||||
/**
|
||||
* Create ObservableArray<T> from source Array<T>.
|
||||
*/
|
||||
constructor(items: T[]);
|
||||
|
||||
/**
|
||||
* Create ObservableArray<T> from T items.
|
||||
*/
|
||||
constructor(...items: T[]);
|
||||
|
||||
/**
|
||||
* Returns item at specified index.
|
||||
*/
|
||||
getItem(index: number): T;
|
||||
/**
|
||||
* Sets item at specified index.
|
||||
*/
|
||||
setItem(index: number, value: T): void;
|
||||
/**
|
||||
* Returns a string representation of an array.
|
||||
*/
|
||||
toString(): string;
|
||||
toLocaleString(): string;
|
||||
/**
|
||||
* Combines two or more arrays.
|
||||
* @param items Additional items to add to the end of array1.
|
||||
*/
|
||||
concat<U extends T[]>(...items: U[]): T[];
|
||||
/**
|
||||
* Combines two or more arrays.
|
||||
* @param items Additional items to add to the end of array1.
|
||||
*/
|
||||
concat(...items: T[]): T[];
|
||||
/**
|
||||
* Adds all the elements of an array separated by the specified separator string.
|
||||
* @param separator A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
|
||||
*/
|
||||
join(separator?: string): string;
|
||||
/**
|
||||
* Removes the last element from an array and returns it.
|
||||
*/
|
||||
pop(): T;
|
||||
/**
|
||||
* Appends new elements to an array, and returns the new length of the array.
|
||||
* @param items New elements of the Array.
|
||||
*/
|
||||
push(items: T[]): number;
|
||||
/**
|
||||
* Appends new elements to an array, and returns the new length of the array.
|
||||
* @param items New elements of the Array.
|
||||
*/
|
||||
push(...items: T[]): number;
|
||||
|
||||
/**
|
||||
* Reverses the elements in an Array.
|
||||
*/
|
||||
reverse(): T[];
|
||||
/**
|
||||
* Removes the first element from an array and returns it.
|
||||
*/
|
||||
shift(): T;
|
||||
/**
|
||||
* Returns a section of an array.
|
||||
* @param start The beginning of the specified portion of the array.
|
||||
* @param end The end of the specified portion of the array.
|
||||
*/
|
||||
slice(start?: number, end?: number): T[];
|
||||
|
||||
/**
|
||||
* Sorts an array.
|
||||
* @param compareFn The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
|
||||
*/
|
||||
sort(compareFn?: (a: T, b: T) => number): T[];
|
||||
|
||||
/**
|
||||
* Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
|
||||
* @param start The zero-based location in the array from which to start removing elements.
|
||||
*/
|
||||
splice(start: number): T[];
|
||||
|
||||
/**
|
||||
* Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
|
||||
* @param start The zero-based location in the array from which to start removing elements.
|
||||
* @param deleteCount The number of elements to remove.
|
||||
* @param items Elements to insert into the array in place of the deleted elements.
|
||||
*/
|
||||
splice(start: number, deleteCount: number, ...items: T[]): T[];
|
||||
|
||||
/**
|
||||
* Inserts new elements at the start of an array.
|
||||
* @param items Elements to insert at the start of the Array.
|
||||
*/
|
||||
unshift(...items: T[]): number;
|
||||
|
||||
/**
|
||||
* Returns the index of the first occurrence of a value in an array.
|
||||
* @param searchElement The value to locate in the array.
|
||||
* @param fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
|
||||
*/
|
||||
indexOf(searchElement: T, fromIndex?: number): number;
|
||||
|
||||
/**
|
||||
* Returns the index of the last occurrence of a specified value in an array.
|
||||
* @param searchElement The value to locate in the array.
|
||||
* @param fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
|
||||
*/
|
||||
lastIndexOf(searchElement: T, fromIndex?: number): number;
|
||||
|
||||
/**
|
||||
* Determines whether all the members of an array satisfy the specified test.
|
||||
* @param callbackfn A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
|
||||
* @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
|
||||
*/
|
||||
every(callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg?: any): boolean;
|
||||
|
||||
/**
|
||||
* Determines whether the specified callback function returns true for any element of an array.
|
||||
* @param callbackfn A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
|
||||
* @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
|
||||
*/
|
||||
some(callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg?: any): boolean;
|
||||
|
||||
/**
|
||||
* Performs the specified action for each element in an array.
|
||||
* @param callbackfn A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
|
||||
* @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
|
||||
*/
|
||||
forEach(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any): void;
|
||||
|
||||
/**
|
||||
* Calls a defined callback function on each element of an array, and returns an array that contains the results.
|
||||
* @param callbackfn A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
|
||||
* @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
|
||||
*/
|
||||
map<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any): U[];
|
||||
|
||||
/**
|
||||
* Returns the elements of an array that meet the condition specified in a callback function.
|
||||
* @param callbackfn A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
|
||||
* @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
|
||||
*/
|
||||
filter(callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg?: any): T[];
|
||||
|
||||
/**
|
||||
* Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
|
||||
* @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
|
||||
* @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
|
||||
*/
|
||||
reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue?: T): T;
|
||||
/**
|
||||
* Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
|
||||
* @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
|
||||
* @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
|
||||
*/
|
||||
reduce<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U;
|
||||
|
||||
/**
|
||||
* Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
|
||||
* @param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
|
||||
* @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
|
||||
*/
|
||||
reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue?: T): T;
|
||||
/**
|
||||
* Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
|
||||
* @param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
|
||||
* @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
|
||||
*/
|
||||
reduceRight<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U;
|
||||
|
||||
/**
|
||||
* Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.
|
||||
*/
|
||||
length: number;
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"types": "observable-array.d.ts",
|
||||
"name": "observable-array",
|
||||
"main": "observable-array"
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"types": "observable.d.ts",
|
||||
"name": "observable",
|
||||
"main": "observable"
|
||||
}
|
||||
@@ -1,3 +0,0 @@
|
||||
{
|
||||
"nativescript": {}
|
||||
}
|
||||
226
nativescript-core/data/virtual-array/index.ts
Normal file
226
nativescript-core/data/virtual-array/index.ts
Normal file
@@ -0,0 +1,226 @@
|
||||
import { Observable, EventData } from "../observable";
|
||||
import { ObservableArray, ChangedData, ChangeType } from "../observable-array";
|
||||
|
||||
/**
|
||||
* Event args for "itemsLoading" event.
|
||||
*/
|
||||
export interface ItemsLoading extends EventData {
|
||||
/**
|
||||
* Start index.
|
||||
*/
|
||||
index: number;
|
||||
|
||||
/**
|
||||
* Number of items to load.
|
||||
*/
|
||||
count: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 = ChangeType.Change;
|
||||
/**
|
||||
* String value used when hooking to itemsLoading event.
|
||||
*/
|
||||
public static itemsLoadingEvent = "itemsLoading";
|
||||
|
||||
private _requestedIndexes: Array<number>;
|
||||
private _loadedIndexes: Array<number>;
|
||||
private _length: number;
|
||||
private _cache: {};
|
||||
|
||||
constructor(length = 0) {
|
||||
super();
|
||||
|
||||
this._length = length;
|
||||
this._cache = {};
|
||||
|
||||
this._requestedIndexes = [];
|
||||
this._loadedIndexes = [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets or sets length for the virtual array.
|
||||
*/
|
||||
get length(): number {
|
||||
return this._length;
|
||||
}
|
||||
set length(value: number) {
|
||||
if (this._length !== value) {
|
||||
const index = this._length;
|
||||
const count = value - this._length;
|
||||
|
||||
this._length = value;
|
||||
|
||||
this.notify({
|
||||
eventName: ChangeType.Change,
|
||||
object: this,
|
||||
action: count > 0 ? ChangeType.Add : ChangeType.Delete,
|
||||
index: index,
|
||||
removed: new Array(count < 0 ? Math.abs(count) : 0),
|
||||
addedCount: count > 0 ? count : 0,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets or sets load size for the virtual array.
|
||||
*/
|
||||
private _loadSize: number;
|
||||
get loadSize(): number {
|
||||
return this._loadSize;
|
||||
}
|
||||
set loadSize(value: number) {
|
||||
this._loadSize = value;
|
||||
}
|
||||
|
||||
getItem(index: number): T {
|
||||
const item = this._cache[index];
|
||||
|
||||
if (item === undefined) {
|
||||
if (
|
||||
index >= 0 &&
|
||||
index < this.length &&
|
||||
this._requestedIndexes.indexOf(index) < 0 &&
|
||||
this._loadedIndexes.indexOf(index) < 0
|
||||
) {
|
||||
this.requestItems(index);
|
||||
}
|
||||
}
|
||||
|
||||
return item;
|
||||
}
|
||||
|
||||
setItem(index: number, value: T) {
|
||||
if (this._cache[index] !== value) {
|
||||
this.load(index, [value]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads items from an array starting at index.
|
||||
*/
|
||||
load(index: number, items: T[]): void {
|
||||
for (let i = 0; i < items.length; i++) {
|
||||
const itemIndex = index + i;
|
||||
|
||||
this._cache[itemIndex] = items[i];
|
||||
|
||||
this._requestedIndexes.splice(
|
||||
this._requestedIndexes.indexOf(itemIndex),
|
||||
1
|
||||
);
|
||||
|
||||
if (this._loadedIndexes.indexOf(itemIndex) < 0) {
|
||||
this._loadedIndexes.push(itemIndex);
|
||||
}
|
||||
}
|
||||
|
||||
// Remove requested but never loaded indexes.
|
||||
if (this._requestedIndexes.length > 0) {
|
||||
for (let i = 0; i < this.loadSize - items.length; i++) {
|
||||
this._requestedIndexes.splice(
|
||||
this._requestedIndexes.indexOf(index + i),
|
||||
1
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
this.notify({
|
||||
eventName: ChangeType.Change,
|
||||
object: this,
|
||||
action: ChangeType.Update,
|
||||
index: index,
|
||||
removed: new Array(items.length),
|
||||
addedCount: items.length,
|
||||
});
|
||||
}
|
||||
|
||||
private requestItems(index: number): void {
|
||||
const indexesToLoad = [];
|
||||
|
||||
const pageIndex =
|
||||
this._loadSize > 0
|
||||
? this._loadSize * Math.floor(index / this._loadSize)
|
||||
: index;
|
||||
let count = 0;
|
||||
let start = -1;
|
||||
|
||||
for (let i = 0; i < this.loadSize; i++) {
|
||||
const itemIndex = pageIndex + i;
|
||||
|
||||
if (itemIndex >= this._length) {
|
||||
break;
|
||||
}
|
||||
|
||||
if (this._loadedIndexes.indexOf(itemIndex) < 0) {
|
||||
if (start < 0) {
|
||||
start = itemIndex;
|
||||
}
|
||||
|
||||
indexesToLoad.push(itemIndex);
|
||||
|
||||
if (this._requestedIndexes.indexOf(itemIndex) < 0) {
|
||||
this._requestedIndexes.push(itemIndex);
|
||||
}
|
||||
|
||||
count++;
|
||||
} else {
|
||||
if (count > 0) {
|
||||
this.notify({
|
||||
eventName: VirtualArray.itemsLoadingEvent,
|
||||
object: this,
|
||||
index: start,
|
||||
count: count,
|
||||
});
|
||||
}
|
||||
|
||||
start = -1;
|
||||
count = 0;
|
||||
}
|
||||
}
|
||||
|
||||
if (start >= 0 && count > 0) {
|
||||
this.notify({
|
||||
eventName: VirtualArray.itemsLoadingEvent,
|
||||
object: this,
|
||||
index: start,
|
||||
count: count,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
export interface VirtualArray<T> {
|
||||
/**
|
||||
* 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
|
||||
): void;
|
||||
/**
|
||||
* Raised when still not loaded items are requested.
|
||||
*/
|
||||
on(
|
||||
event: "itemsLoading",
|
||||
callback: (args: ItemsLoading) => void,
|
||||
thisArg?: any
|
||||
): void;
|
||||
/**
|
||||
* Raised when a change occurs.
|
||||
*/
|
||||
on(
|
||||
event: "change",
|
||||
callback: (args: ChangedData<T>) => void,
|
||||
thisArg?: any
|
||||
): void;
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"name": "virtual-array",
|
||||
"types": "virtual-array.d.ts",
|
||||
"main": "virtual-array"
|
||||
}
|
||||
@@ -1,77 +0,0 @@
|
||||
import { Observable, EventData } from "../observable";
|
||||
import { ObservableArray, 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;
|
||||
}
|
||||
@@ -1,165 +0,0 @@
|
||||
import { Observable, EventData } from "../observable";
|
||||
import * as virtualArrayDef from ".";
|
||||
|
||||
const CHANGE = "change";
|
||||
const UPDATE = "update";
|
||||
const DELETE = "delete";
|
||||
const ADD = "add";
|
||||
|
||||
export class ChangeType implements virtualArrayDef.ChangeType {
|
||||
static Add = ADD;
|
||||
static Delete = DELETE;
|
||||
static Update = UPDATE;
|
||||
static Splice = CHANGE;
|
||||
}
|
||||
|
||||
export class VirtualArray<T> extends Observable implements virtualArrayDef.VirtualArray<T> {
|
||||
public static changeEvent = CHANGE;
|
||||
public static itemsLoadingEvent = "itemsLoading";
|
||||
|
||||
private _requestedIndexes: Array<number>;
|
||||
private _loadedIndexes: Array<number>;
|
||||
private _length: number;
|
||||
private _cache: {};
|
||||
|
||||
constructor(length = 0) {
|
||||
super();
|
||||
|
||||
this._length = length;
|
||||
this._cache = {};
|
||||
|
||||
this._requestedIndexes = [];
|
||||
this._loadedIndexes = [];
|
||||
}
|
||||
|
||||
get length(): number {
|
||||
return this._length;
|
||||
}
|
||||
set length(value: number) {
|
||||
if (this._length !== value) {
|
||||
|
||||
const index = this._length;
|
||||
const count = value - this._length;
|
||||
|
||||
this._length = value;
|
||||
|
||||
this.notify({
|
||||
eventName: CHANGE, object: this,
|
||||
action: count > 0 ? ADD : DELETE,
|
||||
index: index,
|
||||
removed: new Array(count < 0 ? Math.abs(count) : 0),
|
||||
addedCount: count > 0 ? count : 0
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
private _loadSize: number;
|
||||
get loadSize(): number {
|
||||
return this._loadSize;
|
||||
}
|
||||
set loadSize(value: number) {
|
||||
this._loadSize = value;
|
||||
}
|
||||
|
||||
getItem(index: number): T {
|
||||
const item = this._cache[index];
|
||||
|
||||
if (item === undefined) {
|
||||
if (index >= 0 && index < this.length && this._requestedIndexes.indexOf(index) < 0 && this._loadedIndexes.indexOf(index) < 0) {
|
||||
this.requestItems(index);
|
||||
}
|
||||
}
|
||||
|
||||
return item;
|
||||
}
|
||||
|
||||
setItem(index: number, value: T) {
|
||||
if (this._cache[index] !== value) {
|
||||
this.load(index, [value]);
|
||||
}
|
||||
}
|
||||
|
||||
load(index: number, items: T[]): void {
|
||||
for (let i = 0; i < items.length; i++) {
|
||||
|
||||
const itemIndex = index + i;
|
||||
|
||||
this._cache[itemIndex] = items[i];
|
||||
|
||||
this._requestedIndexes.splice(this._requestedIndexes.indexOf(itemIndex), 1);
|
||||
|
||||
if (this._loadedIndexes.indexOf(itemIndex) < 0) {
|
||||
this._loadedIndexes.push(itemIndex);
|
||||
}
|
||||
}
|
||||
|
||||
// Remove requested but never loaded indexes.
|
||||
if (this._requestedIndexes.length > 0) {
|
||||
for (let i = 0; i < this.loadSize - items.length; i++) {
|
||||
this._requestedIndexes.splice(this._requestedIndexes.indexOf(index + i), 1);
|
||||
}
|
||||
}
|
||||
|
||||
this.notify({
|
||||
eventName: CHANGE, object: this,
|
||||
action: UPDATE,
|
||||
index: index,
|
||||
removed: new Array(items.length),
|
||||
addedCount: items.length
|
||||
});
|
||||
}
|
||||
|
||||
private requestItems(index: number): void {
|
||||
const indexesToLoad = [];
|
||||
|
||||
const pageIndex = this._loadSize > 0 ? this._loadSize * Math.floor(index / this._loadSize) : index;
|
||||
let count = 0;
|
||||
let start = -1;
|
||||
|
||||
for (let i = 0; i < this.loadSize; i++) {
|
||||
const itemIndex = pageIndex + i;
|
||||
|
||||
if (itemIndex >= this._length) {
|
||||
break;
|
||||
}
|
||||
|
||||
if (this._loadedIndexes.indexOf(itemIndex) < 0) {
|
||||
if (start < 0) {
|
||||
start = itemIndex;
|
||||
}
|
||||
|
||||
indexesToLoad.push(itemIndex);
|
||||
|
||||
if (this._requestedIndexes.indexOf(itemIndex) < 0) {
|
||||
this._requestedIndexes.push(itemIndex);
|
||||
}
|
||||
|
||||
count++;
|
||||
} else {
|
||||
if (count > 0) {
|
||||
this.notify({
|
||||
eventName: VirtualArray.itemsLoadingEvent, object: this,
|
||||
index: start,
|
||||
count: count
|
||||
});
|
||||
}
|
||||
|
||||
start = -1;
|
||||
count = 0;
|
||||
}
|
||||
}
|
||||
|
||||
if (start >= 0 && count > 0) {
|
||||
this.notify({
|
||||
eventName: VirtualArray.itemsLoadingEvent, object: this,
|
||||
index: start,
|
||||
count: count
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
export interface VirtualArray<T> {
|
||||
on(eventNames: string, callback: (data: EventData) => void, thisArg?: any);
|
||||
on(event: "itemsLoading", callback: (args: virtualArrayDef.ItemsLoading) => void, thisArg?: any);
|
||||
on(event: "change", callback: (args: virtualArrayDef.ChangedData<T>) => void, thisArg?: any);
|
||||
}
|
||||
Reference in New Issue
Block a user