Presentation

The Presentation object provides access to the Digideck's Presentation state.

Properties

id

Description

• Returns the presentation's unique id.

Return Value: String

Code Example

digideckCore.presentation.element;

logo

Description

• Returns the URL of the presentation's logo.

Return Value: String

Code Example

digideckCore.presentation.logo;

title

Description

• Returns the presentation's title.

Return Value: String

Code Example

digideckCore.presentation.title;

createdAtDate

Description

• Returns the presentation's created at date.

Return Value: String

Code Example

digideckCore.presentation.createdAtDate;

element

Description

• Returns the presentation's element.

Return Value: HTML Element

Code Example

digideckCore.presentation.element;

Methods

getHotspotOrientationImageById

Description

• Returns the URL for the image to be used for a specific Hotspot Orientation via the ID of the Hotspot Orientation.

Options:

• hotspotOrientationId: String Id of hotspot orientation you want image for.

Return Value: String

Code Example

digideckCore.presentation.getHotspotOrientationImageById('id-of-hotspot-orientation');

globalSlideTransitions

Description

• Returns the presentation'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:

Property	Type	Default	Description
isEnabled	boolean	false	Whether global slide transitions are enabled
animationType	string	'none'	The type of animation to use. Valid values are: 'none', 'slide', 'fade'
animationDirection	string	'horizontal'	The direction of the animation. Valid values are: 'horizontal', 'vertical'
animationDuration	number	0.3	The duration of the animation in seconds
animationDelay	number	0	The delay before the animation starts in seconds
animationEase	string	'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 Presentation's global data store data management configuration. This configuration allows you to manage and synchronize data across components in the presentation.

Return Value: Object

The returned object has the same structure as the Deck's globalDataStoreDataManagement:

Property	Type	Default	Description
isEnabled	boolean	false	Whether global data store data management is enabled
categories	Array	[]	Array of category configurations for data management

Each category in the categories array has the following properties:

Property	Type	Description
isGlobal	boolean	Whether the category data should be managed at the deck level (true) or presentation level (false)
category	string	The category key for the data store

Code Example

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

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

Notes

• Presentation globalDataStoreDataManagement takes precedence over Deck's configuration when set
• When both Deck and Presentation configurations are set, the Presentation configuration will be used
• Data managed at the presentation level (isGlobal: false) is specific to each presentation instance
• Data managed at the deck level (isGlobal: true) is shared across all presentations in the deck