{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

LazyGridLayoutInfo

public sealed interface LazyGridLayoutInfo


Contains useful information about the currently displayed layout state of lazy grids like LazyVerticalGrid. For example you can get the list of currently displayed items.

Use LazyGridState.layoutInfo to retrieve this

Summary

Public methods

abstract int

The content padding in pixels applied after the last row/column in the direction of scrolling.

abstract int

The content padding in pixels applied before the first row/column in the direction of scrolling.

abstract int

The spacing between lines in the direction of scrolling.

abstract @NonNull Orientation

The orientation of the lazy grid.

abstract boolean

True if the direction of scrolling and layout is reversed.

abstract int

The total count of items passed to LazyVerticalGrid.

abstract int

The end offset of the layout's viewport in pixels.

abstract @NonNull IntSize

The size of the viewport in pixels.

abstract int

The start offset of the layout's viewport in pixels.

abstract @NonNull List<@NonNull LazyGridItemInfo>

The list of LazyGridItemInfo representing all the currently visible items.

Public methods

getAfterContentPadding

abstract int getAfterContentPadding()

The content padding in pixels applied after the last row/column in the direction of scrolling. For example it is a bottom content padding for LazyVerticalGrid with reverseLayout set to false.

getBeforeContentPadding

abstract int getBeforeContentPadding()

The content padding in pixels applied before the first row/column in the direction of scrolling. For example it is a top content padding for LazyVerticalGrid with reverseLayout set to false.

getMainAxisItemSpacing

abstract int getMainAxisItemSpacing()

The spacing between lines in the direction of scrolling.

getOrientation

abstract @NonNull Orientation getOrientation()

The orientation of the lazy grid.

getReverseLayout

abstract boolean getReverseLayout()

True if the direction of scrolling and layout is reversed.

getTotalItemsCount

abstract int getTotalItemsCount()

The total count of items passed to LazyVerticalGrid.

getViewportEndOffset

abstract int getViewportEndOffset()

The end offset of the layout's viewport in pixels. You can think of it as a maximum offset which would be visible. It is the size of the lazy grid layout minus beforeContentPadding.

You can use it to understand what items from visibleItemsInfo are fully visible.

getViewportSize

abstract @NonNull IntSize getViewportSize()

The size of the viewport in pixels. It is the lazy grid layout size including all the content paddings.

getViewportStartOffset

abstract int getViewportStartOffset()

The start offset of the layout's viewport in pixels. You can think of it as a minimum offset which would be visible. Usually it is 0, but it can be negative if non-zero beforeContentPadding was applied as the content displayed in the content padding area is still visible.

You can use it to understand what items from visibleItemsInfo are fully visible.

getVisibleItemsInfo

abstract @NonNull List<@NonNull LazyGridItemInfogetVisibleItemsInfo()

The list of LazyGridItemInfo representing all the currently visible items.