Class HandStock<T>

The abstract stock. It shouldn't be used directly, use stocks that extends it.

Type Parameters

Hierarchy (view full)

CardStock<T>
- HandStock

Constructors

constructor

new HandStock<T>(manager, element, settings): HandStock<T>
Type Parameters
- T
Parameters
- manager: CardManager<T>
- element: HTMLElement
- settings: HandStockSettings
Returns HandStock<T>
Overrides CardStock.constructor
- Defined in src/stocks/hand-stock.ts:21

Properties

`Protected` cards

cards: T[] = []

`Protected` element

element: HTMLElement

the stock element (should be an empty HTML Element)

`Protected` inclination

inclination: number

`Protected` manager

manager: CardManager<T>

the card manager

`Optional` onCardClick

onCardClick?: ((card) => void)

Called when selection change. Returns the clicked card.

card: the clicked card (can be selected or unselected)

Type declaration

- (card): void
- Called when selection change. Returns the clicked card.
  
  card: the clicked card (can be selected or unselected)
  Parameters
  - card: T
  Returns void

`Optional` onSelectionChange

onSelectionChange?: ((selection, lastChange) => void)

Called when selection change. Returns the selection.

selection: the selected cards of the stock
lastChange: the last change on selection card (can be selected or unselected)

Type declaration

- (selection, lastChange): void
- Called when selection change. Returns the selection.
  
  selection: the selected cards of the stock
  lastChange: the last change on selection card (can be selected or unselected)
  Parameters
  - selection: T[]
  - lastChange: T
  Returns void

`Protected` selectedCards

selectedCards: T[] = []

`Protected` selectionMode

selectionMode: CardSelectionMode = 'none'

`Protected` `Optional` sort

sort?: SortFunction

Methods

addCard

addCard(card, animation?, settings?): Promise<boolean>
Add a card to the stock.
Parameters
- card: T
  the card to add
- Optional animation: CardAnimation<T>
  a CardAnimation object
- Optional settings: AddCardSettings
  a AddCardSettings object
Returns Promise<boolean>
the promise when the animation is done (true if it was animated, false if it wasn't)
Overrides CardStock.addCard
- Defined in src/stocks/hand-stock.ts:31

`Protected` addCardElementToParent

addCardElementToParent(cardElement, settings?): void
Parameters
- cardElement: HTMLElement
- Optional settings: AddCardSettings
Returns void
Inherited from CardStock.addCardElementToParent
- Defined in src/stocks/card-stock.ts:254

addCards

addCards(cards, animation?, settings?, shift?): Promise<boolean>
Add an array of cards to the stock.
Parameters
- cards: T[]
  the cards to add
- Optional animation: CardAnimation<T>
  a CardAnimation object
- Optional settings: AddCardSettings
  a AddCardSettings object
- shift: number | boolean = false
  if number, the number of milliseconds between each card. if true, chain animations
Returns Promise<boolean>
Inherited from CardStock.addCards
- Defined in src/stocks/card-stock.ts:332

`Protected` animationFromElement

animationFromElement(element, fromRect, settings): Promise<boolean>
Parameters
- element: HTMLElement
  The element to animate. The element is added to the destination stock before the animation starts.
- fromRect: DOMRect
- settings: CardAnimationSettings
Returns Promise<boolean>
Inherited from CardStock.animationFromElement
- Defined in src/stocks/card-stock.ts:586

`Protected` bindClick

bindClick(): void
Returns void
Inherited from CardStock.bindClick
- Defined in src/stocks/card-stock.ts:554

`Protected` canAddCard

canAddCard(card, settings?): boolean
Checks if the card can be added. By default, only if it isn't already present in the stock.
Parameters
- card: T
  the card to add
- Optional settings: AddCardSettings
  the addCard settings
Returns boolean
if the card can be added
Inherited from CardStock.canAddCard
- Defined in src/stocks/card-stock.ts:151

`Protected` cardClick

cardClick(card): void
Parameters
- card: T
Returns void
Inherited from CardStock.cardClick
- Defined in src/stocks/card-stock.ts:568

cardRemoved

cardRemoved(card, settings?): void
Notify the stock that a card is removed.
Parameters
- card: T
  the card to remove
- Optional settings: RemoveCardSettings
  a RemoveCardSettings object
Returns void
Overrides CardStock.cardRemoved
- Defined in src/stocks/hand-stock.ts:39

contains

contains(card): boolean
Parameters
- card: T
  a card
Returns boolean
if the card is present in the stock
Inherited from CardStock.contains
- Defined in src/stocks/card-stock.ts:132

flipCard

flipCard(card, settings?): void
Flips the card.
Parameters
- card: T
  the card informations
- Optional settings: FlipCardSettings
Returns void
Inherited from CardStock.flipCard
- Defined in src/stocks/card-stock.ts:624

getCardElement

getCardElement(card): HTMLElement
Parameters
- card: T
  a card in the stock
Returns HTMLElement
the HTML element generated for the card
Inherited from CardStock.getCardElement
- Defined in src/stocks/card-stock.ts:140

getCards

getCards(): T[]
Returns T[]
the cards on the stock
Inherited from CardStock.getCards
- Defined in src/stocks/card-stock.ts:103

`Protected` getNewCardIndex

getNewCardIndex(card): number
Parameters
- card: T
Returns number
Inherited from CardStock.getNewCardIndex
- Defined in src/stocks/card-stock.ts:238

getSelectableCardClass

getSelectableCardClass(): string
Returns string
the class to apply to selectable cards. Use class from manager is unset.
Inherited from CardStock.getSelectableCardClass
- Defined in src/stocks/card-stock.ts:631

getSelectedCardClass

getSelectedCardClass(): string
Returns string
the class to apply to selected cards. Use class from manager is unset.
Inherited from CardStock.getSelectedCardClass
- Defined in src/stocks/card-stock.ts:645

getSelection

getSelection(): T[]
Returns T[]
the selected cards
Inherited from CardStock.getSelection
- Defined in src/stocks/card-stock.ts:117

getUnselectableCardClass

getUnselectableCardClass(): string
Returns string
the class to apply to selectable cards. Use class from manager is unset.
Inherited from CardStock.getUnselectableCardClass
- Defined in src/stocks/card-stock.ts:638

isEmpty

isEmpty(): boolean
Returns boolean
if the stock is empty
Inherited from CardStock.isEmpty
- Defined in src/stocks/card-stock.ts:110

isSelected

isSelected(card): boolean
Parameters
- card: T
Returns boolean
the selected cards
Inherited from CardStock.isSelected
- Defined in src/stocks/card-stock.ts:124

`Protected` moveFromElement

moveFromElement(card, cardElement, animation, settings?): Promise<boolean>
Parameters
- card: T
- cardElement: HTMLElement
- animation: CardAnimation<T>
- Optional settings: AddCardSettings
Returns Promise<boolean>
Inherited from CardStock.moveFromElement
- Defined in src/stocks/card-stock.ts:292

`Protected` moveFromOtherStock

moveFromOtherStock(card, cardElement, animation, settings?): Promise<boolean>
Parameters
- card: T
- cardElement: HTMLElement
- animation: CardAnimation<T>
- Optional settings: AddCardSettings
Returns Promise<boolean>
Inherited from CardStock.moveFromOtherStock
- Defined in src/stocks/card-stock.ts:264

remove

remove(): void
Removes the stock and unregister it on the manager.

Returns void
Inherited from CardStock.remove
- Defined in src/stocks/card-stock.ts:95

removeAll

removeAll(settings?): Promise<boolean>
Remove all cards from the stock.
Parameters
- Optional settings: RemoveCardSettings
  a RemoveCardSettings object
Returns Promise<boolean>
Inherited from CardStock.removeAll
- Defined in src/stocks/card-stock.ts:411

removeCard

removeCard(card, settings?): Promise<boolean>
Remove a card from the stock.
Parameters
- card: T
  the card to remove
- Optional settings: RemoveCardSettings
  a RemoveCardSettings object
Returns Promise<boolean>
Inherited from CardStock.removeCard
- Defined in src/stocks/card-stock.ts:367

removeCards

removeCards(cards, settings?): Promise<boolean>
Remove a set of card from the stock.
Parameters
- cards: T[]
  the cards to remove
- Optional settings: RemoveCardSettings
  a RemoveCardSettings object
Returns Promise<boolean>
Inherited from CardStock.removeCards
- Defined in src/stocks/card-stock.ts:401

removeSelectionClasses

removeSelectionClasses(card): void
Parameters
- card: T
Returns void
Inherited from CardStock.removeSelectionClasses
- Defined in src/stocks/card-stock.ts:649

removeSelectionClassesFromElement

removeSelectionClassesFromElement(cardElement): void
Parameters
- cardElement: HTMLElement
Returns void
Inherited from CardStock.removeSelectionClassesFromElement
- Defined in src/stocks/card-stock.ts:653

selectAll

selectAll(silent?): void
Select all cards
Parameters
- silent: boolean = false
Returns void
Inherited from CardStock.selectAll
- Defined in src/stocks/card-stock.ts:530

selectCard

selectCard(card, silent?): void
Set selected state to a card.
Parameters
- card: T
  the card to select
- silent: boolean = false
Returns void
Inherited from CardStock.selectCard
- Defined in src/stocks/card-stock.ts:482

setCardVisible

setCardVisible(card, visible, settings?): void
Set the card to its front (visible) or back (not visible) side.
Parameters
- card: T
  the card informations
- visible: boolean
- Optional settings: FlipCardSettings
Returns void
Inherited from CardStock.setCardVisible
- Defined in src/stocks/card-stock.ts:615

`Protected` setSelectableCard

setSelectableCard(card, selectable): void
Parameters
- card: T
- selectable: boolean
Returns void
Inherited from CardStock.setSelectableCard
- Defined in src/stocks/card-stock.ts:439

setSelectableCards

setSelectableCards(selectableCards?): void
Set the selectable class for each card.
Parameters
- Optional selectableCards: T[]
  the selectable cards. If unset, all cards are marked selectable. Default unset.
Returns void
Inherited from CardStock.setSelectableCards
- Defined in src/stocks/card-stock.ts:465

setSelectionMode

setSelectionMode(selectionMode, selectableCards?): void
Set if the stock is selectable, and if yes if it can be multiple. If set to 'none', it will unselect all selected cards.
Parameters
- selectionMode: CardSelectionMode
  the selection mode
- Optional selectableCards: T[]
  the selectable cards (all if unset). Calls setSelectableCards method
Returns void
Inherited from CardStock.setSelectionMode
- Defined in src/stocks/card-stock.ts:423

unselectAll

unselectAll(silent?): void
Unelect all cards
Parameters
- silent: boolean = false
Returns void
Inherited from CardStock.unselectAll
- Defined in src/stocks/card-stock.ts:545

unselectCard

unselectCard(card, silent?): void
Set unselected state to a card.
Parameters
- card: T
  the card to unselect
- silent: boolean = false
Returns void
Inherited from CardStock.unselectCard
- Defined in src/stocks/card-stock.ts:512

`Protected` updateAngles

updateAngles(): void
Returns void
- Defined in src/stocks/hand-stock.ts:45

Class HandStock<T>

Type Parameters

T

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

Parameters

manager: CardManager<T>

element: HTMLElement

settings: HandStockSettings

Returns HandStock<T>

Properties

Protected cards

Protected element

Protected inclination

Protected manager

Optional onCardClick

Type declaration

Parameters

card: T

Returns void

Optional onSelectionChange

Type declaration

Parameters

selection: T[]

lastChange: T

Returns void

Protected selectedCards

Protected selectionMode

Protected Optional sort

Methods

addCard

Parameters

card: T

Optional animation: CardAnimation<T>

Optional settings: AddCardSettings

Returns Promise<boolean>

Protected addCardElementToParent

Parameters

cardElement: HTMLElement

Optional settings: AddCardSettings

Returns void

addCards

Parameters

cards: T[]

Optional animation: CardAnimation<T>

Optional settings: AddCardSettings

shift: number | boolean = false

Returns Promise<boolean>

Protected animationFromElement

Parameters

element: HTMLElement

fromRect: DOMRect

settings: CardAnimationSettings

Returns Promise<boolean>

Protected bindClick

Returns void

Protected canAddCard

Parameters

card: T

Optional settings: AddCardSettings

Returns boolean

Protected cardClick

Parameters

card: T

Returns void

cardRemoved

Parameters

card: T

Optional settings: RemoveCardSettings

Returns void

contains

Parameters

card: T

`Protected` cards

`Protected` element

`Protected` inclination

`Protected` manager

`Optional` onCardClick

`Optional` onSelectionChange

`Protected` selectedCards

`Protected` selectionMode

`Protected` `Optional` sort

`Optional` animation: CardAnimation<T>

`Optional` settings: AddCardSettings

`Protected` addCardElementToParent

`Optional` settings: AddCardSettings

`Optional` animation: CardAnimation<T>

`Optional` settings: AddCardSettings

`Protected` animationFromElement

`Protected` bindClick

`Protected` canAddCard

`Optional` settings: AddCardSettings

`Protected` cardClick

`Optional` settings: RemoveCardSettings

`Optional` settings: FlipCardSettings

`Protected` getNewCardIndex

`Protected` moveFromElement

`Optional` settings: AddCardSettings

`Protected` moveFromOtherStock

`Optional` settings: AddCardSettings

`Optional` settings: RemoveCardSettings

`Optional` settings: RemoveCardSettings

`Optional` settings: RemoveCardSettings