One Logo Pool Ball
X
Github
Discord

System

UIKit · IOS API REFERENCE

UICollectionViewLayout

class · iOS 6.0+ · SDK 27.1

@MainActor class UICollectionViewLayout

Members (44)

get · iOS 7.0+

invalidationContextClass

TypeScript
static get invalidationContextClass(): Promise<string>
Swift declaration
class var invalidationContextClass: AnyClass { get }
get

layoutAttributesClass

TypeScript
static get layoutAttributesClass(): Promise<string>
Swift declaration
class var layoutAttributesClass: AnyClass { get }
method

finalLayoutAttributesForDisappearingDecorationElement

TypeScript
finalLayoutAttributesForDisappearingDecorationElement(elementKind: string, decorationIndexPath: _Foundation_IndexPath): Promise<(UICollectionViewLayoutAttributes) | null>
Swift declaration
func finalLayoutAttributesForDisappearingDecorationElement(ofKind elementKind: String, at decorationIndexPath: IndexPath) -> UICollectionViewLayoutAttributes?
method

finalLayoutAttributesForDisappearingItem

TypeScript
finalLayoutAttributesForDisappearingItem(itemIndexPath: _Foundation_IndexPath): Promise<(UICollectionViewLayoutAttributes) | null>
Swift declaration
func finalLayoutAttributesForDisappearingItem(at itemIndexPath: IndexPath) -> UICollectionViewLayoutAttributes?
method

finalLayoutAttributesForDisappearingSupplementaryElement

TypeScript
finalLayoutAttributesForDisappearingSupplementaryElement(elementKind: string, elementIndexPath: _Foundation_IndexPath): Promise<(UICollectionViewLayoutAttributes) | null>
Swift declaration
func finalLayoutAttributesForDisappearingSupplementaryElement(ofKind elementKind: String, at elementIndexPath: IndexPath) -> UICollectionViewLayoutAttributes?
method

finalizeAnimatedBoundsChange

TypeScript
finalizeAnimatedBoundsChange(): Promise<void>
Swift declaration
func finalizeAnimatedBoundsChange()
method

finalizeCollectionViewUpdates

TypeScript
finalizeCollectionViewUpdates(): Promise<void>
Swift declaration
func finalizeCollectionViewUpdates()
method · iOS 7.0+

finalizeLayoutTransition

TypeScript
finalizeLayoutTransition(): Promise<void>
Swift declaration
func finalizeLayoutTransition()
method · iOS 7.0+

indexPathsToDeleteForDecorationView

TypeScript
indexPathsToDeleteForDecorationView(elementKind: string): Promise<Array<_Foundation_IndexPath>>
Swift declaration
func indexPathsToDeleteForDecorationView(ofKind elementKind: String) -> [IndexPath]
method · iOS 7.0+

indexPathsToDeleteForSupplementaryView

TypeScript
indexPathsToDeleteForSupplementaryView(elementKind: string): Promise<Array<_Foundation_IndexPath>>
Swift declaration
func indexPathsToDeleteForSupplementaryView(ofKind elementKind: String) -> [IndexPath]
method · iOS 7.0+

indexPathsToInsertForDecorationView

TypeScript
indexPathsToInsertForDecorationView(elementKind: string): Promise<Array<_Foundation_IndexPath>>
Swift declaration
func indexPathsToInsertForDecorationView(ofKind elementKind: String) -> [IndexPath]
method · iOS 7.0+

indexPathsToInsertForSupplementaryView

TypeScript
indexPathsToInsertForSupplementaryView(elementKind: string): Promise<Array<_Foundation_IndexPath>>
Swift declaration
func indexPathsToInsertForSupplementaryView(ofKind elementKind: String) -> [IndexPath]
init · iOS 6.0+

init

TypeScript
static init(): Promise<UICollectionViewLayout>
Swift declaration
init()
init · iOS 6.0+

init

TypeScript
static initCoder(coder: _Foundation_NSCoder): Promise<(UICollectionViewLayout) | null>
Swift declaration
init?(coder: NSCoder)
method

initialLayoutAttributesForAppearingDecorationElement

TypeScript
initialLayoutAttributesForAppearingDecorationElement(elementKind: string, decorationIndexPath: _Foundation_IndexPath): Promise<(UICollectionViewLayoutAttributes) | null>
Swift declaration
func initialLayoutAttributesForAppearingDecorationElement(ofKind elementKind: String, at decorationIndexPath: IndexPath) -> UICollectionViewLayoutAttributes?
method

initialLayoutAttributesForAppearingItem

TypeScript
initialLayoutAttributesForAppearingItem(itemIndexPath: _Foundation_IndexPath): Promise<(UICollectionViewLayoutAttributes) | null>
Swift declaration
func initialLayoutAttributesForAppearingItem(at itemIndexPath: IndexPath) -> UICollectionViewLayoutAttributes?
method

initialLayoutAttributesForAppearingSupplementaryElement

TypeScript
initialLayoutAttributesForAppearingSupplementaryElement(elementKind: string, elementIndexPath: _Foundation_IndexPath): Promise<(UICollectionViewLayoutAttributes) | null>
Swift declaration
func initialLayoutAttributesForAppearingSupplementaryElement(ofKind elementKind: String, at elementIndexPath: IndexPath) -> UICollectionViewLayoutAttributes?
method · iOS 6.0+

invalidateLayout

TypeScript
invalidateLayout(): Promise<void>
Swift declaration
func invalidateLayout()
method · iOS 7.0+

invalidateLayout

TypeScript
invalidateLayoutWith(context: UICollectionViewLayoutInvalidationContext): Promise<void>
Swift declaration
func invalidateLayout(with context: UICollectionViewLayoutInvalidationContext)
method · iOS 7.0+

invalidationContext

TypeScript
invalidationContextForBoundsChange(newBounds: { x: number; y: number; width: number; height: number }): Promise<UICollectionViewLayoutInvalidationContext>
Swift declaration
func invalidationContext(forBoundsChange newBounds: CGRect) -> UICollectionViewLayoutInvalidationContext
method · iOS 9.0+

invalidationContextForEndingInteractiveMovementOfItems

TypeScript
invalidationContextForEndingInteractiveMovementOfItems(indexPaths: Array<_Foundation_IndexPath>, previousIndexPaths: Array<_Foundation_IndexPath>, movementCancelled: boolean): Promise<UICollectionViewLayoutInvalidationContext>
Swift declaration
func invalidationContextForEndingInteractiveMovementOfItems(toFinalIndexPaths indexPaths: [IndexPath], previousIndexPaths: [IndexPath], movementCancelled: Bool) -> UICollectionViewLayoutInvalidationContext
method · iOS 9.0+

invalidationContext

TypeScript
invalidationContextForInteractivelyMovingItemsWithTargetPositionPreviousIndexPathsPreviousPosition(targetIndexPaths: Array<_Foundation_IndexPath>, targetPosition: { x: number; y: number }, previousIndexPaths: Array<_Foundation_IndexPath>, previousPosition: { x: number; y: number }): Promise<UICollectionViewLayoutInvalidationContext>
Swift declaration
func invalidationContext(forInteractivelyMovingItems targetIndexPaths: [IndexPath], withTargetPosition targetPosition: CGPoint, previousIndexPaths: [IndexPath], previousPosition: CGPoint) -> UICollectionViewLayoutInvalidationContext
method · iOS 8.0+

invalidationContext

TypeScript
invalidationContextForPreferredLayoutAttributesWithOriginalAttributes(preferredAttributes: UICollectionViewLayoutAttributes, originalAttributes: UICollectionViewLayoutAttributes): Promise<UICollectionViewLayoutInvalidationContext>
Swift declaration
func invalidationContext(forPreferredLayoutAttributes preferredAttributes: UICollectionViewLayoutAttributes, withOriginalAttributes originalAttributes: UICollectionViewLayoutAttributes) -> UICollectionViewLayoutInvalidationContext
method

layoutAttributesForDecorationView

TypeScript
layoutAttributesForDecorationView(elementKind: string, indexPath: _Foundation_IndexPath): Promise<(UICollectionViewLayoutAttributes) | null>
Swift declaration
func layoutAttributesForDecorationView(ofKind elementKind: String, at indexPath: IndexPath) -> UICollectionViewLayoutAttributes?
method

layoutAttributesForElements

TypeScript
layoutAttributesForElements(rect: { x: number; y: number; width: number; height: number }): Promise<(Array<UICollectionViewLayoutAttributes>) | null>
Swift declaration
func layoutAttributesForElements(in rect: CGRect) -> [UICollectionViewLayoutAttributes]?
method · iOS 9.0+

layoutAttributesForInteractivelyMovingItem

TypeScript
layoutAttributesForInteractivelyMovingItem(indexPath: _Foundation_IndexPath, position: { x: number; y: number }): Promise<UICollectionViewLayoutAttributes>
Swift declaration
func layoutAttributesForInteractivelyMovingItem(at indexPath: IndexPath, withTargetPosition position: CGPoint) -> UICollectionViewLayoutAttributes
method

layoutAttributesForItem

TypeScript
layoutAttributesForItem(indexPath: _Foundation_IndexPath): Promise<(UICollectionViewLayoutAttributes) | null>
Swift declaration
func layoutAttributesForItem(at indexPath: IndexPath) -> UICollectionViewLayoutAttributes?
method

layoutAttributesForSupplementaryView

TypeScript
layoutAttributesForSupplementaryView(elementKind: string, indexPath: _Foundation_IndexPath): Promise<(UICollectionViewLayoutAttributes) | null>
Swift declaration
func layoutAttributesForSupplementaryView(ofKind elementKind: String, at indexPath: IndexPath) -> UICollectionViewLayoutAttributes?
method

prepare

TypeScript
prepareForAnimatedBoundsChange(oldBounds: { x: number; y: number; width: number; height: number }): Promise<void>
Swift declaration
func prepare(forAnimatedBoundsChange oldBounds: CGRect)
method

prepare

TypeScript
prepareForCollectionViewUpdates(updateItems: Array<UICollectionViewUpdateItem>): Promise<void>
Swift declaration
func prepare(forCollectionViewUpdates updateItems: [UICollectionViewUpdateItem])
method · iOS 7.0+

prepareForTransition

TypeScript
prepareForTransitionFrom(oldLayout: UICollectionViewLayout): Promise<void>
Swift declaration
func prepareForTransition(from oldLayout: UICollectionViewLayout)
method · iOS 7.0+

prepareForTransition

TypeScript
prepareForTransitionTo(newLayout: UICollectionViewLayout): Promise<void>
Swift declaration
func prepareForTransition(to newLayout: UICollectionViewLayout)
method

prepare

TypeScript
prepare(): Promise<void>
Swift declaration
func prepare()
method · iOS 6.0+

register

TypeScript
registerForDecorationViewOfKind(viewClass: (string) | null, elementKind: string): Promise<void>
Swift declaration
func register(_ viewClass: AnyClass?, forDecorationViewOfKind elementKind: String)
method · iOS 6.0+

register

TypeScript
registerForDecorationViewOfKind4172(nib: (UINib) | null, elementKind: string): Promise<void>
Swift declaration
func register(_ nib: UINib?, forDecorationViewOfKind elementKind: String)
method

shouldInvalidateLayout

TypeScript
shouldInvalidateLayoutForBoundsChange(newBounds: { x: number; y: number; width: number; height: number }): Promise<boolean>
Swift declaration
func shouldInvalidateLayout(forBoundsChange newBounds: CGRect) -> Bool
method · iOS 8.0+

shouldInvalidateLayout

TypeScript
shouldInvalidateLayoutForPreferredLayoutAttributesWithOriginalAttributes(preferredAttributes: UICollectionViewLayoutAttributes, originalAttributes: UICollectionViewLayoutAttributes): Promise<boolean>
Swift declaration
func shouldInvalidateLayout(forPreferredLayoutAttributes preferredAttributes: UICollectionViewLayoutAttributes, withOriginalAttributes originalAttributes: UICollectionViewLayoutAttributes) -> Bool
method · iOS 7.0+

targetContentOffset

TypeScript
targetContentOffsetForProposedContentOffset(proposedContentOffset: { x: number; y: number }): Promise<{ x: number; y: number }>
Swift declaration
func targetContentOffset(forProposedContentOffset proposedContentOffset: CGPoint) -> CGPoint
method

targetContentOffset

TypeScript
targetContentOffsetForProposedContentOffsetWithScrollingVelocity(proposedContentOffset: { x: number; y: number }, velocity: { x: number; y: number }): Promise<{ x: number; y: number }>
Swift declaration
func targetContentOffset(forProposedContentOffset proposedContentOffset: CGPoint, withScrollingVelocity velocity: CGPoint) -> CGPoint
method · iOS 9.0+

targetIndexPath

TypeScript
targetIndexPath(previousIndexPath: _Foundation_IndexPath, position: { x: number; y: number }): Promise<_Foundation_IndexPath>
Swift declaration
func targetIndexPath(forInteractivelyMovingItem previousIndexPath: IndexPath, withPosition position: CGPoint) -> IndexPath
get · iOS 6.0+

collectionView

TypeScript
get collectionView(): Promise<(UICollectionView) | null>
Swift declaration
var collectionView: UICollectionView? { get }
get

collectionViewContentSize

TypeScript
get collectionViewContentSize(): Promise<{ width: number; height: number }>
Swift declaration
var collectionViewContentSize: CGSize { get }
get

developmentLayoutDirection

TypeScript
get developmentLayoutDirection(): Promise<UIUserInterfaceLayoutDirection>
Swift declaration
var developmentLayoutDirection: UIUserInterfaceLayoutDirection { get }
get

flipsHorizontallyInOppositeLayoutDirection

TypeScript
get flipsHorizontallyInOppositeLayoutDirection(): Promise<boolean>
Swift declaration
var flipsHorizontallyInOppositeLayoutDirection: Bool { get }

Skipped declarations

No declarations were skipped in this snapshot.

All UIKit types →