Interface ListView

Hierarchy

Index

Properties

Methods

Properties

public accessibilityHidden: boolean

public accessibilityHint: string

public accessibilityLabel: string

public accessibilityValue: string

public allowsSelection: boolean

public anchorPoint: Point

public animatedCenter: Point

public backgroundColor: string

public backgroundDisabledColor: string

public backgroundDisabledImage: string

public backgroundFocusedColor: string

public backgroundFocusedImage: string

public backgroundGradient: Gradient

public backgroundImage: string

public backgroundLeftCap: number

public backgroundRepeat: boolean

public backgroundSelectedColor: string

public backgroundSelectedImage: string

public backgroundTopCap: number

public borderColor: string

public borderRadius: number

public borderWidth: number

public bottom: any

public bubbleParent: boolean

public canScroll: boolean

public caseInsensitiveSearch: boolean

public center: Point

public children: View[]

public defaultItemTemplate: any

public editing: boolean

public enabled: boolean

public focusable: boolean

public footerTitle: string

public footerView: View

public headerTitle: string

public headerView: View

public height: any

public horizontalWrap: boolean

public keepScreenOn: boolean

public keepSectionsInSearch: boolean

public layout: string

public left: any

public opacity: number

public pruneSectionsOnEdit: boolean

public pullView: View

public rect: Dimension

public right: any

public scrollIndicatorStyle: number

public searchText: string

public searchView: any

public sectionCount: number

public sectionIndexTitles: ListViewIndexEntry[]

public sections: ListSection[]

public separatorColor: string

public separatorStyle: number

public showVerticalScrollIndicator: boolean

public size: Dimension

public softKeyboardOnFocus: number

public style: number

public templates: Dictionary

public tintColor: any

public top: any

public touchEnabled: boolean

public transform: any

public visible: boolean

public width: any

public willScrollOnStatusTap: boolean

public zIndex: number

Methods

public add(view: View)

Parameters

public addEventListener(name: string, callback: (...args: any[]) => any)

Parameters

  • name: string
  • callback: (...args: any[]) => any

public animate(animation: Animation, callback: (...args: any[]) => any)

Parameters

  • animation: Animation
  • callback: (...args: any[]) => any

public animate(animation: Dictionary, callback: (...args: any[]) => any)

Parameters

  • animation: Dictionary
  • callback: (...args: any[]) => any

public appendSection(section: ListSection, animation?: ListViewAnimationProperties)

Parameters

public appendSection(section: ListSection[], animation?: ListViewAnimationProperties)

Parameters

public applyProperties(props: Dictionary)

Parameters

public convertPointToView(point: Point, destinationView: View): Point

Parameters

Returns

Point

public deleteSectionAt(sectionIndex: number, animation?: ListViewAnimationProperties)

Parameters

public deselectItem(sectionIndex: number, itemIndex: number)

Parameters

  • sectionIndex: number
  • itemIndex: number

public finishLayout()

public fireEvent(name: string, event: Dictionary)

Parameters

public getAccessibilityHidden(): boolean

Returns

boolean

public getAccessibilityHint(): string

Returns

string

public getAccessibilityLabel(): string

Returns

string

public getAccessibilityValue(): string

Returns

string

public getAllowsSelection(): boolean

Returns

boolean

public getAnchorPoint(): Point

Returns

Point

public getAnimatedCenter(): Point

Returns

Point

public getBackgroundColor(): string

Returns

string

public getBackgroundDisabledColor(): string

Returns

string

public getBackgroundDisabledImage(): string

Returns

string

public getBackgroundFocusedColor(): string

Returns

string

public getBackgroundFocusedImage(): string

Returns

string

public getBackgroundGradient(): Gradient

Returns

Gradient

public getBackgroundImage(): string

Returns

string

public getBackgroundLeftCap(): number

Returns

number

public getBackgroundRepeat(): boolean

Returns

boolean

public getBackgroundSelectedColor(): string

Returns

string

public getBackgroundSelectedImage(): string

Returns

string

public getBackgroundTopCap(): number

Returns

number

public getBorderColor(): string

Returns

string

public getBorderRadius(): number

Returns

number

public getBorderWidth(): number

Returns

number

public getBottom(): any

Returns

any

public getBubbleParent(): boolean

Returns

boolean

public getCanScroll(): boolean

Returns

boolean

public getCaseInsensitiveSearch(): boolean

Returns

boolean

public getCenter(): Point

Returns

Point

public getChildren(): View[]

Returns

View[]

public getDefaultItemTemplate(): any

Returns

any

public getEditing(): boolean

Returns

boolean

public getEnabled(): boolean

Returns

boolean

public getFocusable(): boolean

Returns

boolean

public getFooterTitle(): string

Returns

string

public getFooterView(): View

Returns

View

public getHeaderTitle(): string

Returns

string

public getHeaderView(): View

Returns

View

public getHeight(): any

Returns

any

public getHorizontalWrap(): boolean

Returns

boolean

public getKeepScreenOn(): boolean

Returns

boolean

public getKeepSectionsInSearch(): boolean

Returns

boolean

public getLayout(): string

Returns

string

public getLeft(): any

Returns

any

public getOpacity(): number

Returns

number

public getPruneSectionsOnEdit(): boolean

Returns

boolean

public getPullView(): View

Returns

View

public getRect(): Dimension

Returns

Dimension

public getRight(): any

Returns

any

public getScrollIndicatorStyle(): number

Returns

number

public getSearchText(): string

Returns

string

public getSearchView(): SearchBar

Returns

SearchBar

public getSectionCount(): number

Returns

number

public getSectionIndexTitles(): ListViewIndexEntry[]

Returns

ListViewIndexEntry[]

public getSections(): ListSection[]

Returns

ListSection[]

public getSeparatorColor(): string

Returns

string

public getSeparatorStyle(): number

Returns

number

public getShowVerticalScrollIndicator(): boolean

Returns

boolean

public getSize(): Dimension

Returns

Dimension

public getSoftKeyboardOnFocus(): number

Returns

number

public getStyle(): number

Returns

number

public getTemplates(): Dictionary

Returns

Dictionary

public getTintColor(): string

Returns

string

public getTop(): any

Returns

any

public getTouchEnabled(): boolean

Returns

boolean

public getTransform(): any

Returns

any

public getVisible(): boolean

Returns

boolean

public getWidth(): any

Returns

any

public getWillScrollOnStatusTap(): boolean

Returns

boolean

public getZIndex(): number

Returns

number

public hide()

public insertSectionAt(sectionIndex: number, section: ListSection, animation?: ListViewAnimationProperties)

Parameters

public insertSectionAt(sectionIndex: number, section: ListSection[], animation?: ListViewAnimationProperties)

Parameters

public remove(view: View)

Parameters

public removeAllChildren()

public removeEventListener(name: string, callback: (...args: any[]) => any)

Parameters

  • name: string
  • callback: (...args: any[]) => any

public replaceSectionAt(sectionIndex: number, section: ListSection, animation: ListViewAnimationProperties)

Parameters

public scrollToItem(sectionIndex: number, itemIndex: number, animation?: ListViewAnimationProperties)

Parameters

public selectItem(sectionIndex: number, itemIndex: number)

Parameters

  • sectionIndex: number
  • itemIndex: number

public setAccessibilityHidden(accessibilityHidden: boolean)

Parameters

  • accessibilityHidden: boolean

public setAccessibilityHint(accessibilityHint: string)

Parameters

  • accessibilityHint: string

public setAccessibilityLabel(accessibilityLabel: string)

Parameters

  • accessibilityLabel: string

public setAccessibilityValue(accessibilityValue: string)

Parameters

  • accessibilityValue: string

public setAllowsSelection(allowsSelection: boolean)

Parameters

  • allowsSelection: boolean

public setAnchorPoint(anchorPoint: Point)

Parameters

public setBackgroundColor(backgroundColor: string)

Parameters

  • backgroundColor: string

public setBackgroundDisabledColor(backgroundDisabledColor: string)

Parameters

  • backgroundDisabledColor: string

public setBackgroundDisabledImage(backgroundDisabledImage: string)

Parameters

  • backgroundDisabledImage: string

public setBackgroundFocusedColor(backgroundFocusedColor: string)

Parameters

  • backgroundFocusedColor: string

public setBackgroundFocusedImage(backgroundFocusedImage: string)

Parameters

  • backgroundFocusedImage: string

public setBackgroundGradient(backgroundGradient: Gradient)

Parameters

public setBackgroundImage(backgroundImage: string)

Parameters

  • backgroundImage: string

public setBackgroundLeftCap(backgroundLeftCap: number)

Parameters

  • backgroundLeftCap: number

public setBackgroundRepeat(backgroundRepeat: boolean)

Parameters

  • backgroundRepeat: boolean

public setBackgroundSelectedColor(backgroundSelectedColor: string)

Parameters

  • backgroundSelectedColor: string

public setBackgroundSelectedImage(backgroundSelectedImage: string)

Parameters

  • backgroundSelectedImage: string

public setBackgroundTopCap(backgroundTopCap: number)

Parameters

  • backgroundTopCap: number

public setBorderColor(borderColor: string)

Parameters

  • borderColor: string

public setBorderRadius(borderRadius: number)

Parameters

  • borderRadius: number

public setBorderWidth(borderWidth: number)

Parameters

  • borderWidth: number

public setBottom(bottom: number)

Parameters

  • bottom: number

public setBottom(bottom: string)

Parameters

  • bottom: string

public setBubbleParent(bubbleParent: boolean)

Parameters

  • bubbleParent: boolean

public setCanScroll(canScroll: boolean)

Parameters

  • canScroll: boolean

public setCaseInsensitiveSearch(caseInsensitiveSearch: boolean)

Parameters

  • caseInsensitiveSearch: boolean

public setCenter(center: Point)

Parameters

public setContentInsets(edgeInsets: ListViewEdgeInsets, animated?: ListViewContentInsetOption)

Parameters

public setDefaultItemTemplate(defaultItemTemplate: string)

Parameters

  • defaultItemTemplate: string

public setDefaultItemTemplate(defaultItemTemplate: number)

Parameters

  • defaultItemTemplate: number

public setEditing(editing: boolean)

Parameters

  • editing: boolean

public setEnabled(enabled: boolean)

Parameters

  • enabled: boolean

public setFocusable(focusable: boolean)

Parameters

  • focusable: boolean

public setFooterTitle(footerTitle: string)

Parameters

  • footerTitle: string

public setFooterView(footerView: View)

Parameters

public setHeaderTitle(headerTitle: string)

Parameters

  • headerTitle: string

public setHeaderView(headerView: View)

Parameters

public setHeight(height: number)

Parameters

  • height: number

public setHeight(height: string)

Parameters

  • height: string

public setHorizontalWrap(horizontalWrap: boolean)

Parameters

  • horizontalWrap: boolean

public setKeepScreenOn(keepScreenOn: boolean)

Parameters

  • keepScreenOn: boolean

public setKeepSectionsInSearch(keepSectionsInSearch: boolean)

Parameters

  • keepSectionsInSearch: boolean

public setLayout(layout: string)

Parameters

  • layout: string

public setLeft(left: number)

Parameters

  • left: number

public setLeft(left: string)

Parameters

  • left: string

public setMarker(markerProps: ListViewMarkerProps)

Parameters

public setOpacity(opacity: number)

Parameters

  • opacity: number

public setPruneSectionsOnEdit(pruneSectionsOnEdit: boolean)

Parameters

  • pruneSectionsOnEdit: boolean

public setPullView(pullView: View)

Parameters

public setRight(right: number)

Parameters

  • right: number

public setRight(right: string)

Parameters

  • right: string

public setScrollIndicatorStyle(scrollIndicatorStyle: number)

Parameters

  • scrollIndicatorStyle: number

public setSearchText(searchText: string)

Parameters

  • searchText: string

public setSearchView(searchView: SearchBar)

Parameters

public setSectionIndexTitles(sectionIndexTitles: ListViewIndexEntry[])

Parameters

public setSections(sections: ListSection[])

Parameters

public setSeparatorColor(separatorColor: string)

Parameters

  • separatorColor: string

public setSeparatorStyle(separatorStyle: number)

Parameters

  • separatorStyle: number

public setShowVerticalScrollIndicator(showVerticalScrollIndicator: boolean)

Parameters

  • showVerticalScrollIndicator: boolean

public setSoftKeyboardOnFocus(softKeyboardOnFocus: number)

Parameters

  • softKeyboardOnFocus: number

public setTintColor(tintColor: string)

Parameters

  • tintColor: string

public setTop(top: number)

Parameters

  • top: number

public setTop(top: string)

Parameters

  • top: string

public setTouchEnabled(touchEnabled: boolean)

Parameters

  • touchEnabled: boolean

public setTransform(transform: _2DMatrix)

Parameters

public setTransform(transform: _3DMatrix)

Parameters

public setVisible(visible: boolean)

Parameters

  • visible: boolean

public setWidth(width: number)

Parameters

  • width: number

public setWidth(width: string)

Parameters

  • width: string

public setWillScrollOnStatusTap(willScrollOnStatusTap: boolean)

Parameters

  • willScrollOnStatusTap: boolean

public setZIndex(zIndex: number)

Parameters

  • zIndex: number

public show(args?: Array<any>)

Parameters

  • args?: Array<any> optional

public startLayout()

public toImage(callback?: (...args: any[]) => any, honorScaleFactor?: boolean): Blob

Parameters

  • callback?: (...args: any[]) => any optional
  • honorScaleFactor?: boolean optional

Returns

Blob

public updateLayout(params: Dictionary)

Parameters