Class CollectionViewBase`Abstract`

Hierarchy (View Summary)

View
- CollectionViewBase
  - CollectionView

Implements

CollectionView

Indexable

[key: symbol]: () => string

Index

Constructors

constructor

new CollectionViewBase(): CollectionViewBase
Returns CollectionViewBase
Overrides View.constructor
- Defined in packages/collectionview/index-common.d.ts:95

Properties

`Protected`_dataUpdatesSuspended

_dataUpdatesSuspended: boolean

`Protected`_defaultTemplate

_defaultTemplate: KeyedTemplate

_effectiveColWidth

_effectiveColWidth: number

_effectiveRowHeight

_effectiveRowHeight: number

_innerHeight

_innerHeight: number

_innerWidth

_innerWidth: number

_isDataDirty

_isDataDirty: boolean

_itemIdGenerator

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

_itemTemplateSelector

_itemTemplateSelector: Function

`Protected`_itemTemplatesInternal

_itemTemplatesInternal: Map<string, KeyedTemplate>

_itemViewLoader

_itemViewLoader: any

autoReloadItemOnLayout

autoReloadItemOnLayout: boolean

Used on iOS to auto update cells size if the cell request a layout change (like image itemLoading). Experimental and true by default

colWidth

colWidth: CoreTypesLength

draggingView

draggingView: View

horizontalSpacing

horizontalSpacing: LengthType

isBounceEnabled

isBounceEnabled: boolean

isItemsSourceIn

isItemsSourceIn: boolean

isScrollEnabled

isScrollEnabled: boolean

itemOverlap

itemOverlap: (item: any, index: number) => [number, number, number, number]

items

items: any[] | ItemsSource

itemTemplate

itemTemplate: string | Template

itemTemplates

itemTemplates: string | KeyedTemplate[]

layoutStyle

layoutStyle: string

loadMoreThreshold

loadMoreThreshold: number

onItemOverlapChanged

onItemOverlapChanged: (oldValue: any, newValue: any) => void

onSpanSizeChanged

onSpanSizeChanged: (oldValue: any, newValue: any) => void

orientation

orientation: Orientation

plugins

plugins: string[]

reorderEnabled

reorderEnabled: boolean

reorderLongPressEnabled

reorderLongPressEnabled: boolean

reverseLayout

reverseLayout: boolean

rowHeight

rowHeight: CoreTypesLength

scrollBarIndicatorVisible

scrollBarIndicatorVisible: boolean

scrollOffset

scrollOffset: number

spanSize

spanSize: (item: any, index: number) => number

verticalSpacing

verticalSpacing: LengthType

`Static`bindedEvent

bindedEvent: string

`Static`dataPopulatedEvent

dataPopulatedEvent: string

`Static`displayItemEvent

displayItemEvent: string

`Static`itemDisposingEvent

itemDisposingEvent: string

`Static`itemLoadingEvent

itemLoadingEvent: string

`Static`itemRecyclingEvent

itemRecyclingEvent: string

`Static`itemReorderCheckEvent

itemReorderCheckEvent: string

`Static`itemReorderedEvent

itemReorderedEvent: string

`Static`itemReorderStartedEvent

itemReorderStartedEvent: string

`Static`itemReorderStartingEvent

itemReorderStartingEvent: string

`Static`itemTapEvent

itemTapEvent: string

`Static`knownFunctions

knownFunctions: string[]

`Static`layoutStyles

layoutStyles: {
[k: string]: { createDelegate?: Function; createLayout: Function };
}

`Static`loadMoreItemsEvent

loadMoreItemsEvent: string

`Static`plugins

plugins: { [k: string]: Plugin }

`Static`scrollEndEvent

scrollEndEvent: string

`Static`scrollEvent

scrollEvent: string

`Static`scrollStartEvent

scrollStartEvent: string

Accessors

itemViewLoader

get itemViewLoader(): any
Returns any
Implementation of CollectionViewDefinition.itemViewLoader
- Defined in packages/collectionview/index-common.d.ts:117
set itemViewLoader(value: any): void
Parameters
- value: any
Returns void
Implementation of CollectionViewDefinition.itemViewLoader
- Defined in packages/collectionview/index-common.d.ts:118

padding

get padding(): string | number | LengthDipUnit | LengthPxUnit
Returns string | number | LengthDipUnit | LengthPxUnit
Implementation of CollectionViewDefinition.padding
- Defined in packages/collectionview/index-common.d.ts:119
set padding(value: string | number | LengthDipUnit | LengthPxUnit): void
Parameters
- value: string | number | LengthDipUnit | LengthPxUnit
Returns void
Implementation of CollectionViewDefinition.padding
- Defined in packages/collectionview/index-common.d.ts:120

paddingBottom

get paddingBottom(): LengthType
Returns LengthType
Implementation of CollectionViewDefinition.paddingBottom
- Defined in packages/collectionview/index-common.d.ts:125
set paddingBottom(value: LengthType): void
Parameters
- value: LengthType
Returns void
Implementation of CollectionViewDefinition.paddingBottom
- Defined in packages/collectionview/index-common.d.ts:126

paddingLeft

get paddingLeft(): LengthType
Returns LengthType
Implementation of CollectionViewDefinition.paddingLeft
- Defined in packages/collectionview/index-common.d.ts:127
set paddingLeft(value: LengthType): void
Parameters
- value: LengthType
Returns void
Implementation of CollectionViewDefinition.paddingLeft
- Defined in packages/collectionview/index-common.d.ts:128

paddingRight

get paddingRight(): LengthType
Returns LengthType
Implementation of CollectionViewDefinition.paddingRight
- Defined in packages/collectionview/index-common.d.ts:123
set paddingRight(value: LengthType): void
Parameters
- value: LengthType
Returns void
Implementation of CollectionViewDefinition.paddingRight
- Defined in packages/collectionview/index-common.d.ts:124

paddingTop

get paddingTop(): LengthType
Returns LengthType
Implementation of CollectionViewDefinition.paddingTop
- Defined in packages/collectionview/index-common.d.ts:121
set paddingTop(value: LengthType): void
Parameters
- value: LengthType
Returns void
Implementation of CollectionViewDefinition.paddingTop
- Defined in packages/collectionview/index-common.d.ts:122

Methods

_callItemReorderedEvent

_callItemReorderedEvent(oldPosition: any, newPosition: any, item: any): void
Parameters
- oldPosition: any
- newPosition: any
- item: any
Returns void
Implementation of CollectionViewDefinition._callItemReorderedEvent
- Defined in packages/collectionview/index-common.d.ts:160

_canReorderToPosition

_canReorderToPosition(oldPosition: any, newPosition: any, item: any): boolean
Parameters
- oldPosition: any
- newPosition: any
- item: any
Returns boolean
Implementation of CollectionViewDefinition._canReorderToPosition
- Defined in packages/collectionview/index-common.d.ts:161

_getDefaultItemContent

_getDefaultItemContent(): Label
Returns Label
Implementation of CollectionViewDefinition._getDefaultItemContent
- Defined in packages/collectionview/index-common.d.ts:130

_onColWidthPropertyChanged

_onColWidthPropertyChanged(
oldValue: PercentLengthType,
newValue: PercentLengthType,
): void
Parameters
- oldValue: PercentLengthType
- newValue: PercentLengthType
Returns void
Implementation of CollectionViewDefinition._onColWidthPropertyChanged
- Defined in packages/collectionview/index-common.d.ts:114

_onRowHeightPropertyChanged

_onRowHeightPropertyChanged(
oldValue: PercentLengthType,
newValue: PercentLengthType,
): void
Parameters
- oldValue: PercentLengthType
- newValue: PercentLengthType
Returns void
Implementation of CollectionViewDefinition._onRowHeightPropertyChanged
- Defined in packages/collectionview/index-common.d.ts:113

_prepareItem

_prepareItem(view: View, index: number): any
Parameters
- view: View
- index: number
Returns any
Implementation of CollectionViewDefinition._prepareItem
- Defined in packages/collectionview/index-common.d.ts:108

_reorderItemInSource

_reorderItemInSource(
    oldPosition: number,
    newPosition: number,
    callEvents?: boolean,
): void
Parameters
- oldPosition: number
- newPosition: number
- OptionalcallEvents: boolean
Returns void
Implementation of CollectionViewDefinition._reorderItemInSource
- Defined in packages/collectionview/index-common.d.ts:162

addTemplate

addTemplate(key: any, t: any): void
Parameters
- key: any
- t: any
Returns void
Implementation of CollectionViewDefinition.addTemplate
- Defined in packages/collectionview/index-common.d.ts:141

computeSpanCount

computeSpanCount(): number
Returns number
Implementation of CollectionViewDefinition.computeSpanCount
- Defined in packages/collectionview/index-common.d.ts:112

`Abstract`eachChildAsync

eachChildAsync(callback: any): any
Parameters
- callback: any
Returns any
Implementation of CollectionViewDefinition.eachChildAsync
- Defined in packages/collectionview/index-common.d.ts:98

`Abstract`findFirstVisibleItemIndex

findFirstVisibleItemIndex(): number
Returns number
Implementation of CollectionViewDefinition.findFirstVisibleItemIndex
- Defined in packages/collectionview/index-common.d.ts:101

`Abstract`findLastVisibleItemIndex

findLastVisibleItemIndex(): number
Returns number
Implementation of CollectionViewDefinition.findLastVisibleItemIndex
- Defined in packages/collectionview/index-common.d.ts:102

getItemArrayAtIndex

getItemArrayAtIndex(index: number): any
Parameters
- index: number
Returns any
Implementation of CollectionViewDefinition.getItemArrayAtIndex
- Defined in packages/collectionview/index-common.d.ts:146

getItemAtIndex

getItemAtIndex(index: number): any
Parameters
- index: number
Returns any
Implementation of CollectionViewDefinition.getItemAtIndex
- Defined in packages/collectionview/index-common.d.ts:110

getItemSourceAtIndex

getItemSourceAtIndex(index: number): any
Parameters
- index: number
Returns any
Implementation of CollectionViewDefinition.getItemSourceAtIndex
- Defined in packages/collectionview/index-common.d.ts:145

getTemplateFromSelector

getTemplateFromSelector(templateKey: any): KeyedTemplate
Parameters
- templateKey: any
Returns KeyedTemplate
Implementation of CollectionViewDefinition.getTemplateFromSelector
- Defined in packages/collectionview/index-common.d.ts:131

`Abstract`getViewForItemAtIndex

getViewForItemAtIndex(index: number): View
Parameters
- index: number
Returns View
Implementation of CollectionViewDefinition.getViewForItemAtIndex
- Defined in packages/collectionview/index-common.d.ts:157

getViewForViewType

getViewForViewType(viewType: ListViewViewTypes, templateKey: string): any
Parameters
- viewType: ListViewViewTypes
- templateKey: string
Returns any
Implementation of CollectionViewDefinition.getViewForViewType
- Defined in packages/collectionview/index-common.d.ts:132

isHorizontal

isHorizontal(): boolean
Returns boolean
Implementation of CollectionViewDefinition.isHorizontal
- Defined in packages/collectionview/index-common.d.ts:111

`Abstract`isItemAtIndexVisible

isItemAtIndexVisible(index: number): any
Parameters
- index: number
Returns any
Implementation of CollectionViewDefinition.isItemAtIndexVisible
- Defined in packages/collectionview/index-common.d.ts:100

notifyForItemAtIndex

notifyForItemAtIndex(
    eventName: string,
    view: View,
    index: number,
    bindingContext?: any,
    native?: any,
): void
Parameters
- eventName: string
- view: View
- index: number
- OptionalbindingContext: any
- Optionalnative: any
Returns void
Implementation of CollectionViewDefinition.notifyForItemAtIndex
- Defined in packages/collectionview/index-common.d.ts:96

notifyLoading

notifyLoading(args: any): void
Parameters
- args: any
Returns void
Implementation of CollectionViewDefinition.notifyLoading
- Defined in packages/collectionview/index-common.d.ts:109

onItemIdGeneratorChanged

onItemIdGeneratorChanged(oldValue: any, newValue: any): void
Parameters
- oldValue: any
- newValue: any
Returns void
Implementation of CollectionViewDefinition.onItemIdGeneratorChanged
- Defined in packages/collectionview/index-common.d.ts:138

onItemsChanged

onItemsChanged(oldValue: any, newValue: any): void
Parameters
- oldValue: any
- newValue: any
Returns void
Implementation of CollectionViewDefinition.onItemsChanged
- Defined in packages/collectionview/index-common.d.ts:147

onItemTemplateChanged

onItemTemplateChanged(oldValue: any, newValue: any): void
Parameters
- oldValue: any
- newValue: any
Returns void
Implementation of CollectionViewDefinition.onItemTemplateChanged
- Defined in packages/collectionview/index-common.d.ts:144

onItemTemplatesChanged

onItemTemplatesChanged(oldValue: any, newValue: any): void
Parameters
- oldValue: any
- newValue: any
Returns void
Implementation of CollectionViewDefinition.onItemTemplatesChanged
- Defined in packages/collectionview/index-common.d.ts:143

onItemTemplateSelectorChanged

onItemTemplateSelectorChanged(oldValue: any, newValue: any): void
Parameters
- oldValue: any
- newValue: any
Returns void
Implementation of CollectionViewDefinition.onItemTemplateSelectorChanged
- Defined in packages/collectionview/index-common.d.ts:135

onItemViewLoaderChanged

onItemViewLoaderChanged(): void
Returns void
Implementation of CollectionViewDefinition.onItemViewLoaderChanged
- Defined in packages/collectionview/index-common.d.ts:115

onLoaded

onLoaded(): void
Returns void
Implementation of CollectionViewDefinition.onLoaded
Overrides View.onLoaded
- Defined in packages/collectionview/index-common.d.ts:151

onMeasure

onMeasure(widthMeasureSpec: number, heightMeasureSpec: number): void
Measure the view and its content to determine the measured width and the measured height. This method is invoked by measure(int, int) and should be overriden by subclasses to provide accurate and efficient measurement of their contents. When overriding this method, you must call setMeasuredDimension(int, int) to store the measured width and height of this view. Failure to do so will trigger an exception, thrown by measure(int, int).
Parameters
- widthMeasureSpec: number
  horizontal space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.
- heightMeasureSpec: number
  vertical space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.
Returns void
Implementation of CollectionViewDefinition.onMeasure
Overrides View.onMeasure
- Defined in packages/collectionview/index-common.d.ts:106

onSourceCollectionChanged

onSourceCollectionChanged(event: ChangedData<any>): void
Parameters
- event: ChangedData<any>
Returns void
Implementation of CollectionViewDefinition.onSourceCollectionChanged
- Defined in packages/collectionview/index-common.d.ts:152

onSourceCollectionChangedInternal

onSourceCollectionChangedInternal(event: ChangedData<any>): void
Parameters
- event: ChangedData<any>
Returns void
Implementation of CollectionViewDefinition.onSourceCollectionChangedInternal
- Defined in packages/collectionview/index-common.d.ts:153

onTemplateAdded

onTemplateAdded(t: any): void
Parameters
- t: any
Returns void
Implementation of CollectionViewDefinition.onTemplateAdded
- Defined in packages/collectionview/index-common.d.ts:139

onTemplateRemoved

onTemplateRemoved(key: any): void
Parameters
- key: any
Returns void
Implementation of CollectionViewDefinition.onTemplateRemoved
- Defined in packages/collectionview/index-common.d.ts:140

`Abstract`refresh

refresh(): any
Returns any
Implementation of CollectionViewDefinition.refresh
- Defined in packages/collectionview/index-common.d.ts:97

`Abstract`refreshVisibleItems

refreshVisibleItems(): any
Returns any
Implementation of CollectionViewDefinition.refreshVisibleItems
- Defined in packages/collectionview/index-common.d.ts:99

removeTemplate

removeTemplate(key: any): void
Parameters
- key: any
Returns void
Implementation of CollectionViewDefinition.removeTemplate
- Defined in packages/collectionview/index-common.d.ts:142

resolveTemplateView

resolveTemplateView(template: any): View
Parameters
- template: any
Returns View
Implementation of CollectionViewDefinition.resolveTemplateView
- Defined in packages/collectionview/index-common.d.ts:129

resumeUpdates

resumeUpdates(refresh: boolean): void
Parameters
- refresh: boolean
Returns void
Implementation of CollectionViewDefinition.resumeUpdates
- Defined in packages/collectionview/index-common.d.ts:156

`Abstract`scrollToIndex

scrollToIndex(index: number, animated: boolean): any
Parameters
- index: number
- animated: boolean
Returns any
Implementation of CollectionViewDefinition.scrollToIndex
- Defined in packages/collectionview/index-common.d.ts:103

`Abstract`scrollToOffset

scrollToOffset(value: number, animated?: boolean): any
Parameters
- value: number
- Optionalanimated: boolean
Returns any
Implementation of CollectionViewDefinition.scrollToOffset
- Defined in packages/collectionview/index-common.d.ts:104

shouldMoveItemAtIndex

shouldMoveItemAtIndex(index: number): boolean
Parameters
- index: number
Returns boolean
Implementation of CollectionViewDefinition.shouldMoveItemAtIndex
- Defined in packages/collectionview/index-common.d.ts:163

`Abstract`startDragging

startDragging(index: number): any
Parameters
- index: number
Returns any
Implementation of CollectionViewDefinition.startDragging
- Defined in packages/collectionview/index-common.d.ts:158

suspendUpdates

suspendUpdates(): void
Returns void
Implementation of CollectionViewDefinition.suspendUpdates
- Defined in packages/collectionview/index-common.d.ts:154

`Protected`updateInnerSize

updateInnerSize(): boolean
Returns boolean
Implementation of CollectionViewDefinition.updateInnerSize
- Defined in packages/collectionview/index-common.d.ts:105

updatesSuspended

updatesSuspended(): boolean
Returns boolean
Implementation of CollectionViewDefinition.updatesSuspended
- Defined in packages/collectionview/index-common.d.ts:155

`Static`registerLayoutStyle

registerLayoutStyle(
style: string,
generator: { createDelegate?: Function; createLayout: Function },
): void
Parameters
- style: string
- generator: { createDelegate?: Function; createLayout: Function }
Returns void
- Defined in packages/collectionview/index-common.d.ts:89

`Static`registerPlugin

registerPlugin(key: string, plugin: Plugin): void
Parameters
- key: string
- plugin: Plugin
Returns void
- Defined in packages/collectionview/index-common.d.ts:82

Class CollectionViewBaseAbstract

Hierarchy (View Summary)

Implements

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CollectionViewBase

Properties

Protected_dataUpdatesSuspended

Protected_defaultTemplate

_effectiveColWidth

_effectiveRowHeight

_innerHeight

_innerWidth

_isDataDirty

_itemIdGenerator

_itemTemplateSelector

Protected_itemTemplatesInternal

_itemViewLoader

autoReloadItemOnLayout

colWidth

draggingView

horizontalSpacing

isBounceEnabled

isItemsSourceIn

isScrollEnabled

itemOverlap

items

itemTemplate

itemTemplates

layoutStyle

loadMoreThreshold

onItemOverlapChanged

onSpanSizeChanged

orientation

plugins

reorderEnabled

reorderLongPressEnabled

reverseLayout

rowHeight

scrollBarIndicatorVisible

scrollOffset

spanSize

verticalSpacing

StaticbindedEvent

StaticdataPopulatedEvent

StaticdisplayItemEvent

StaticitemDisposingEvent

StaticitemLoadingEvent

StaticitemRecyclingEvent

StaticitemReorderCheckEvent

StaticitemReorderedEvent

StaticitemReorderStartedEvent

StaticitemReorderStartingEvent

StaticitemTapEvent

StaticknownFunctions

StaticlayoutStyles

StaticloadMoreItemsEvent

Staticplugins

StaticscrollEndEvent

StaticscrollEvent

StaticscrollStartEvent

Accessors

itemViewLoader

Returns any

Parameters

Returns void

padding

Returns string | number | LengthDipUnit | LengthPxUnit

Parameters

Returns void

paddingBottom

Returns LengthType

Parameters

Returns void

Class CollectionViewBase`Abstract`

`Protected`_dataUpdatesSuspended

`Protected`_defaultTemplate

`Protected`_itemTemplatesInternal

`Static`bindedEvent

`Static`dataPopulatedEvent

`Static`displayItemEvent

`Static`itemDisposingEvent

`Static`itemLoadingEvent

`Static`itemRecyclingEvent

`Static`itemReorderCheckEvent

`Static`itemReorderedEvent

`Static`itemReorderStartedEvent

`Static`itemReorderStartingEvent

`Static`itemTapEvent

`Static`knownFunctions

`Static`layoutStyles

`Static`loadMoreItemsEvent

`Static`plugins

`Static`scrollEndEvent

`Static`scrollEvent

`Static`scrollStartEvent

`Abstract`eachChildAsync

`Abstract`findFirstVisibleItemIndex

`Abstract`findLastVisibleItemIndex

`Abstract`getViewForItemAtIndex

`Abstract`isItemAtIndexVisible