Skip to main content

Digideck

The Digideck object provides access to the Digideck's state and behavior

Properties​

environment​

Description​

  • Returns the current environment: local, dev, staging or prod. defaults to prod.

Return Value: local | dev | staging | prod​

Code Example​

let env = digideckCore.digideck.environment;

coreApiUrl​

Description​

  • Returns URL string for Digideck's web api.

Return Value: String​

Code Example​

let apiURL = digideckCore.digideck.webApi;
warning

DEPRECATED: use coreApiUrl instead

webApi​

  • same as coreApiUrl - DEPRECATED

isEditMode​

warning

DEPRECATED: use isOpenInEditor instead

Description​

  • Returns a true or false value depending on if is in edit mode.

Return Value: Boolean​

Code Example​

let isEditMode = digideckCore.digideck.isEditMode;

isOpenInEditor​

Description​

  • Returns a true or false value depending on if currently in the editor.

Return Value: Boolean​

Code Example​

let isOpenInEditor = digideckCore.digideck.isOpenInEditor;

isLayoutMode​

Description​

  • Returns a true or false value depending on if is in layout mode in the editor.

Return Value: Boolean​

Code Example​

let isLayoutMode = digideckCore.digideck.isLayoutMode;

isPdf​

Description​

  • Returns a true or false value depending on if the presentation is rendered as a PDF.

Return Value: Boolean​

Code Example​

let isPdf = digideckCore.digideck.isPdf;

currentFullPath​

Description​

  • Returns the current hash path of the chapter/slide.

Return Value: String​

Code Example​

let fullPath = digideckCore.digideck.currentFullPath; // ex: "/chapter-title/slide-title"

currentChapterPath​

Description​

  • Returns the path for the currently showing/active chapter. returning null if it's the Root Slide

Return Value: String​

Code Example​

let currentChapterPath = digideckCore.digideck.currentChapterPath;

isMenuHidden​

Description​

  • Returns a true or false value depending on if a menu is hidden from the presentation.

Return Value: Boolean​

Code Example​

let isMenuHidden = digideckCore.digideck.isMenuHidden;

isDraggableBackgroundDisabled​

Description​

  • Returns a true or false value depending on if the draggable-background functionality is disabled.

Return Value: Boolean​

Code Example​

let isDraggableBackgroundDisabled = digideckCore.digideck.isDraggableBackgroundDisabled;

isContentEditingDisabled​

Description​

  • Returns a true or false value depending on if content editing on a presentation is disabled.

Return Value: Boolean​

Code Example​

let isContentEditingDisabled = digideckCore.digideck.isContentEditingDisabled;

isRenderingForPdfWebScreenShot​

Description​

  • Returns a true or false value depending on if the the presentation is in pdf screenshot mode.

Return Value: Boolean​

Code Example​

let isRenderingForPdfWebScreenShot = digideckCore.digideck.isRenderingForPdfWebScreenShot;

isRenderingForWebScreenShot​

Description​

  • Returns a true or false value depending on if the the presentation is in web screenshot mode.

Return Value: Boolean​

Code Example​

let isRenderingForWebScreenShot = digideckCore.digideck.isRenderingForWebScreenShot;

isAnimationsStopped​

Description​

  • Returns a true or false value depending on if presentation animations are stopped.

Return Value: Boolean​

Code Example​

let isAnimationsStopped = digideckCore.digideck.isAnimationsStopped;

isAnalyticsTracked​

Description​

  • Returns a true or false value depending on if impression data for the presentation/slide is tracked.

Return Value: Boolean​

Code Example​

let isAnalyticsTracked = digideckCore.digideck.isAnalyticsTracked;

isEditorReady​

Description​

  • Returns a true or false value depending on whether the presentation/deck editor is ready.

Return Value: Boolean​

Code Example​

digideckCore.digideck.isEditorReady = true;

digideckCore.digideck.isEditorReady;
// true

Methods​

onEditorReady(callback)​

Description​

  • Subscribes to onEditorReady event. The callback is invoked when the deck/presentation editor in the Angular UI is ready.
    • This is useful for when you need to send a message to be received by the angular editor and need to ensure the editor is ready to receive your message (e.g. if you want to send a message when a component renders).

Return Value: null​

Options:​

  • callback: Function Invoked when the presentation/deck editor is ready.

Code Example​

digideckCore.lazyLoadingService.onEditorReady(() => {
    // code to be executed
});