9.0 Released! → Native ESM runtimes 🚀, Vite support ⚡️, multi-window apps and more...
Read Announcement

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

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

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

Parameters

ParameterType
length?number

Returns

VirtualArray<T>

Overrides

Observable.constructor

Properties

changeEvent

ts
static changeEvent: string;

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

String value used when hooking to change event.


itemsLoadingEvent

ts
static itemsLoadingEvent: string;

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

String value used when hooking to itemsLoading event.


propertyChangeEvent

ts
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

ts
get length(): number;

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

Gets or sets length for the virtual array.

Returns

number

Set Signature

ts
set length(value: number): void;

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

Parameters
ParameterType
valuenumber
Returns

void


loadSize

Get Signature

ts
get loadSize(): number;

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

Returns

number

Set Signature

ts
set loadSize(value: number): void;

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

Parameters
ParameterType
valuenumber
Returns

void

Methods

_createPropertyChangeData()

ts
_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

ParameterType
propertyNamestring
valueany
oldValue?any

Returns

PropertyChangeData

Inherited from

Observable._createPropertyChangeData


_emit()

ts
_emit(eventName: string): void;

Defined in: data/observable/index.ts

Parameters

ParameterType
eventNamestring

Returns

void

Inherited from

Observable._emit


addEventListener()

ts
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

ParameterTypeDescription
eventNamestringName of the event to attach to.
callback(data: EventData) => voidA function to be called when some of the specified event(s) is raised.
thisArg?anyAn optional parameter which when set will be used as "this" in callback method call.
once?booleanAn optional parameter which when set will cause the event listener to fire once.

Returns

void

Inherited from

Observable.addEventListener


get()

ts
get(name: string): any;

Defined in: data/observable/index.ts

Gets the value of the specified property.

Parameters

ParameterType
namestring

Returns

any

Inherited from

Observable.get


getItem()

ts
getItem(index: number): T;

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

Parameters

ParameterType
indexnumber

Returns

T


hasListeners()

ts
hasListeners(eventName: string): boolean;

Defined in: data/observable/index.ts

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

Parameters

ParameterTypeDescription
eventNamestringThe name of the event to check for.

Returns

boolean

Inherited from

Observable.hasListeners


load()

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

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

Loads items from an array starting at index.

Parameters

ParameterType
indexnumber
itemsT[]

Returns

void


notify()

ts
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

ParameterTypeDescription
dataTan 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()

ts
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

ParameterType
namestring
valueany
oldValue?any

Returns

void

Inherited from

Observable.notifyPropertyChange


off()

ts
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

ParameterTypeDescription
eventNamestringThe name of the event.
callback?(data: EventData) => voidAn optional specific event listener to remove (if omitted, all event listeners by this name will be removed).
thisArg?anyAn 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

ts
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
ParameterTypeDescription
eventNamestringThe name of the event.
callback(data: EventData) => voidThe event listener to add. Will be called when an event of the given name is raised.
thisArg?anyAn 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

ts
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
ParameterType
event"itemsLoading"
callback(args: ItemsLoading) => void
thisArg?any
Returns

void

Inherited from
ts
Observable.on

Call Signature

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

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

Raised when a change occurs.

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

void

Inherited from
ts
Observable.on

once()

ts
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

ParameterTypeDescription
eventNamestringThe name of the event.
callback(data: EventData) => voidThe event listener to add. Will be called when an event of the given name is raised.
thisArg?anyAn 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()

ts
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

ParameterTypeDescription
eventNamestringName of the event to attach to.
callback?(data: EventData) => voidAn optional parameter pointing to a specific listener. If not defined, all listeners for the event names will be removed.
thisArg?anyAn 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()

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

Defined in: data/observable/index.ts

Updates the specified property with the provided value.

Parameters

ParameterType
namestring
valueany

Returns

void

Inherited from

Observable.set


setItem()

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

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

Parameters

ParameterType
indexnumber
valueT

Returns

void


setProperty()

ts
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

ParameterType
namestring
valueany

Returns

void

Inherited from

Observable.setProperty


addEventListener()

ts
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

ParameterType
eventNamestring
callback(data: EventData) => void
thisArg?any
once?boolean

Returns

void

Deprecated

Inherited from

Observable.addEventListener


off()

ts
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

ParameterType
eventNamestring
callback?(data: EventData) => void
thisArg?any

Returns

void

Deprecated

Inherited from

Observable.off


on()

ts
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

ParameterType
eventNamestring
callback(data: EventData) => void
thisArg?any
once?boolean

Returns

void

Deprecated

Inherited from

Observable.on


once()

ts
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

ParameterType
eventNamestring
callback(data: EventData) => void
thisArg?any

Returns

void

Deprecated

Inherited from

Observable.once


removeEventListener()

ts
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

ParameterType
eventNamestring
callback?(data: EventData) => void
thisArg?any

Returns

void

Deprecated

Inherited from

Observable.removeEventListener

Previous
ViewHelper