Skip to content

VirtualArray.md

Latest commit

 

History

History
844 lines (530 loc) · 17.7 KB

VirtualArray.md

File metadata and controls

844 lines (530 loc) · 17.7 KB
Raw
title VirtualArray
titleTemplate title - API / NativeScript
description Advanced array like class that helps loading items on demand.
contributors false

Defined in: data/virtual-array/index.ts

Advanced array like class that helps loading items on demand.

Extends

Type Parameters

Type Parameter
T

Constructors

Constructor

new VirtualArray<T>(length?: number): VirtualArray<T>;

Defined in: data/virtual-array/index.ts

Parameters

Parameter Type
length? number

Returns

VirtualArray<T>

Overrides

Observable.constructor

Properties

changeEvent

static changeEvent: string;

Defined in: data/virtual-array/index.ts

String value used when hooking to change event.

itemsLoadingEvent

static itemsLoadingEvent: string;

Defined in: data/virtual-array/index.ts

String value used when hooking to itemsLoading event.

propertyChangeEvent

static propertyChangeEvent: string;

Defined in: data/observable/index.ts

String value used when hooking to propertyChange event.

Ns Event

propertyChange

Inherited from

Observable.propertyChangeEvent

Accessors

length

Get Signature

get length(): number;

Defined in: data/virtual-array/index.ts

Gets or sets length for the virtual array.

Returns

number

Set Signature

set length(value: number): void;

Defined in: data/virtual-array/index.ts

Parameters
Parameter Type
value number
Returns

void

loadSize

Get Signature

get loadSize(): number;

Defined in: data/virtual-array/index.ts

Returns

number

Set Signature

set loadSize(value: number): void;

Defined in: data/virtual-array/index.ts

Parameters
Parameter Type
value number
Returns

void

Methods

_createPropertyChangeData()

_createPropertyChangeData(
   propertyName: string, 
   value: any, 
   oldValue?: any): PropertyChangeData;

Defined in: data/observable/index.ts

This method is intended to be overriden by inheritors to provide additional implementation.

Parameters

Parameter Type
propertyName string
value any
oldValue? any

Returns

PropertyChangeData

Inherited from

Observable._createPropertyChangeData

_emit()

_emit(eventName: string): void;

Defined in: data/observable/index.ts

Parameters

Parameter Type
eventName string

Returns

void

Inherited from

Observable._emit

addEventListener()

addEventListener(
   eventName: string, 
   callback: (data: EventData) => void, 
   thisArg?: any, 
   once?: boolean): void;

Defined in: data/observable/index.ts

Adds a listener for the specified event name.

Parameters

Parameter Type Description
eventName string Name of the event to attach to.
callback (data: EventData) => void A function to be called when some of the specified event(s) is raised.
thisArg? any An optional parameter which when set will be used as "this" in callback method call.
once? boolean An optional parameter which when set will cause the event listener to fire once.

Returns

void

Inherited from

Observable.addEventListener

get()

get(name: string): any;

Defined in: data/observable/index.ts

Gets the value of the specified property.

Parameters

Parameter Type
name string

Returns

any

Inherited from

Observable.get

getItem()

getItem(index: number): T;

Defined in: data/virtual-array/index.ts

Parameters

Parameter Type
index number

Returns

T

hasListeners()

hasListeners(eventName: string): boolean;

Defined in: data/observable/index.ts

Checks whether a listener is registered for the specified event name.

Parameters

Parameter Type Description
eventName string The name of the event to check for.

Returns

boolean

Inherited from

Observable.hasListeners

load()

load(index: number, items: T[]): void;

Defined in: data/virtual-array/index.ts

Loads items from an array starting at index.

Parameters

Parameter Type
index number
items T[]

Returns

void

notify()

notify<T>(data: T): void;

Defined in: data/observable/index.ts

Notify this Observable instance with some data. This causes all event handlers on the Observable instance to be called, as well as any 'global' event handlers set on the instance's class.

Type Parameters

Type Parameter
T extends Optional<EventData, "object">

Parameters

Parameter Type Description
data T an object that satisfies the EventData interface, though with an optional 'object' property. If left undefined, the 'object' property will implicitly be set as this Observable instance.

Returns

void

Inherited from

Observable.notify

notifyPropertyChange()

notifyPropertyChange(
   name: string, 
   value: any, 
   oldValue?: any): void;

Defined in: data/observable/index.ts

Notifies all the registered listeners for the property change event.

Parameters

Parameter Type
name string
value any
oldValue? any

Returns

void

Inherited from

Observable.notifyPropertyChange

off()

off(
   eventName: string, 
   callback?: (data: EventData) => void, 
   thisArg?: any): void;

Defined in: data/observable/index.ts

Removes the listener(s) for the specified event name.

Parameters

Parameter Type Description
eventName string The name of the event.
callback? (data: EventData) => void An optional specific event listener to remove (if omitted, all event listeners by this name will be removed).
thisArg? any An optional parameter which, when set, will be used to refine search of the correct event listener to be removed.

Returns

void

Inherited from

Observable.off

on()

Call Signature

on(
   eventName: string, 
   callback: (data: EventData) => void, 
   thisArg?: any): void;

Defined in: data/virtual-array/index.ts

Adds a listener for the specified event name.

Parameters
Parameter Type Description
eventName string The name of the event.
callback (data: EventData) => void The event listener to add. Will be called when an event of the given name is raised.
thisArg? any 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.
Returns

void

Inherited from

Observable.on

Call Signature

on(
   event: "itemsLoading", 
   callback: (args: ItemsLoading) => void, 
   thisArg?: any): void;

Defined in: data/virtual-array/index.ts

Raised when still not loaded items are requested.

Parameters
Parameter Type
event "itemsLoading"
callback (args: ItemsLoading) => void
thisArg? any
Returns

void

Inherited from
Observable.on

Call Signature

on(
   event: "change", 
   callback: (args: ChangedData<T>) => void, 
   thisArg?: any): void;

Defined in: data/virtual-array/index.ts

Raised when a change occurs.

Parameters
Parameter Type
event "change"
callback (args: ChangedData<T>) => void
thisArg? any
Returns

void

Inherited from
Observable.on

once()

once(
   eventName: string, 
   callback: (data: EventData) => void, 
   thisArg?: any): void;

Defined in: data/observable/index.ts

Adds a listener for the specified event name, which, once fired, will remove itself.

Parameters

Parameter Type Description
eventName string The name of the event.
callback (data: EventData) => void The event listener to add. Will be called when an event of the given name is raised.
thisArg? any 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.

Returns

void

Inherited from

Observable.once

removeEventListener()

removeEventListener(
   eventName: string, 
   callback?: (data: EventData) => void, 
   thisArg?: any): void;

Defined in: data/observable/index.ts

Removes listener(s) for the specified event name.

Parameters

Parameter Type Description
eventName string Name of the event to attach to.
callback? (data: EventData) => void An optional parameter pointing to a specific listener. If not defined, all listeners for the event names will be removed.
thisArg? any An optional parameter which when set will be used to refine search of the correct callback which will be removed as event listener.

Returns

void

Inherited from

Observable.removeEventListener

set()

set(name: string, value: any): void;

Defined in: data/observable/index.ts

Updates the specified property with the provided value.

Parameters

Parameter Type
name string
value any

Returns

void

Inherited from

Observable.set

setItem()

setItem(index: number, value: T): void;

Defined in: data/virtual-array/index.ts

Parameters

Parameter Type
index number
value T

Returns

void

setProperty()

setProperty(name: string, value: any): void;

Defined in: data/observable/index.ts

Updates the specified property with the provided value and raises a property change event and a specific change event based on the property name.

Parameters

Parameter Type
name string
value any

Returns

void

Inherited from

Observable.setProperty

addEventListener()

static addEventListener(
   eventName: string, 
   callback: (data: EventData) => void, 
   thisArg?: any, 
   once?: boolean): void;

Defined in: data/observable/index.ts

Please avoid using the static event-handling APIs as they will be removed in future.

Parameters

Parameter Type
eventName string
callback (data: EventData) => void
thisArg? any
once? boolean

Returns

void

Deprecated

Inherited from

Observable.addEventListener

off()

static off(
   eventName: string, 
   callback?: (data: EventData) => void, 
   thisArg?: any): void;

Defined in: data/observable/index.ts

Please avoid using the static event-handling APIs as they will be removed in future.

Parameters

Parameter Type
eventName string
callback? (data: EventData) => void
thisArg? any

Returns

void

Deprecated

Inherited from

Observable.off

on()

static on(
   eventName: string, 
   callback: (data: EventData) => void, 
   thisArg?: any, 
   once?: boolean): void;

Defined in: data/observable/index.ts

Please avoid using the static event-handling APIs as they will be removed in future.

Parameters

Parameter Type
eventName string
callback (data: EventData) => void
thisArg? any
once? boolean

Returns

void

Deprecated

Inherited from

Observable.on

once()

static once(
   eventName: string, 
   callback: (data: EventData) => void, 
   thisArg?: any): void;

Defined in: data/observable/index.ts

Please avoid using the static event-handling APIs as they will be removed in future.

Parameters

Parameter Type
eventName string
callback (data: EventData) => void
thisArg? any

Returns

void

Deprecated

Inherited from

Observable.once

removeEventListener()

static removeEventListener(
   eventName: string, 
   callback?: (data: EventData) => void, 
   thisArg?: any): void;

Defined in: data/observable/index.ts

Please avoid using the static event-handling APIs as they will be removed in future.

Parameters

Parameter Type
eventName string
callback? (data: EventData) => void
thisArg? any

Returns

void

Deprecated

Inherited from

Observable.removeEventListener