Class Pager

Hierarchy

  • PagerBase
    • Pager

Constructors

constructor

Properties

_childrenCount _childrenViews _defaultTemplate _effectiveItemHeight _effectiveItemWidth _itemTemplatesInternal _itemViewLoader android autoPlay autoPlayDelay cache canGoLeft canGoRight circularMode disableAnimation disableSwipe indicator ios items itemTemplate itemTemplates loadMoreCount mObservableArrayInstance orientation peaking perPage preserveIndexOnItemsChange selectedIndex spacing transformers itemDisposingEvent itemLoadingEvent knownFunctions loadMoreItemsEvent mRegisteredTransformers scrollEvent selectedIndexChangeEvent swipeEndEvent swipeEvent swipeOverEvent swipeStartEvent

Accessors

itemIdGenerator itemTemplateSelector itemViewLoader padding paddingBottom paddingLeft paddingRight paddingTop

Methods

_addChildFromBuilder _addChildView _getDataItem _getDefaultItemContent _getItemTemplate _getItemTemplateKey _observableArrayHandler _onItemsChanged _prepareItem _removeChildView _removeView convertToSize disposeNativeView eachChildView getChildView getViewForItemAtIndex itemTemplateUpdated onItemViewLoaderChanged onLayout refresh refreshVisibleItems requestLayout scrollToIndexAnimated setIndicator setObservableArrayInstance updateNativeIndex updateNativeItems registerTransformer

Constructors

constructor

  • new Pager(): Pager

  • Returns Pager

Properties

Abstract Readonly_childrenCount

_childrenCount: number

_childrenViews

_childrenViews: { type: number; view: PagerItem }[]

_defaultTemplate

_defaultTemplate: KeyedTemplate

Protected_effectiveItemHeight

_effectiveItemHeight: number

Protected_effectiveItemWidth

_effectiveItemWidth: number

_itemTemplatesInternal

_itemTemplatesInternal: KeyedTemplate[]

_itemViewLoader

_itemViewLoader: Function

Readonlyandroid

android: any

Gets the android-specific native instance that lies behind this proxy. Will be available if running on an Android platform.

autoPlay

autoPlay: boolean

autoPlayDelay

autoPlayDelay: number

cache

cache: boolean

canGoLeft

canGoLeft: boolean

canGoRight

canGoRight: boolean

circularMode

circularMode: boolean

disableAnimation

disableAnimation: boolean

disableSwipe

disableSwipe: boolean

indicator

indicator: {
    getCount(): number;
    getSelection(): number;
    setCount(count: number): any;
    setInteractiveAnimation(animated?: boolean): any;
    setProgress(position: number, progress: number): any;
    setSelection(index: number, animated?: boolean): any;
    withoutAnimation(callback: Function): any;
}

Readonlyios

ios: any

Gets the ios-specific native instance that lies behind this proxy. Will be available if running on an iOS platform.

items

items: any[] | ItemsSource

itemTemplate

itemTemplate: string | Template

itemTemplates

itemTemplates: string | KeyedTemplate[]

loadMoreCount

loadMoreCount: number

ProtectedmObservableArrayInstance

mObservableArrayInstance: ObservableArray<any>

orientation

orientation: Orientation

peaking

peaking: PercentLengthType

perPage

perPage: number

preserveIndexOnItemsChange

preserveIndexOnItemsChange: boolean

selectedIndex

selectedIndex: number

spacing

spacing: PercentLengthType

transformers

transformers: string

StaticitemDisposingEvent

itemDisposingEvent: string

StaticitemLoadingEvent

itemLoadingEvent: string

StaticknownFunctions

knownFunctions: string[]

StaticloadMoreItemsEvent

loadMoreItemsEvent: string

StaticmRegisteredTransformers

mRegisteredTransformers: {}

StaticscrollEvent

scrollEvent: string

StaticselectedIndexChangeEvent

selectedIndexChangeEvent: string

StaticswipeEndEvent

swipeEndEvent: string

StaticswipeEvent

swipeEvent: string

StaticswipeOverEvent

swipeOverEvent: string

StaticswipeStartEvent

swipeStartEvent: string

Accessors

itemIdGenerator

  • get itemIdGenerator(): (item: any, index: number, items: any) => number

  • Returns (item: any, index: number, items: any) => number

  • set itemIdGenerator(
        generatorFn: (item: any, index: number, items: any) => number,
    ): void

  • Parameters

    • generatorFn: (item: any, index: number, items: any) => number

    Returns void

itemTemplateSelector

  • get itemTemplateSelector(): | string
    | (item: any, index: number, items: any) => string

  • Returns string | (item: any, index: number, items: any) => string

  • set itemTemplateSelector(
        value: string | (item: any, index: number, items: any) => string,
    ): void

  • Parameters

    • value: string | (item: any, index: number, items: any) => string

    Returns void

itemViewLoader

  • get itemViewLoader(): Function

  • Returns Function

  • set itemViewLoader(value: Function): void

  • Parameters

    • value: Function

    Returns void

padding

  • get padding(): string | number | LengthDipUnit | LengthPxUnit

  • Returns string | number | LengthDipUnit | LengthPxUnit

  • set padding(value: string | number | LengthDipUnit | LengthPxUnit): void

  • Parameters

    • value: string | number | LengthDipUnit | LengthPxUnit

    Returns void

paddingBottom

  • get paddingBottom(): LengthType

  • Returns LengthType

  • set paddingBottom(value: LengthType): void

  • Parameters

    • value: LengthType

    Returns void

paddingLeft

  • get paddingLeft(): LengthType

  • Returns LengthType

  • set paddingLeft(value: LengthType): void

  • Parameters

    • value: LengthType

    Returns void

paddingRight

  • get paddingRight(): LengthType

  • Returns LengthType

  • set paddingRight(value: LengthType): void

  • Parameters

    • value: LengthType

    Returns void

paddingTop

  • get paddingTop(): LengthType

  • Returns LengthType

  • set paddingTop(value: LengthType): void

  • Parameters

    • value: LengthType

    Returns void

Methods

_addChildFromBuilder

  • _addChildFromBuilder(name: string, value: any): void

  • Parameters

    • name: string
    • value: any

    Returns void

Protected_addChildView

  • _addChildView(view: any, type: any): void

  • Parameters

    • view: any
    • type: any

    Returns void

_getDataItem

  • _getDataItem(index: number): any

  • Parameters

    • index: number

    Returns any

_getDefaultItemContent

  • _getDefaultItemContent(index: number): View

  • Parameters

    • index: number

    Returns View

_getItemTemplate

  • _getItemTemplate(index: number): KeyedTemplate

  • Parameters

    • index: number

    Returns KeyedTemplate

_getItemTemplateKey

  • _getItemTemplateKey(index: number): string

  • Parameters

    • index: number

    Returns string

Protected Abstract_observableArrayHandler

  • _observableArrayHandler(arg: any): void

  • Parameters

    • arg: any

    Returns void

_onItemsChanged

  • _onItemsChanged(oldValue: any, newValue: any): any

  • Parameters

    • oldValue: any
    • newValue: any

    Returns any

_prepareItem

  • _prepareItem(item: View, index: number): void

  • Parameters

    • item: View
    • index: number

    Returns void

Protected_removeChildView

  • _removeChildView(index: number): void

  • Parameters

    • index: number

    Returns void

_removeView

  • _removeView(view: ViewBase): void

  • Core logic for removing a child view from this instance. Used by the framework to handle lifecycle events more centralized. Do not use outside the UI Stack implementation.

    Parameters

    • view: ViewBase

    Returns void

convertToSize

  • convertToSize(length: any): number

  • Parameters

    • length: any

    Returns number

disposeNativeView

  • disposeNativeView(): void

  • Clean up references to the native view.

    Returns void

eachChildView

  • eachChildView(callback: (child: View) => boolean): void

  • Iterates over children of type View.

    Parameters

    • callback: (child: View) => boolean

      Called for each child of type View. Iteration stops if this method returns falsy value.

    Returns void

getChildView

  • getChildView(index: number): View

  • Parameters

    • index: number

    Returns View

getViewForItemAtIndex

  • getViewForItemAtIndex(index: number): View

  • Parameters

    • index: number

    Returns View

itemTemplateUpdated

  • itemTemplateUpdated(oldData: any, newData: any): void

  • Parameters

    • oldData: any
    • newData: any

    Returns void

onItemViewLoaderChanged

  • onItemViewLoaderChanged(): void

  • Returns void

onLayout

  • onLayout(left: number, top: number, right: number, bottom: number): void

  • Called from layout when this view should assign a size and position to each of its children. Derived classes with children should override this method and call layout on each of their children.

    Parameters

    • left: number

      Left position, relative to parent

    • top: number

      Top position, relative to parent

    • right: number

      Right position, relative to parent

    • bottom: number

      Bottom position, relative to parent

    Returns void

refresh

  • refresh(): void

  • Returns void

refreshVisibleItems

  • refreshVisibleItems(): void

  • Returns void

requestLayout

  • requestLayout(): void

  • Returns void

scrollToIndexAnimated

  • scrollToIndexAnimated(
        index: number,
        animate: boolean,
        requestTransform?: boolean,
    ): void

  • Parameters

    • index: number
    • animate: boolean
    • OptionalrequestTransform: boolean

    Returns void

setIndicator

  • setIndicator(indicator: any): void

  • Parameters

    • indicator: any

    Returns void

setObservableArrayInstance

  • setObservableArrayInstance(value: any): void

  • Parameters

    • value: any

    Returns void

updateNativeIndex

  • updateNativeIndex(oldIndex: number, newIndex: number): void

  • Parameters

    • oldIndex: number
    • newIndex: number

    Returns void

updateNativeItems

  • updateNativeItems(oldItems: View[], newItems: View[]): void

  • Parameters

    • oldItems: View[]
    • newItems: View[]

    Returns void

StaticregisterTransformer

  • registerTransformer(key: string, transformer: any): void

  • Parameters

    • key: string
    • transformer: any

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods