(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
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.
The UserValues object is effective for:
Data that is temporary and needs to be saved and reused. For example, if you have a Dashboard form that collects parameters from the user by way of various controls (combo boxes, list boxes, etc.), use the UserValues object to recall the settings for the end user the next time the user accesses the document.
External software that recognizes a Interactive Reporting Studio or Interactive Reporting Web Client document format. In this case, the UserValue object could be used to pass information into the document for use when the document is opened. The persistence of values also enables the external software programs to use the information as data intrinsically relevant.
OLE-enabled external software. The UserValues object can use the Object Model to store data in an Interactive Reporting document (.bqy) document, which can be used in turn when the document is opened to control the behavior of the document. On the other hand, documents can store data that can be ready by OLE-enabled software and used to alter the program’s behavior accordingly.
Add(String Name, [optional] String Value), Item(Value NameOrIndex), RemoveAll
UserValue object