Skip to main content

Deck

The Deck object provides access to the Digideck's Deck state, behavior, and subscribe to deck events

Properties​

id​

Description​

  • Returns a string of the decks unique id.

Return Value: String​

Code Example​

digideckCore.deck.id;

organizationId​

Description​

Return Value: String​

Code Example​

digideckCore.deck.organizationId;

subdomain​

Description​

  • Returns subdomain of the deck's organization.

Return Value: String​

Code Example​

digideckCore.deck.subdomain;

name​

Description​

  • Returns the name of the deck.

Return Value: String​

Code Example​

digideckCore.deck.name;

isActive​

Description​

  • Returns a boolean of the decks active state. Returns true if deck is ready.

Return Value: Boolean​

Code Example​

digideckCore.deck.isActive;

Description​

  • Returns the URL for the deck logo.

Return Value: String​

Code Example​

digideckCore.deck.logo;

Description​

  • Returns the inverted logo of a deck.

Return Value: String​

Code Example​

digideckCore.deck.invertedLogo;

element​

Description​

  • Returns the deck HTML element.

Return Value: HTML Element​

Code Example​

digideckCore.deck.element;

ddLiveDeckDomain​

Description​

  • Returns the DD LIVE deck domain attribute.

Return Value: String​

Code Example​

digideckCore.deck.ddLiveDeckDomain;

ddLiveSocketConnectionString​

Description​

  • Returns the DD LIVE socket connection string attribute.

Return Value: String​

Code Example​

digideckCore.deck.ddLiveSocketConnectionString;

ddLivePublicPath​

Description​

  • Returns the DD LIVE public path attribute..

Return Value: String​

Code Example​

digideckCore.deck.ddLivePublicPath;

ddLiveApiPath​

Description​

  • Returns the DD LIVE API path attribute.

Return Value: String​

Code Example​

digideckCore.deck.ddLiveApiPath;

isMobileLayoutsEnabled​

Description​

  • Returns whether the deck/presentation will display a different layout for smaller screens.

Return Value: Boolean​

Code Example​

digideckCore.deck.isMobileLayoutsEnabled;

videoPlayerFramework​

Description​

  • Returns Which video player framework the deck/presentation will use to display videos. Current options are jwplayer or videoJs player.

Return Value: String​

Code Example​

digideckCore.deck.videoPlayerFramework;

globalSlideTransitions​

Description​

  • Returns the Deck's global slide transition configuration for the deck. This configuration allows you to set consistent transition animations across all slides in the deck.

Return Value: Object​

The returned object has the following properties:

PropertyTypeDefaultDescription
isEnabledbooleanfalseWhether global slide transitions are enabled
animationTypestring'none'The type of animation to use. Valid values are: 'none', 'slide', 'fade'
animationDirectionstring'horizontal'The direction of the animation. Valid values are: 'horizontal', 'vertical'
animationDurationnumber0.3The duration of the animation in seconds
animationDelaynumber0The delay before the animation starts in seconds
animationEasestring'linear'The easing function for the animation

Code Example​

// Get the current global slide transitions configuration
const transitions = digideckCore.deck.globalSlideTransitions;

// Configure global slide transitions
digideckCore.deck.globalSlideTransitions = {
    isEnabled: true,
    animationType: 'slide',
    animationDirection: 'horizontal',
    animationDuration: 0.5,
    animationDelay: 0,
    animationEase: 'ease-in-out'
};

Notes​

  • Global slide transitions are only applied when isEnabled is set to true
  • The animation settings are applied to all slides in the deck
  • Presentation globalSlideTransitions take presedence over Deck when set

globalDataStoreDataManagement​

Description​

  • Returns the Deck's global data store data management configuration. This configuration allows you to manage and synchronize data across components in the deck.

Return Value: Object​

The returned object has the following properties:

PropertyTypeDefaultDescription
isEnabledbooleanfalseWhether global data store data management is enabled
categoriesArray[]Array of category configurations for data management

Each category in the categories array has the following properties:

PropertyTypeDescription
isGlobalbooleanWhether the category data should be managed at the deck level (true) or presentation level (false)
categorystringThe category key for the data store

Code Example​

// Get the current global data store data management configuration
const dataManagement = digideckCore.deck.globalDataStoreDataManagement;

// Configure global data store data management
digideckCore.deck.globalDataStoreDataManagement = {
    isEnabled: true,
    categories: [
        { isGlobal: true, category: 'visibility' },
        { isGlobal: false, category: 'inputs' }
    ]
};

Notes​

  • Global data store data management is only applied when isEnabled is set to true
  • When isGlobal is true, data is managed at the deck level and shared across all presentations
  • When isGlobal is false, data is managed at the presentation level and is specific to each presentation
  • Presentation globalDataStoreDataManagement takes precedence over Deck when set