About Chandra Archive Proposer Instruments & Calibration Newsletters Data Analysis HelpDesk Calibration Database NASA Archives & Centers Chandra Science Links

Skip the navigation links
Search the ChIPS website
Last modified: December 2007

URL: http://cxc.harvard.edu/chips4.0/set_label.py.html

[ChIPS Logo]

Home page (ChIPS)
Help pages (AHELP)
List by alphabet
List by context
Jump to:
A B C D E G H I L M P R S T U
 
A
add_axis - py sl
add_contour - py sl
add_curve - py sl
add_frame - py sl
add_histogram - py sl
add_hline - py sl
add_label - py sl
add_line - py sl
add_plotarea - py sl
add_plot - py sl
add_point - py sl
add_region - py sl
add_vline - py sl
add_window - py sl
adjust_grid_gaps - py sl
adjust_grid_xrelsizes - py sl
adjust_grid_xrelsize - py sl
adjust_grid_yrelsizes - py sl
adjust_grid_yrelsize - py sl
attributes - py sl
 
B
bind_axes - py sl
 
C
check_server_exists - py sl
chipsid - py sl
chipsopt - py sl
chips
clear_errors - py sl
clear_plot - py sl
clear - py sl
collapse_depths - py sl
colors - py sl
connect - py sl
convert_coordinate - py sl
coordinates - py sl
create_server - py sl
currency - py sl
current_axis - py sl
current_contour - py sl
current_curve - py sl
current_frame - py sl
current_histogram - py sl
current_label - py sl
current_line - py sl
current_plot - py sl
current_point - py sl
current_region - py sl
current_window - py sl
 
D
deiconify_window - py sl
delete_axis - py sl
delete_contour - py sl
delete_curve - py sl
delete_frame - py sl
delete_histogram - py sl
delete_label - py sl
delete_line - py sl
delete_plot - py sl
delete_point - py sl
delete_region - py sl
delete_window - py sl
depthcontrol - py sl
disconnect - py sl
display_axis - py sl
display_contour - py sl
display_curve - py sl
display_depth - py sl
display_frame - py sl
display_histogram - py sl
display_label - py sl
display_line - py sl
display_plot - py sl
display_point - py sl
display_region - py sl
 
E
entitycreation - py sl
erase - py sl
 
G
get_attribute - py sl
get_axis - py sl
get_contour - py sl
get_curve - py sl
get_default_depth - py sl
get_errors - py sl
get_frame - py sl
get_histogram - py sl
get_label - py sl
get_line - py sl
get_pick - py sl
get_plot_range - py sl
get_plot - py sl
get_point - py sl
get_preferences - py sl
get_preference - py sl
get_region - py sl
get_server_id - py sl
get_window - py sl
get_xaxis - py sl
get_yaxis - py sl
grid_objects - py sl
 
H
hide_axis - py sl
hide_contour - py sl
hide_curve - py sl
hide_depth - py sl
hide_frame - py sl
hide_histogram - py sl
hide_label - py sl
hide_line - py sl
hide_major_ticks - py sl
hide_minor_ticks - py sl
hide_plot - py sl
hide_point - py sl
hide_region - py sl
 
I
iconify_window - py sl
info_bound_axes - py sl
info_coordinate - py sl
info_current - py sl
info_depth - py sl
info - py sl
 
L
limits - py sl
linear_scale - py sl
list_servers - py sl
load_font - py sl
load_preferences - py sl
load_state - py sl
lock - py sl
log_scale - py sl
 
M
make_figure - py sl
move_axis - py sl
move_frame - py sl
move_label - py sl
move_line - py sl
move_plot - py sl
move_point - py sl
move_region - py sl
move - py sl
 
P
pick - py sl
preferences - py sl
print_window - py sl
 
R
redo - py sl
reindex_depth - py sl
reposition_frame - py sl
reposition_plot - py sl
reverse_axes - py sl
 
S
save_preferences - py sl
save_state - py sl
setget - py sl
set_attribute - py sl
set_axis - py sl
set_cascading_property - py sl
set_contour - py sl
set_current - py sl
set_curve - py sl
set_default_depth - py sl
set_error_verbosity - py sl
set_frame - py sl
set_histogram - py sl
set_label - py sl
set_line - py sl
set_plot - py sl
set_point - py sl
set_preferences - py sl
set_preference_autoload - py sl
set_preference - py sl
set_region - py sl
set_window - py sl
set_xaxis - py sl
set_yaxis - py sl
show_major_ticks - py sl
show_minor_ticks - py sl
shuffle_axis - py sl
shuffle_backward - py sl
shuffle_back - py sl
shuffle_contour - py sl
shuffle_curve - py sl
shuffle_forward - py sl
shuffle_front - py sl
shuffle_histogram - py sl
shuffle_label - py sl
shuffle_line - py sl
shuffle_point - py sl
shuffle_region - py sl
shuffle - py sl
split - py sl
strip_chart - py sl
swap_object_positions - py sl
 
T
tile - py sl
 
U
unbind_axes - py sl
undo - py sl
unlock - py sl
 
Jump to:
A B C D E G H I L M P R S T U
Home page (ChIPS)
Help pages (AHELP)
List by alphabet
List by context
Jump to: Description Examples Bugs See Also

AHELP for ChIPS 4.0 set_label Context: py.chips

Synopsis

Modifies the attributes of an existing label.

Syntax

set_label([id,] values)

Description

  • id - an optional ChipsId structure containing values to modify the currency state for the command or a string id to modify a label within the current frame.
  • values - a list containing attribute value pairs or a ChipsLabel object.

The set_label command sets the specified attributes to the provided values. The modified label becomes current. Multiple labels may be modified with a single command by setting the currency to "all".

Customizing the Label

There are several attributes that control the characteristics of labels. The set_label command may be used to modify the attribute values of an existing label at any time during a ChIPS session. See "ahelp py.chips attributes" and "ahelp py.chips setget" for more general information.

If multiple attributes are being set simultaneously and one of them fails, the entire command will fail and the label will not be modified.

The attributes associated with labels are:

Attribute Description Options Default
angle Angle at which the label is drawn -360.0:360.0 0.0
color Color of the label text string see the Color section of "ahelp py.chips chipsopt" default
depth Integer value indicating label depth see the Depth section of "ahelp py.chips chipsopt" 100
font font for label text see the Fonts section of "ahelp py.chips chipsopt" helvetica
fontstyle style of the label text see the Font Style section of "ahelp py.chips chipsopt" normal
halign Horizontal location of the string reference point of the label see the Text Alignment section of "ahelp py.chips chipsopt" left
size Font size of the label 1:100 12
valign Vertical location of the string reference point of the label see the Text Alignment section of "ahelp py.chips chipsopt" base

These individual commands are also available for setting attribute values: 

set_label_angle
set_label_color
set_label_depth
set_label_font
set_label_fontstyle
set_label_halign
set_label_size
set_label_text
set_label_valign

Example 1

chips> set_label(["color","plum", "size", 16])

Using attribute/value pairs, set the label color to plum and font size to 16.

Example 2

chips> settings = ChipsLabel()
chips> settings.color = 'blue'
chips> settings.angle = 45
chips> settings.font = 'greek'
chips> set_label('lbl1',settings)

Populate the "settings" structure with the attribute values, then use it to set lbl1 to have blue text in the greek font at a 45 degree angle.

Example 3

chips> class labprop:
chips> def __init__(self):
chips> self.color='lime'
chips> self.fontstyle='italic'
chips> set_label(labprop())

Create a user-defined structure with color and fontstyle fields. Use the structure to modify the values of the current label.

Bugs

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

See Also

py.chips
add_label, current_label, delete_label, display_label, get_label, hide_label, load_font, move_label, set_current, setget, shuffle_label
Last modified: December 2007


Chandra Science | Chandra Home | Astronomy links | iCXC (CXC only) | Search


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-2004. All rights reserved.