getSlide | structureJson , slideId [, systemSettings ] | Object of type NestedSlideData or undefined | To retrieve information about a single, specific slide, use this method |
getSlides | structureJson [, slideTypes [, systemSettings ]] | Array of objects of type NestedSlideData | Use this method to get information about all slides |
getSlidesAsync | structureJson [, slideTypes [, systemSettings [, callback ]]] | Array of objects of type NestedSlideData or any other Object | To get custom slide data objects or modify slide fields, use this method. The callback code will be called for all slides, including their subslides. |
getFlatSlides | structureJson [, slideTypes [, systemSettings ]] | Array of objects of type FlatSlideData | Similar to getSlides, but will return a set of slide objects without the "subslides" field - subslides will be returned along with the slides. Use isSubslide to distinguish between a slide and a subslide |
getVisibleSlides | structureJson [, systemSettings ] | Array of objects of type NestedSlideData | Similar to the getSlides method , but will only return slides of the "visible" type |
getFlatVisibleSlides | structureJson [, systemSettings ] | Array of objects of type FlatSlideData | Similar to the getFlatSlides method , but will only return slides of the "visible" type |
getHiddenSlides | structureJson [, systemSettings ] | Array of objects of type NestedSlideData | Similar to the getSlides method , but will only return slides of the "hidden" type |
getFlatHiddenSlides | structureJson [, systemSettings ] | Array of objects of type FlatSlideData | Similar to the getFlatSlides method , but will only return slides of the "visible" type |
getArchivedSlides | structureJson [, systemSettings ] | Array of objects of type NestedSlideData | Similar to the getSlides method , but will only return slides of the "archived" type |
getFlatSlide | structureJson , slideId [, systemSettings ] | Object of type FlatSlideData | To retrieve slide data (without the "subslides" field) or to check if a given slide is a subslide or to retrieve a parent slide, use this method. |
getChapters | structureJson [, chapterTypes ] | Array of objects of type ChapterData | Use this method to get a list of chapters and define their types. The order is determined by the order in the "chapters" field |
getHiddenChapters | structureJson | Array of objects of type ChapterData | Similar to the "getChapters" method, but it will only return "hidden" chapters |
getVisibleChapters | structureJson | Array of objects of type ChapterData | Similar to the "getChapters" method, but it will only return "visible" chapters |
getChapter | structureJson , chapterId | Object of type ChapterData or undefined | Use this method to get a chapter data or check if it exists |
getChapterSlides | structureJson , chapterId [, slideTypes [, systemSettings ]] | Array of objects of type NestedSlideData | Similar to the getSlides method , but will only return slides of the passed chapter |
getFlatChapterSlides | structureJson , chapterId [, slideTypes [, systemSettings ]] | Array of objects of type FlatSlideData | Similar to the getFlatSlides method , but will only return slides of the passed chapter |
getSlideSubslides | structureJson , slideId [, slideTypes [, systemSettings ]] | Array of objects of type SlideData | Use this method to get a subslide of a particular slide |
getStartSlide | structureJson [, systemSettings ] | Object of type StartSlide or undefined | Use to get a starting slide. If not specified explicitly in structure.json - it will return the first "visible" slide |
getStoryboard | structureJson [, chapterTypes [, systemSettings ]] | Array of objects of type NestedChapterData | Returns the list of chapters and slides in them, based on their order in the "storyboard" and "content" fields, respectively |
getStructureFileVersion | structureJson | number | Returns the file format number of the structure.json file |
convertToStructureV2 | structureJson | JSON of type StructureV2.iStructureJSON | Use when you want to convert structure.json content to version 2 |
makeStructure | nestedSlidesData , targetStructureVersion | JSON of type iStructureJSON | Accepts nestedSlidesData objects as input and builds structure.json content based on them |
supportsStructureV2 | ewizardjsVersion | boolean | Use if necessary to check if the version of "ewizardjs" transferred supports the structure of the second version. (Incompatible structure.json and content versions cause navigation problems, etc.) |