bga-cards
    Preparing search index...

    Interface AllVisibleDeckSettings<T>

    interface AllVisibleDeckSettings<T> {
        autoPlace?: (card: T) => boolean;
        cardClickEventFilter?: CardClickEventFilter;
        counter?: CardCounterSettings;
        direction?: "vertical" | "horizontal";
        horizontalShift?: string;
        lastPlayedCardStyle?: SelectionStyle;
        selectableCardStyle?: SelectionStyle;
        selectedCardStyle?: SelectionStyle;
        shift?: string;
        sort?: SortFunction<T>;
        unselectableCardStyle?: SelectionStyle;
        verticalShift?: string;
    }

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index

    Properties

    autoPlace? cardClickEventFilter? counter? direction? horizontalShift? lastPlayedCardStyle? selectableCardStyle? selectedCardStyle? shift? sort? unselectableCardStyle? verticalShift?

    Properties

    autoPlace?: (card: T) => boolean

    Say if a given card should be placed on this stock, based on card properties. For example, every card with location === 'hand' and location_arg == this.player_id should go to the current player hand. If unset, all cards on this stock must be added manually on this stock.

    Type declaration

      • (card: T): boolean

      • Parameters

        • card: T

          the card to place on a stock

        Returns boolean

        true if the card should be placed on this stock.

    cardClickEventFilter?: CardClickEventFilter

    The filter on card click event. Use setting from manager is unset.

    counter?: CardCounterSettings

    Show a card counter on the stock. Not visible if unset.

    direction?: "vertical" | "horizontal"

    The direction when it expands (default 'vertical')

    horizontalShift?: string

    The horizontal shift between each card (default 3). Overrides shift.

    lastPlayedCardStyle?: SelectionStyle

    The style to apply to the last played card. Default to class 'bga-cards_last-played-card'.

    selectableCardStyle?: SelectionStyle

    The style to apply to selectable cards. Use style from manager is unset.

    selectedCardStyle?: SelectionStyle

    The style to apply to selected cards. Use style from manager is unset.

    shift?: string

    The shift between each card (default 3). Will be ignored if verticalShift and horizontalShift are set.

    sort?: SortFunction<T>

    Indicate the card sorting (unset means no sorting, new cards will be added at the end). For example, use sort: sortFunction('type', '-type_arg') to sort by type then type_arg (in reversed order if prefixed with -). Be sure you typed the values correctly! Else '11' will be before '2'.

    unselectableCardStyle?: SelectionStyle

    The style to apply to selectable cards. Use style from manager is unset.

    verticalShift?: string

    The vertical shift between each card (default 3). Overrides shift.

    Settings

    Member Visibility

    On This Page

    Properties