Interface IGridViewAndroid

Hierarchy

Events

onScrollStateChanged onItemLongSelected onGesture onAttachedToWindow onDetachedFromWindow

Properties

snapToAlignment overScrollMode nestedScrollingEnabled yogaNode useForeground rippleEnabled rippleColor elevation zIndex borderTopLeftRadius borderTopRightRadius borderTopStartRadius borderTopEndRadius borderBottomLeftRadius borderBottomRightRadius borderBottomStartRadius borderBottomEndRadius updateRippleEffectIfNeeded

Methods

saveInstanceState restoreInstanceState

Events

onScrollStateChanged

onScrollStateChanged: ((scrollState: ScrollState, contentOffset: Point2D) => void)

Type declaration

    • (scrollState: ScrollState, contentOffset: Point2D): void

    • This event is called when a GridView's scroll state is changed. To remove this evet, set null. For better performance, don't set any callback if does not necessary

      onScrollStateChanged

      Android

      Since

      3.2.1

      Parameters

      Returns void

onItemLongSelected

onItemLongSelected: ((selectedItem: GridViewItem, index?: number) => void)

Type declaration

    • (selectedItem: GridViewItem, index?: number): void

    • This event is called when user long selects a item at specific index.

      Android

      Since

      3.0.2

      Parameters

      • selectedItem: GridViewItem
      • Optional index: number

        onItemLongSelected

      Returns void

onGesture

onGesture: ((params: { distanceX: number; distanceY: number }) => boolean)

Type declaration

    • (params: { distanceX: number; distanceY: number }): boolean

    • This event is called when a scroll occurs.

      Returns

      Return true if the event is consumed. onGesture

      Android

      Since

      4.0.0

      Parameters

      • params: { distanceX: number; distanceY: number }
        • distanceX: number
        • distanceY: number

      Returns boolean

onAttachedToWindow

onAttachedToWindow: (() => void)

Type declaration

    • (): void

    • This event is called when the view is attached to a window. At this point it has a Surface and will start drawing.

      onAttachedToWindow

      Android

      Since

      4.0.2

      Returns void

onDetachedFromWindow

onDetachedFromWindow: (() => void)

Type declaration

    • (): void

    • This event is called when the view is detached to a window. At this point it no longer has a surface for drawing.

      onDetachedFromWindow

      Android

      Since

      4.0.2

      Returns void

Properties

snapToAlignment

snapToAlignment: GridViewSnapAlignment

This property enables/disables snapping the center of the target child view to the center of the GridView in either vertical or horizontal orientation. For iOS, prefer to UI.LayoutManager.targetContentOffset

Property

= UI.GridView.Android.SnapAlignment.SNAPTO_NONE]

Android

Since

3.2.0

overScrollMode

overScrollMode: OverScrollMode

Gets/sets over-scroll mode for this view.

Property

= UI.Android.OverScrollMode.ALWAYS]

Android

Since

3.2.1

nestedScrollingEnabled

nestedScrollingEnabled: boolean

Gets/sets the nested scrolling enable for this view.

This property should be set to false when this view is inside the bottomsheet for better scrolling experience.

Property

= true]

Android

Since

5.0.4

Readonly yogaNode

yogaNode: any

useForeground

useForeground: boolean

Gets/sets foreground of the view for ripple effect. This property should be set before rippleColor. This property only supported for api level 23 and above.

Property

= false]

Android

Member

UI.View

Since

4.0.2

rippleEnabled

rippleEnabled: boolean

Gets/sets ripple effect enabled for view. You should set UI.View#rippleColor rippleColor to see the effect.

Property

= false]

Android

Member

UI.View

Since

3.2.1

rippleColor

rippleColor: IColor

Gets/sets ripple effect color for view.

Property

Android

Member

UI.View

Since

3.2.1

elevation

elevation: number

Gets/Sets the elevation of the view. For the views that has StateListAnimator natively like Button, will lost its own StateListAnimation when elevation value changed. For details : https://developer.android.com/training/material/shadows-clipping.html

Property

Android

Member

UI.View

See

Since

1.1.12

zIndex

zIndex: number

Gets/sets the depth location of the view relative to its elevation. To put view over button, you have to change zIndex value after Android Lollipop. On android, default elevation value of button is bigger than other view. This property affects after Android Lollipop. No-op before api level 21.

Property

Android

Member

UI.View

Since

2.0.8

borderTopLeftRadius

borderTopLeftRadius: number

Sets/gets top-left corner radius of a view.

Property

= 0]

Android

Since

5.1.1

borderTopRightRadius

borderTopRightRadius: number

Sets/gets top-right corner radius of a view.

Property

= 0]

Android

Since

5.1.1

borderTopStartRadius

borderTopStartRadius: number

Sets/gets top-start corner radius of a view.

Property

= -1]

Android

Since

5.1.1

borderTopEndRadius

borderTopEndRadius: number

Sets/gets top-end corner radius of a view.

Property

= -1]

Android

Since

5.1.1

borderBottomLeftRadius

borderBottomLeftRadius: number

Sets/gets bottom-left corner radius of a view.

Property

= 0]

Android

Since

5.1.1

borderBottomRightRadius

borderBottomRightRadius: number

Sets/gets bottom-right corner radius of a view.

Property

= 0]

Android

Since

5.1.1

borderBottomStartRadius

borderBottomStartRadius: number

Sets/gets bottom-start corner radius of a view.

Property

= -1]

Android

Since

5.1.1

borderBottomEndRadius

borderBottomEndRadius: number

Sets/gets bottom-end corner radius of a view.

Property

= -1]

Android

Since

5.1.1

updateRippleEffectIfNeeded

updateRippleEffectIfNeeded: (() => void)

Type declaration

    • (): void

    • Returns void

Methods

saveInstanceState

  • Called when the GridView should save its layout state. This is a good time to save your scroll position, configuration and anything else that may be required to restore the same layout state if the GridView is recreated.

    Method

    saveInstanceState

    Android

    Returns

    Since

    4.0.2

    Returns any

restoreInstanceState

  • Called when the GridView should restore its layout state. This is a good time to restore your scroll position, configuration and anything else that may be required to restore the same layout state if the GridView is recreated.

    Method

    restoreInstanceState

    Android

    Since

    4.0.2

    Parameters

    • state: any

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc