Class Pager

Hierarchy

PagerBase
- Pager

Index

Constructors

constructor

Accessors

itemIdGenerator itemTemplateSelector itemViewLoader padding paddingBottom paddingLeft paddingRight paddingTop

Constructors

constructor

new Pager(): Pager
Returns Pager
Inherited from PagerBase.constructor
- Defined in node_modules/@nativescript/core/ui/core/view-base/index.d.ts:359

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

`Readonly`android

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;
}

`Readonly`ios

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

`Protected`mObservableArrayInstance

mObservableArrayInstance: ObservableArray<any>

orientation

orientation: Orientation

peaking

peaking: PercentLengthType

perPage

perPage: number

preserveIndexOnItemsChange

preserveIndexOnItemsChange: boolean

selectedIndex

selectedIndex: number

spacing

spacing: PercentLengthType

transformers

transformers: string

`Static`itemDisposingEvent

itemDisposingEvent: string

`Static`itemLoadingEvent

itemLoadingEvent: string

`Static`knownFunctions

knownFunctions: string[]

`Static`loadMoreItemsEvent

loadMoreItemsEvent: string

`Static`mRegisteredTransformers

mRegisteredTransformers: {}

`Static`scrollEvent

scrollEvent: string

`Static`selectedIndexChangeEvent

selectedIndexChangeEvent: string

`Static`swipeEndEvent

swipeEndEvent: string

`Static`swipeEvent

swipeEvent: string

`Static`swipeOverEvent

swipeOverEvent: string

`Static`swipeStartEvent

swipeStartEvent: string

Accessors

itemIdGenerator

get itemIdGenerator(): (item: any, index: number, items: any) => number
Returns (item: any, index: number, items: any) => number
Inherited from PagerBase.itemIdGenerator
- Defined in packages/ui-pager/index.common.d.ts:99
set itemIdGenerator(
generatorFn: (item: any, index: number, items: any) => number,
): void
Parameters
- generatorFn: (item: any, index: number, items: any) => number
Returns void
Inherited from PagerBase.itemIdGenerator
- Defined in packages/ui-pager/index.common.d.ts:100

itemTemplateSelector

get itemTemplateSelector(): | string
| ((item: any, index: number, items: any) => string)
Returns string | ((item: any, index: number, items: any) => string)
Inherited from PagerBase.itemTemplateSelector
- Defined in packages/ui-pager/index.common.d.ts:101
set itemTemplateSelector(
value: string | ((item: any, index: number, items: any) => string),
): void
Parameters
- value: string | ((item: any, index: number, items: any) => string)
Returns void
Inherited from PagerBase.itemTemplateSelector
- Defined in packages/ui-pager/index.common.d.ts:102

itemViewLoader

get itemViewLoader(): Function
Returns Function
Inherited from PagerBase.itemViewLoader
- Defined in packages/ui-pager/index.common.d.ts:105
set itemViewLoader(value: Function): void
Parameters
- value: Function
Returns void
Inherited from PagerBase.itemViewLoader
- Defined in packages/ui-pager/index.common.d.ts:106

padding

get padding(): string | number | LengthDipUnit | LengthPxUnit
Returns string | number | LengthDipUnit | LengthPxUnit
Inherited from PagerBase.padding
- Defined in packages/ui-pager/index.common.d.ts:64
set padding(value: string | number | LengthDipUnit | LengthPxUnit): void
Parameters
- value: string | number | LengthDipUnit | LengthPxUnit
Returns void
Inherited from PagerBase.padding
- Defined in packages/ui-pager/index.common.d.ts:65

paddingBottom

get paddingBottom(): LengthType
Returns LengthType
Inherited from PagerBase.paddingBottom
- Defined in packages/ui-pager/index.common.d.ts:70
set paddingBottom(value: LengthType): void
Parameters
- value: LengthType
Returns void
Inherited from PagerBase.paddingBottom
- Defined in packages/ui-pager/index.common.d.ts:71

paddingLeft

get paddingLeft(): LengthType
Returns LengthType
Inherited from PagerBase.paddingLeft
- Defined in packages/ui-pager/index.common.d.ts:72
set paddingLeft(value: LengthType): void
Parameters
- value: LengthType
Returns void
Inherited from PagerBase.paddingLeft
- Defined in packages/ui-pager/index.common.d.ts:73

paddingRight

get paddingRight(): LengthType
Returns LengthType
Inherited from PagerBase.paddingRight
- Defined in packages/ui-pager/index.common.d.ts:68
set paddingRight(value: LengthType): void
Parameters
- value: LengthType
Returns void
Inherited from PagerBase.paddingRight
- Defined in packages/ui-pager/index.common.d.ts:69

paddingTop

get paddingTop(): LengthType
Returns LengthType
Inherited from PagerBase.paddingTop
- Defined in packages/ui-pager/index.common.d.ts:66
set paddingTop(value: LengthType): void
Parameters
- value: LengthType
Returns void
Inherited from PagerBase.paddingTop
- Defined in packages/ui-pager/index.common.d.ts:67

Methods

_addChildFromBuilder

_addChildFromBuilder(name: string, value: any): void
Parameters
- name: string
- value: any
Returns void
Overrides PagerBase._addChildFromBuilder
- Defined in packages/ui-pager/index.d.ts:31

`Protected`_addChildView

_addChildView(view: any, type: any): void
Parameters
- view: any
- type: any
Returns void
Inherited from PagerBase._addChildView
- Defined in packages/ui-pager/index.common.d.ts:92

_getDataItem

_getDataItem(index: number): any
Parameters
- index: number
Returns any
Inherited from PagerBase._getDataItem
- Defined in packages/ui-pager/index.common.d.ts:110

_getDefaultItemContent

_getDefaultItemContent(index: number): View
Parameters
- index: number
Returns View
Inherited from PagerBase._getDefaultItemContent
- Defined in packages/ui-pager/index.common.d.ts:111

_getItemTemplate

_getItemTemplate(index: number): KeyedTemplate
Parameters
- index: number
Returns KeyedTemplate
Inherited from PagerBase._getItemTemplate
- Defined in packages/ui-pager/index.common.d.ts:108

_getItemTemplateKey

_getItemTemplateKey(index: number): string
Parameters
- index: number
Returns string
Inherited from PagerBase._getItemTemplateKey
- Defined in packages/ui-pager/index.common.d.ts:107

`Protected` `Abstract`_observableArrayHandler

_observableArrayHandler(arg: any): void
Parameters
- arg: any
Returns void
Inherited from PagerBase._observableArrayHandler
- Defined in packages/ui-pager/index.common.d.ts:87

_onItemsChanged

_onItemsChanged(oldValue: any, newValue: any): any
Parameters
- oldValue: any
- newValue: any
Returns any
- Defined in packages/ui-pager/index.d.ts:33

_prepareItem

_prepareItem(item: View, index: number): void
Parameters
- item: View
- index: number
Returns void
Inherited from PagerBase._prepareItem
- Defined in packages/ui-pager/index.common.d.ts:109

`Protected`_removeChildView

_removeChildView(index: number): void
Parameters
- index: number
Returns void
Inherited from PagerBase._removeChildView
- Defined in packages/ui-pager/index.common.d.ts:91

_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
Inherited from PagerBase._removeView
- Defined in packages/ui-pager/index.common.d.ts:90

convertToSize

convertToSize(length: any): number
Parameters
- length: any
Returns number
Inherited from PagerBase.convertToSize
- Defined in packages/ui-pager/index.common.d.ts:116

disposeNativeView

disposeNativeView(): void
Clean up references to the native view.

Returns void
Inherited from PagerBase.disposeNativeView
- Defined in packages/ui-pager/index.common.d.ts:86

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
Overrides PagerBase.eachChildView
- Defined in packages/ui-pager/index.d.ts:17

getChildView

getChildView(index: number): View
Parameters
- index: number
Returns View
Overrides PagerBase.getChildView
- Defined in packages/ui-pager/index.d.ts:35

getViewForItemAtIndex

getViewForItemAtIndex(index: number): View
Parameters
- index: number
Returns View
- Defined in packages/ui-pager/index.d.ts:36

itemTemplateUpdated

itemTemplateUpdated(oldData: any, newData: any): void
Parameters
- oldData: any
- newData: any
Returns void
Overrides PagerBase.itemTemplateUpdated
- Defined in packages/ui-pager/index.d.ts:10

onItemViewLoaderChanged

onItemViewLoaderChanged(): void
Returns void
Inherited from PagerBase.onItemViewLoaderChanged
- Defined in packages/ui-pager/index.common.d.ts:103

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
Inherited from PagerBase.onLayout
- Defined in packages/ui-pager/index.common.d.ts:115

refresh

refresh(): void
Returns void
Overrides PagerBase.refresh
- Defined in packages/ui-pager/index.d.ts:23

refreshVisibleItems

refreshVisibleItems(): void
Returns void
- Defined in packages/ui-pager/index.d.ts:24

requestLayout

requestLayout(): void
Returns void
Overrides PagerBase.requestLayout
- Defined in packages/ui-pager/index.d.ts:29

scrollToIndexAnimated

scrollToIndexAnimated(
    index: number,
    animate: boolean,
    requestTransform?: boolean,
): void
Parameters
- index: number
- animate: boolean
- OptionalrequestTransform: boolean
Returns void
- Defined in packages/ui-pager/index.d.ts:15

setIndicator

setIndicator(indicator: any): void
Parameters
- indicator: any
Returns void
Inherited from PagerBase.setIndicator
- Defined in packages/ui-pager/index.common.d.ts:85

setObservableArrayInstance

setObservableArrayInstance(value: any): void
Parameters
- value: any
Returns void
Inherited from PagerBase.setObservableArrayInstance
- Defined in packages/ui-pager/index.common.d.ts:88

updateNativeIndex

updateNativeIndex(oldIndex: number, newIndex: number): void
Parameters
- oldIndex: number
- newIndex: number
Returns void
- Defined in packages/ui-pager/index.d.ts:19

updateNativeItems

updateNativeItems(oldItems: View[], newItems: View[]): void
Parameters
- oldItems: View[]
- newItems: View[]
Returns void
- Defined in packages/ui-pager/index.d.ts:21

`Static`registerTransformer

registerTransformer(key: string, transformer: any): void
Parameters
- key: string
- transformer: any
Returns void
Inherited from PagerBase.registerTransformer
- Defined in packages/ui-pager/index.common.d.ts:75

Class Pager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Pager

Properties

Abstract Readonly_childrenCount

_childrenViews

_defaultTemplate

Protected_effectiveItemHeight

Protected_effectiveItemWidth

_itemTemplatesInternal

_itemViewLoader

Readonlyandroid

autoPlay

autoPlayDelay

cache

canGoLeft

canGoRight

circularMode

disableAnimation

disableSwipe

indicator

Readonlyios

items

itemTemplate

itemTemplates

loadMoreCount

ProtectedmObservableArrayInstance

orientation

peaking

perPage

preserveIndexOnItemsChange

selectedIndex

spacing

transformers

StaticitemDisposingEvent

StaticitemLoadingEvent

StaticknownFunctions

StaticloadMoreItemsEvent

StaticmRegisteredTransformers

StaticscrollEvent

StaticselectedIndexChangeEvent

StaticswipeEndEvent

StaticswipeEvent

StaticswipeOverEvent

StaticswipeStartEvent

Accessors

itemIdGenerator

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

Parameters

Returns void

itemTemplateSelector

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

Parameters

Returns void

itemViewLoader

Returns Function

Parameters

Returns void

padding

Returns string | number | LengthDipUnit | LengthPxUnit

Parameters

Returns void

paddingBottom

Returns LengthType

Parameters

Returns void

paddingLeft

Returns LengthType

Parameters

Returns void

paddingRight

Returns LengthType

Parameters

`Abstract` `Readonly`_childrenCount

`Protected`_effectiveItemHeight

`Protected`_effectiveItemWidth

`Readonly`android

`Readonly`ios

`Protected`mObservableArrayInstance

`Static`itemDisposingEvent

`Static`itemLoadingEvent

`Static`knownFunctions

`Static`loadMoreItemsEvent

`Static`mRegisteredTransformers

`Static`scrollEvent

`Static`selectedIndexChangeEvent

`Static`swipeEndEvent

`Static`swipeEvent

`Static`swipeOverEvent

`Static`swipeStartEvent

`Protected`_addChildView

`Protected` `Abstract`_observableArrayHandler

`Protected`_removeChildView