UserValues (Collection)

Member of:

(Live) BarChart, object, Bullet object, Document collection, (Live) FunnelChart object, (Live) LineChart, (Live) PieChart object, (Live) RadarChart object, Slider object, Speedometer object, Thermometer object, TrafficLight object

Description:

Enables you to create a user-defined or arbitrary value to an object in the Object Model. A user-defined value, in this context, is not explicitly defined in the Object Model or other software components of the product. It is a value defined solely by the Designers using the Object Model.

The user-defined value takes the form of a named string value. It is created from the JavaScript core object String. The individual characters in a string can range in value from 0 to 255.

Any user-defined value persists across uses of the document. That is, if the document is saved after a user-defined value has been created, the value is still present and accessible when the document is reopened.

This feature is available for Interactive Reporting documents to be deployed in the Interactive Reporting Studio, Interactive Reporting Web Client and the EPM Workspace. The persistence of user-defined values does not effect the EPM Workspace unless the end user chooses to save the document state. Persistence works with Interactive Reporting Web Client in all its modes.

Depending on the amount of data stored as a user-defined value with the document, Interactive Reporting may take extra time to read, write, compress and decompress.

For detailed information on how to add and maintaining user-defined values through the Object Model, see Adding and Maintaining the UserValue Object.

Uses:

The UserValues object is effective for:

Methods:

Add(String Name, [optional] String Value), Item(Value NameOrIndex), RemoveAll

Properties:

Read-only: Count as Number

Objects:

UserValue object