Examples of Interactive Reporting Studio Objects

In Interactive Reporting Studio, documents are accessed through the scripting environment as a hierarchy of objects. For example, the Interactive Reporting Studio button object contains these properties and methods.

Table 3. Button Object Properties and Methods

Characteristic

Type

Description

Alignment

Property

Align text on button face—left, right, center

Enabled

Property

Availability of objects to be clicked

Font

Property

Style of text displayed on a button face (an object in its own right that contains its own characteristics)

Name

Property

Programmatically addressed object name

OnClick

Method

Event handler called when button is clicked

Text

Property

Text displayed on button face

Type

Property

Type of object (for example, bqButton)

Vertical Alignment

Property

Align text on button face—top, bottom, middle

Visible

Property

Visibility of a button

The Font object described in the table also contains these properties.

Table 4. Font Properties

Property

Example

Color

Red, blue, black

Effect

Superscript, subscript

Name

Arial, Times New Roman

Size

10pt, 12pt

Style

Bold, italic

A collection is another type of object supported by Interactive Reporting Studio and JavaScript. Collections usually contain a count property to calculate how many elements are included as parts. A collection contains one or more methods, and provides a way of enabling access to the elements, to add elements, and other generic facilities to sanction change to the state of the collection. Different types of collections may behave differently.

The Interactive Reporting Studio application object is a collection that contains one or more documents including one or more sections. Each section contains other objects specific to it. For example, queries include a data model, a Request line, and a Filter line. Filters include show values and custom values lists, and custom SQL.

Each object contains unique methods and properties that enable you to leverage the object functionality.