get_preferences

Synopsis

Retrieves the preference value(s) for the specified object.

Syntax

get_preferences()
get_preference(object)
get_preference(object.attribute)

Description

object - an object type, such as plot, frame, or window.
object.attribute - an object type and a specific attribute, joined by a dot (.), e.g. "point.size".

The get_preference command retrieves the preference value(s) of the specified object. If no argument is given, all the preferences are returned. If an object is supplied, all preferences for that object are returned. To retrieve the preference value of a specific attribute, provide the object and attribute name, joined by a dot (.), e.g. "point.size".

Some values are set to "None" in the returned structure. These entries generally correspond to attributes which may only be modified at creation time, such as the object id.

Example 1

chips> print(get_preferences("plot"))

Print all the preferences for the plot object.

Example 2

chips> print(get_preferences("label.size"))

Retrieve and print the preference value for the size attribute of the label object.

Example 3

chips> allpref = get_preferences()
chips> print(allpref)

Store the preferences for all objects in the variable "allpref". Print the contents of "allpref".

Bugs

See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.