Struсture API

The e-Detailer structure is defined in the struсture.json file. You can access these settings using the struсture API methods on any slide or component in your e-Detailer project.

The struсture API exposes its methods with the this.$struсture context of a slide/component instance. The slide instance is in the ./slides directory. For example, the index.vue file. The component instance is in the ./node_modules/[wiz-component-name]/index.vue file.

The struсture API retrieves standard and custom fields for both struсture.json versions 1 and 2. The custom fields are shown in the custom object. For example, the response of the getSlides method:

Use the getRaw method to access the e-Detailer struсture in the raw format.

For usage examples, see getRaw.

Use the getSlides method to get an array of nested slide data: the chapter it belongs to, the subslides it has, whether it's visible, hidden, or archived.

For usage examples, see getSlides.

Use the getFlatSlides method to get an array of flat slide data: the chapter it belongs to, the subslides it has, whether it's visible, hidden, or archived.

For usage examples, see getFlatSlides.

Use the getVisibleSlides method to get nested data of all visible slides. The method doesn't retrieve hidden and archived slides.

For usage examples, see getVisibleSlides.

Use the getFlatVisibleSlides method to get flat data of all visible slides. The method doesn't retrieve hidden and archived slides.

For usage examples, see getFlatVisibleSlides.

Use the getHiddenSlides method to get nested data of all hidden slides. The method doesn't retrieve visible and archived slides.

For usage examples, see getHiddenSlides.

Use the getFlatHiddenSlides method to get flat data of all hidden slides. The method doesn't retrieve visible and archived slides.

For usage examples, see getFlatHiddenSlides.

Use the getArchivedSlides method to get nested data of all archived slides. The method doesn't retrieve visible and hidden slides.

For usage examples, see getArchivedSlides.

Use the getSlide method to get nested data of a specific slide. The method retrieves visible, hidden, and archived slides.

[SLIDE_ID] is the ID of a specific slide.

For usage examples, see getSlide.

Use the getFlatSlide method to get flat data of a specific slide. The method retrieves visible, hidden, and archived slides.

[SLIDE_ID] is the ID of a specific slide.

For usage examples, see getFlatSlide.

Use the getChapters method to get nested data of all chapters in the struсture.json file. The method retrieves visible, hidden, and archived chapters.

For usage examples, see getChapters.

Use the getHiddenChapters method to get nested data of all hidden chapters in the struсture.json file. The method doesn't retrieve visible and archived chapters.

For usage examples, see getHiddenChapters.

Use the getVisibleChapters method to get nested data of all visible chapters in the struсture.json file. The method doesn't retrieve hidden and archived chapters.

For usage examples, see getVisibleChapters.

Use the getChapter method to get data about a specific chapter in the struсture.json file. The method retrieves visible, hidden, and archived chapters.

[CHAPTER_ID] is the ID of a specific chapter.

For usage examples, see getChapter.

Use the getChapterSlides method to get data about all slides of a specific chapter. The method retrieves visible, hidden, and archived slides.

[CHAPTER_ID] is the ID of a specific chapter.

For usage examples, see getChapterSlides.

Use the getSlideSubslides method to get data about all subslides of a specific slide. The method retrieves visible, hidden, and archived subslides.

[SLIDE_ID] is the ID of a specific slide.

For usage examples, see getSlideSubslides.

Use the getStartSlide method to get the data of the starting slide. The method retrieves the slide from the start object of the struсture.json file. If the start object isn't defined, the method retrieves the first visible slide from the first chapter.

For usage examples, see getStartSlide.

Use the getStoryboard method to get data about all the chapters and their slides that belong to the storyboard.

For usage examples, see getStoryboard.

Use the getStruсtureFileVersion method to get the data about the struсture.json file version.

For usage examples, see getStruсtureFileVersion.