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

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


AHELP for CIAO 4.9 ChIPS v1

get_preference

Context: preference

Synopsis

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

Syntax

get_preference(name)

Description

The function arguments.

Argument Description
name A string giving either an object name, such as 'curve', 'line', or 'export', or a single attribute, such as 'curve.line.style' or 'export.clobber'.

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.

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 2013
Smithsonian Institute Smithsonian Institute

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