Property Types

The following lists the
data types used within this specification. The JavaScript types below are the
types of the design-time information. See the specification if there is an
additional run-time type. (For example, an expression is a string at design
time, but will evaluate to a string or integer or other value at runtime.)

A property can be a list:
in this case the property is a list of values such as structures, strings, etc.

Property Lists

A list property is defined as being a �list of x� where x can be one of the
simple data types, or one of the structures defined below. A list property is
represented as an array in JavaScript. For example, the list of custom colors
for a report design is represented by a list property. The following obtains the
structure that defines the third custom color:

var colorDefn = designDefn.palette[ 2 ];

A property list is composed of a series of values. In general, the values
appear in the list in the same order that they appear in the report design XML
file, which generally reflects the order in which they were created in the UI.

Details

Display Name:

choice

Since:

1.0

XML Name:

choice

JavaScript Design Type:

JavaScript Runtime Type:

Description

The choice property type indicates that a property provides a fixed set of
choices. Any property of this type must also provide a separate list of the
choices. The list of choices is defined as a separate named "choice set."

Details

Description

Details

Display Name:

dimension

Since:

1.0

XML Name:

dimension

JavaScript Design Type:

JavaScript Runtime Type:

Description

A CSS dimension. The units are expressed as a floating point number such as
�1.25�. To override that default, specify a suffix as one of �in� (inches), �mm�
(millimeters), �cm� (centimeters), �pt� (points), �pc� (picas), �%� (percent),
�em� (�em� size for the current font) or �ex� (�ex� size for the current font.)

A dimension is a physical measurement. Dimensions always have a unit.
Supported units include the following defined in CSS:

Unit Suffix

Meaning

cm

Centimeters

in

Inches

mm

Millimeters

pt

Points (1/72 of an inch)

pc

Pica (1 pica is equal to 12 points)

px

Pixels. (For print, see the CSS spec. A
pixel is about 0.21 mm.)

em

ems, the height of the element's font

ex

x-height, the height of the letter 'x'

%

Percentage. The definition of each property identifies the container
property from which the value is computed.

Details

The name field of a structure within a property defined as a structure list.

Details

Display Name:

name

Since:

1.0

XML Name:

name

JavaScript Design Type:

JavaScript Runtime Type:

Description

Identifies a property within a structure that provides the name to be used
for associative lookup in property lists.

Associative Property Lists

All property lists allow numeric indexes. Some also allow associative lookup
using the name of an item in the list. For example, to look up the custom color:
�seaGreen�:

var colorDefn = designDefn.palette.seaGreen

or,

var colorDefn = designDefn.palette[ �seaGreen� ]

The first form can be used when the name to be looked up is known when the
code is written, and follow the JavaScript identifier naming rules. The second
form can be used to look up a value when the value is not known ahead of time,
or when the name does not follow JavaScript identifier rules. For example: