The object model is the cornerstone for scripting customized interfaces (dashboards). The object model and Script Editor provide access to all levels of Interactive Reporting.
The object model is a hierarchical representation of Interactive Reporting and the Interactive Reporting Web Client objects and the actions (methods) and attributes (properties) that are used to manipulate the objects.
Objects include applications, documents, sections, limits, connections, graphics, controls, catalog items, topics, request lines, results columns, chart labels, pivot-side labels, facts, menu bars, status bars, toolbars, and so on.
Methods include create, activate, open, close, save, add, copy, remove, process, export, recalculate, and so on. For example, data-results objects (database-query results or tables that contain results data) have a recalculate method, which refreshes (recalculates) data based on updated parameters.
Properties include object names, values, alignments, colors, and so on. You can view properties or set (modify) the values of properties. For example, all graphics objects have a visible property—if set to true, an object is visible, and, if set to false, an object is invisible.
Table 219. Object Model Terminology
Term | Definition | Example | Interactive Reporting Example |
|---|---|---|---|
Items perceived as entities | Tree, leaf, fruit | Application, Section, Document | |
Actions that are executed when an object receives messages | Grow, bear fruit, drop leaves | Activate, Copy, Add | |
Qualities or distinctive features (attributes) | Name, color, growing pattern | Active, Visible, Type | |
Groups of objects | Grove | Documents | |
Values that do not change or vary | Number | Constants |
Typically, the object model is manipulated by JavaScript from inside dashboard sections and used to build self-contained analytic applications. On Windows systems, the object model is also accessible through the automation interfaces (OLE Automation) that enable Interactive Reporting to be controlled by external applications that can make OLE Automation calls (such as Excel or, VB).