Hosanna UI API v1.30.2-next
    Preparing search index...

    Interface IBaseCollectionViewRow

    Interface for a collection view row. Extends IReusable and IIdentifiable.

    interface IBaseCollectionViewRow {
        _cacheKey?: string;
        _hid?: string;
        calculatedHeight: number;
        canPeekInto: boolean;
        canReceiveFocus?: boolean;
        cellPadding: number;
        cellSettingsKey: string;
        cellSize: [number, number];
        clippingRect: [number, number, number, number];
        container: ISGNGroup;
        content: ICollectionViewDataSourceRow;
        contentId?: string;
        currentSelectedTab?: string;
        floatingFocusAreaWidth: number;
        focusedIndex: number;
        focusSettings: ICollectionViewFocusSettings;
        focusStrategy: CollectionViewRowFocusStrategy;
        focusTarget?: IHosannaView<ViewState>;
        headerHeight: number;
        headerSettings: ICollectionViewHeaderSettings;
        horizontalDirectionMultiplier?: number;
        id: string;
        index: number;
        initialHeight?: number;
        isEnabled?: boolean;
        isFocusable?: boolean;
        isHidden?: boolean;
        isOnScreen: boolean;
        isVariableWidth?: boolean;
        lastRenderedY: number;
        loadingCellStyleKey: string;
        numCols: number;
        overlaysContainer: ISGNGroup;
        parent?: ICollectionView;
        parentSectionName: string;
        parentTabGroupName: string;
        peekAheadHeight: number;
        readingDirection?: ReadingDirection;
        renderedListPosition: number;
        rowState: RowState;
        screenYPosition: number;
        sectionHeader: boolean;
        sectionName: string;
        selectedIndex: number;
        showFocusFootprint?: boolean;
        showSelectedStyles: boolean;
        tabGroupName: string;
        tabGroupSelector: boolean;
        targetIndex: number;
        useMixedCellStyleKeys?: boolean;
        useMixedFocusSettings?: boolean;
        viewportWidth: number;
        xOffset: number;
        canHandleHorizontalPointerScroll(): boolean;
        getCellForIndex(itemIndex: number): undefined | ICollectionViewCell;
        getCellHeightForIndex(index: number): number;
        getCellWidthForIndex(index: number): number;
        getFocusInfo(itemIndex: number): undefined | IFocusInfo;
        getLogicalHorizontalDirection(direction: number): number;
        getLogicalIndexForPhysicalIndex(index: number, itemCount: number): number;
        getPhysicalHorizontalDirection(direction: number): number;
        getPhysicalIndexForLogicalIndex(index: number, itemCount: number): number;
        getPointerItemIndex(localX: number, localY: number, rowTop: number): number;
        onWillRelease(): void;
        onWillReuse(): void;
        updateCellsViewStatus(prevIndex: number, newIndex: number): void;
        updateConfiguration(data: Partial<IRowConfigurationData>): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    _cacheKey? _hid? calculatedHeight canPeekInto canReceiveFocus? cellPadding cellSettingsKey cellSize clippingRect container content contentId? currentSelectedTab? floatingFocusAreaWidth focusedIndex focusSettings focusStrategy focusTarget? headerHeight headerSettings horizontalDirectionMultiplier? id index initialHeight? isEnabled? isFocusable? isHidden? isOnScreen isVariableWidth? lastRenderedY loadingCellStyleKey numCols overlaysContainer parent? parentSectionName parentTabGroupName peekAheadHeight readingDirection? renderedListPosition rowState screenYPosition sectionHeader sectionName selectedIndex showFocusFootprint? showSelectedStyles tabGroupName tabGroupSelector targetIndex useMixedCellStyleKeys? useMixedFocusSettings? viewportWidth xOffset

    Methods

    canHandleHorizontalPointerScroll? getCellForIndex getCellHeightForIndex? getCellWidthForIndex getFocusInfo getLogicalHorizontalDirection? getLogicalIndexForPhysicalIndex? getPhysicalHorizontalDirection? getPhysicalIndexForLogicalIndex? getPointerItemIndex? onWillRelease? onWillReuse? updateCellsViewStatus updateConfiguration

    Properties

    Optional_cacheKey

    _cacheKey?: string

    Optional_hid

    _hid?: string
    calculatedHeight: number

    The calculated height of the row.

    canPeekInto: boolean

    Whether to peek into the row.

    canReceiveFocus?: boolean

    Whether the row can receive focus (for custom views).

    cellPadding: number

    The padding of the cell.

    cellSettingsKey: string

    The style key for the cell.

    cellSize: [number, number]

    The size of the cell.

    clippingRect: [number, number, number, number]

    The clipping rectangle for the row.

    container: ISGNGroup

    The container group node for the row.

    content

    content: ICollectionViewDataSourceRow

    The content data for the row.

    contentId?: string
    currentSelectedTab?: string

    The selected tab for the row.

    floatingFocusAreaWidth: number

    The width of the floating focus area for this row.

    focusedIndex: number

    The currently focused item index in the row.

    focusSettings: ICollectionViewFocusSettings

    The focus settings of the row.

    focusStrategy: CollectionViewRowFocusStrategy

    The focus strategy for the row.

    focusTarget?: IHosannaView<ViewState>

    The view to receive focus, if any.

    headerHeight: number

    The header height of the row.

    headerSettings: ICollectionViewHeaderSettings

    The header settings of the row.

    horizontalDirectionMultiplier?: number

    Cached multiplier for converting physical horizontal movement to logical movement.

    id: string
    index: number

    The index of the row in the collection view.

    initialHeight?: number

    The initial height of the row.

    isEnabled?: boolean

    Whether the row is enabled.

    isFocusable?: boolean

    Whether the row is focusable.

    isHidden?: boolean

    Whether the row is hidden.

    isOnScreen: boolean

    Whether the row is currently on screen.

    isVariableWidth?: boolean

    Whether cells in this row have variable widths (for HorizontalRow).

    lastRenderedY: number

    The last rendered Y position.

    loadingCellStyleKey: string

    The style key for the loading cell.

    numCols: number

    The number of columns in the row.

    overlaysContainer: ISGNGroup

    The container group node for the overlays.

    parent?: ICollectionView

    The parent collection view.

    parentSectionName: string

    The name of the parent section.

    parentTabGroupName: string

    The name of the parent tab group.

    peekAheadHeight: number

    The height to peek into the row.

    readingDirection?: ReadingDirection

    Horizontal reading order resolved for this row. Optional for backwards-compatible structural row implementations; concrete Hosanna rows always provide it and layouts normalize legacy rows to LTR once when assigned.

    renderedListPosition: number
    rowState: RowState

    The current state of the row.

    screenYPosition: number

    The screen Y position of the row.

    sectionHeader: boolean

    Whether the row is a section header.

    sectionName: string

    The section name for the row.

    selectedIndex: number

    The index of the selected item in the row.

    showFocusFootprint?: boolean

    Whether to show the focus footprint for the row.

    showSelectedStyles: boolean

    Whether to apply selected styles to the row cells.

    tabGroupName: string

    The name of the tab group.

    tabGroupSelector: boolean

    Whether the row is a tab group selector.

    targetIndex: number
    useMixedCellStyleKeys?: boolean

    When true, each non-loading entry in the row's items array may set its own cellSettingsKey, so different cells in the same row resolve to different instance-pool keys and styles. When false, the row's IRowConfigurationData.cellSettingsKey applies to every non-loading cell.

    useMixedFocusSettings?: boolean

    When true, items in the row may provide focusSettings overrides used only when focus info is requested for that item. When false, the row's IRowConfigurationData.focusSettings is used directly.

    viewportWidth: number

    The width of the viewport for this row.

    xOffset: number

    The content offset of the row.

    Methods

    • Whether this row can consume horizontal pointer wheel/trackpad scrolling.

      Returns boolean

    • Gets the height for a specific cell index. Supports variable height cells.

      Parameters

      • index: number

      Returns number

    • Gets the width for a specific cell index. Supports variable width cells.

      Parameters

      • index: number

      Returns number

    • Gets focus info for a given item index.

      Parameters

      • itemIndex: number

      Returns undefined | IFocusInfo

    • Converts physical Left/Right input into logical previous/next movement.

      Parameters

      • direction: number

      Returns number

    • Converts a physical item slot to its stable logical item index.

      Parameters

      • index: number
      • itemCount: number

      Returns number

    • Converts logical previous/next movement into physical Left/Right movement.

      Parameters

      • direction: number

      Returns number

    • Converts a stable logical item index to its physical item slot.

      Parameters

      • index: number
      • itemCount: number

      Returns number

    • Gets the item index under a pointer point in collection-view local coordinates.

      Parameters

      • localX: number
      • localY: number
      • rowTop: number

      Returns number

    • Updates the view status of cells when focus changes.

      Parameters

      • prevIndex: number
      • newIndex: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods