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

    Interface ICollectionViewRowSettings

    Interface for row settings in a collection view. Extends IStyleDictionary.

    interface ICollectionViewRowSettings {
        canPeekInto?: boolean;
        cellSettingsKey?: string;
        cellSize?: [number, number];
        clippingRect?: [number, number, number, number];
        contentOffset?: [number, number];
        customViewType?: string;
        defaultSelectedTab?: string;
        epgStartTimeInSeconds?: roLongInteger;
        floatingFocusAreaWidth?: number;
        focusSettings?: ICollectionViewFocusSettings;
        focusStrategy?: CollectionViewRowFocusStrategy;
        headerSettings?: ICollectionViewHeaderSettings;
        height?: number;
        isFocusable?: boolean;
        isVariableWidth?: boolean;
        loadingCellStyleKey?: string;
        numCols?: number;
        parentSectionName?: string;
        parentTabGroupName?: string;
        peekAheadHeight?: number;
        readingDirection?: ReadingDirection;
        rowType?: string;
        screenPosition?: [number, number];
        sectionHeader?: boolean;
        sectionName?: string;
        selectTriggers?: TriggerEntry[];
        showFocusFootprint?: boolean;
        showSelectedStyles?: boolean;
        spacing?: number;
        supportsDynamicWidth?: boolean;
        tabGroupName?: string;
        tabGroupSelector?: boolean;
        useMixedCellStyleKeys?: boolean;
        useMixedFocusSettings?: boolean;
        viewportWidth?: number;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    canPeekInto? cellSettingsKey? cellSize? clippingRect? contentOffset? customViewType? defaultSelectedTab? epgStartTimeInSeconds? floatingFocusAreaWidth? focusSettings? focusStrategy? headerSettings? height? isFocusable? isVariableWidth? loadingCellStyleKey? numCols? parentSectionName? parentTabGroupName? peekAheadHeight? readingDirection? rowType? screenPosition? sectionHeader? sectionName? selectTriggers? showFocusFootprint? showSelectedStyles? spacing? supportsDynamicWidth? tabGroupName? tabGroupSelector? useMixedCellStyleKeys? useMixedFocusSettings? viewportWidth?

    Properties

    canPeekInto?: boolean

    Whether to peek into the row.

    cellSettingsKey?: string

    Key for cell settings within the row.

    cellSize?: [number, number]

    Size of the cell.

    clippingRect?: [number, number, number, number]

    Clipping rectangle for the row.

    contentOffset?: [number, number]

    Offset for content within the row.

    customViewType?: string

    Class name of the custom view to use, if any.

    defaultSelectedTab?: string

    The default selected tab.

    epgStartTimeInSeconds?: roLongInteger

    The EPG start time in seconds.

    floatingFocusAreaWidth?: number

    The width of the floating focus area for this row.

    focusSettings?: ICollectionViewFocusSettings

    Focus-specific styling options.

    focusStrategy?: CollectionViewRowFocusStrategy

    The focus strategy for the row.

    headerSettings?: ICollectionViewHeaderSettings

    Optional header settings.

    height?: number

    Height of the row.

    isFocusable?: boolean

    Whether the row is focusable.

    isVariableWidth?: boolean

    Whether cells in this row have variable widths (each cell can have its own width). Only applies to HorizontalRow.

    loadingCellStyleKey?: string

    Key for loading cell settings within the row.

    numCols?: number

    Number of columns in the row.

    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

    Optional row override for the collection view's reading order.

    rowType?: string

    Type of the row.

    screenPosition?: [number, number]

    Position on screen for focused row.

    sectionHeader?: boolean

    Whether the row is a section header.

    sectionName?: string

    The name of the section.

    selectTriggers?: TriggerEntry[]

    DSL triggers that activate when this row/item is selected or focused.

    showFocusFootprint?: boolean

    Whether to show the focus footprint for the row.

    showSelectedStyles?: boolean

    Whether to apply selected styles to the row.

    spacing?: number

    Space between items.

    supportsDynamicWidth?: boolean

    Whether this row supports dynamic width adjustments.

    tabGroupName?: string

    The name of the tab group.

    tabGroupSelector?: boolean

    Whether the row is a tab group selector.

    useMixedCellStyleKeys?: boolean

    When true, each non-loading item in the row's items array may set its own cellSettingsKey, so cells within one row can use different style keys from the pool. When false or omitted, the row-level ICollectionViewRowSettings.cellSettingsKey applies to all non-loading cells.

    useMixedFocusSettings?: boolean

    When true, items in the row may provide focusSettings overrides used only for the item currently producing focus info. When false or omitted, the row-level ICollectionViewRowSettings.focusSettings applies to every cell.

    viewportWidth?: number

    The width of the viewport for this row.

    Settings

    Member Visibility

    On This Page

    Properties