Chandra X-Ray Observatory (CXC)
Skip to the navigation links
Last modified: December 2012

URL: http://cxc.harvard.edu/chips/get_preference.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.5 ChIPS v1

get_preference

Context: preference

Synopsis

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

Syntax

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 an object attribute is not 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".

Example 1

chips> print(get_preference("plot"))

Print all the preferences for the plot object.

Example 2

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

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

Example 3

chips> crv = get_preference("curve")
chips> print(crv)

Store the preferences for the curve object in the variable "crv". Print the contents of "crv".

Bugs

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

See Also

concepts
preferences, setget
preference
get_preferences, load_preferences, save_preferences, set_preference, set_preference_autoload, set_preferences
utilities
set_current

Last modified: December 2012
CXC logo

The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory. 60 Garden Street, Cambridge, MA 02138 USA.   Email: cxcweb@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2012. All rights reserved.