ida global object¶
Each HTML package has information about the slide that it is currently in injected into its global context under the namespace ida. This is actually a alias to full namespace of uk.co.idetailaid.
Namespaces
The main namespace injected into the HTML global context is uk.co.idetailaid.
For convenience, the following alias is also created if available: ida.
To access the uk.co.idetailaid.Viewer API, another alias is created if available : Viewer.
If your HTML package code already defines the aliases ida or Viewer, then you must use the full namespace to access the API.
uk.co.idetailaid.Viewer.api.goBack();
else you can use the shorthand aliases:
ida.Viewer.api.goBack();
Viewer.api.goBack();
For the rest of the documentation, we use the alias ida rather than the full namespace.
API¶
The ida object contains the following properties
| property | type | description |
|---|---|---|
| ida.Viewer | Viewer |
The main iDetailAid Viewer object |
| ida.slide.element | DOMElement |
The slide DOM element |
| ida.slide.x | int |
The column the slide is in in this presentation |
| ida.slide.y | int |
The row the slide is in in this presentation |
| ida.slide.slide | Slide |
The iDetailAid slide object, containing properties like id, title etc. |
| ida.slide.context | Object |
The public JavaScript of the slide containing this HTML package |
| ida.template.slide | Slide |
The iDetailAid template object. If the main slide is using a template. Containing properties like id, title etc. |
| ida.template.context | Object |
The public JavaScript of the template in use by the slide containing this HTML package |
| ida.iframe.trigger | Function |
A function that will trigger an event on the iFrame Content Area in the containing slide |