Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LiveAsyncRepeatDirective<T>

Type parameters

  • T

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

canMergeWith

  • canMergeWith(_data: null | Iterable<T>, templateFn: TemplateFn<T>): boolean

emit

  • emit<K>(name: K, ...args: any[]): void

  • Emit specified event with event name and parameters.

    Type parameters

    • K: "liveDataUpdated" | "liveDataRendered"

    Parameters

    • name: K

      The event name.

    • Rest ...args: any[]

      The parameters that will be passed to event listeners.

    Returns void

getFirstVisibleIndex

  • getFirstVisibleIndex(): number

getItem

  • getItem(index: number): null | T

getRenderedItem

  • getRenderedItem(index: number): null | T

getStartIndex

  • getStartIndex(): number

hasListener

  • hasListener(name: string, listener: Function, scope?: object): boolean

  • Check whether listener is in the list for listening specified event name.

    Parameters

    • name: string

      The event name.

    • listener: Function

      The event listener to check.

    • Optional scope: object

      The scope binded to listener. If provided, will additionally check whether the scope match.

    Returns boolean

hasListeners

  • hasListeners(name: string): boolean

  • Check whether any listener is listening specified event name.

    Parameters

    • name: string

      The event name.

    Returns boolean

merge

notifyAdded

  • notifyAdded(index: number, count?: number): void

  • When async items added at index, we need to adjust scrolling position and data count immediately, and may add null item as placeholders for the added items. Such that you will feel no delay after the add or delete operation. After data loaded, new render result should be the same.

    Parameters

    • index: number
    • count: number = 1

    Returns void

notifyDeleted

  • notifyDeleted(index: number, count?: number): void

off

  • off<K>(name: K, listener: EventHandler, scope?: object): void

  • Removes the listener that is listening specified event name.

    Type parameters

    • K: "liveDataUpdated" | "liveDataRendered"

    Parameters

    • name: K

      The event name.

    • listener: EventHandler

      The event listener, only matched listener will be removed.

    • Optional scope: object

      The scope binded to listener. If provided, remove listener only when scope match.

    Returns void

on

  • on<K>(name: K, listener: EventHandler, scope?: object): void

  • Registers an event listener to listen event with specified name.

    Type parameters

    • K: "liveDataUpdated" | "liveDataRendered"

    Parameters

    • name: K

      The event name.

    • listener: EventHandler

      The event listener.

    • Optional scope: object

      The scope will be binded to listener.

    Returns void

once

  • once<K>(name: K, listener: EventHandler, scope?: object): void

  • Registers an event listener to listen event with specified name, triggers for only once.

    Type parameters

    • K: "liveDataUpdated" | "liveDataRendered"

    Parameters

    • name: K

      The event name.

    • listener: EventHandler

      The event listener.

    • Optional scope: object

      The scope will be binded to listener.

    Returns void

reload

  • reload(): void

remove

  • remove(): void

removeAllListeners

  • removeAllListeners(): void

reset

  • reset(index?: number): void

  • When data changed completely and you want to move to start scroll position, e.g., after data type changed.

    Parameters

    • index: number = 0

      Specified the start index you want to set by setStartIndex.

    Returns void

scrollToViewIndex

  • scrollToViewIndex(index: number): void

setStartIndex

  • setStartIndex(index: number): void

untilFreshRendered

  • untilFreshRendered(): Promise<void>

untilFreshUpdated

  • untilFreshUpdated(): Promise<void>

untilRendered

  • untilRendered(): Promise<void>

untilUpdated

  • untilUpdated(): Promise<void>

Generated using TypeDoc