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/get_yaxis.sl.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 get_yaxis Context: sl.chips

Synopsis

Retrieves the attribute value(s) of the y-axis.

Syntax

get_yaxis();
get_yaxis(id [,attribute]);

Description

  • id - an optional ChipsId structure containing values to modify the currency state for the command or a string id to specify a y-axis within the current plot.
  • attribute - a string containing the name of the attribute to retrieve

The get_yaxis command returns a structure containing all the attribute values of the y-axis. To retrieve the value of a specific attribute, provide the attribute name and the id or ChipsId of the object.

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.

The attributes associated with axes are:

Attribute Description
automin Should the axis automatically reset its minimum when a curve/contour/histogram is added?
automax Should the axis automatically reset its maximum when a curve/contour/histogram is added?
color Color of the axis base line segment
depth Integer value indicating axis depth
label.angle Angle of the axis label
label.color Color of the axis label
label.font Font for the axis label text
label.fontstyle Style of the axis label text
label.halign Horizontal location of the axis label
label.size Font size of the axis label
label.valign Vertical location of the axis label
label.visible Is the label visible or hidden?
majortick.color The color to use for major ticks
majortick.count Default number of ticks to display when major mode is count
majortick.interval Spacing to use between ticks when major mode is interval
majortick.length Length of major ticks
majortick.mode Mode of the axis tickmark positioning
majortick.style Style of the axis tickmarks
majortick.thickness Thickness of major ticks
majortick.visible Are major ticks visible or hidden?
majorgrid.color Color of the axis major grids
majorgrid.style Stipple pattern used to draw the axis major grids
majorgrid.thickness Thickness of the axis major grids
majorgrid.visible Should major grids be visible?
minortick.color The color to use for minor ticks
minortick.count Default number of ticks to display when minor mode is count
minortick.interval Spacing to use between ticks when minor mode is interval
minortick.length Length of minor ticks
minortick.mode Mode of the axis tickmark positioning
minortick.style Style of the axis tickmarks
minortick.thickness Thickness of minor ticks
minortick.visible Are minor ticks visible or hidden?
minorgrid.color Color of the axis minor grids
minorgrid.style Stipple pattern used to draw the axis minor grids
minorgrid.thickness Thickness of the axis minor grids
minorgrid.visible Should minor grids be visible?
offset.parallel Axis label offset from axis start (-.5) to axis end (.5)
offset.perpendicular Axis label offset from axis baseline in pixels
pad The percentage of padding to add to an axis in arbitrary|limits|interval modes
thickness Thickness of the axis
tickformat Print format for axis ticklabels
ticklabel.angle Angle of the axis ticklabel
ticklabel.color Color of the axis ticklabels
ticklabel.font Font for the axis ticklabel text
ticklabel.fontstyle Style of the axis ticklabel text
ticklabel.halign Horizontal location of the axis ticklabel
ticklabel.offset Offset of ticklabels to axis base (in pixels)
ticklabel.size Font size of the axis ticklabel
ticklabel.style Style of the axis ticklabels
ticklabel.valign Vertical location of the axis ticklabel
ticklabel.visible Is the ticklabel visible or hidden?

Example 1

chips> add_axis(Y_AXIS, 20, 0, 100, "color=yellow");
chips> print(get_yaxis());
chips> print(get_yaxis("ay1","color"));

An axis is created and becomes current. Calling get_yaxis with no argument returns all the attributes of the object. get_yaxis is called a second time to return just the "color" attribute.

Example 2

chips> add_axis(Y_AXIS, 20, 0, 100, "color=yellow");
chips> add_axis(XY_AXIS, 40, 0, 100,"color=magenta");
chips> print(get_yaxis("ay1"));

Two axes are created. get_yaxis is called with the id of the first y-axis, returning all attributes.

Example 3

chips> id=ChipsId();
chips> id.yaxis="ay1";
chips> print(get_yaxis(id));

A ChipsId structure is created and the id.yaxis field is set to "ay1". get_yaxis is called with the ChipsId.

Example 4

chips> ayatt=get_yaxis;
chips> print(ayatt);

Retrieve a structure containing the attribute values of the current yaxis and store the results in "ayatt". Print the contents of "ayatt".

Bugs

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

See Also

sl.chips
add_axis, bind_axes, current_axis, delete_axis, display_axis, get_axis, get_xaxis, hide_axis, hide_major_ticks, hide_minor_ticks, linear_scale, log_scale, move_axis, reverse_axes, set_axis, set_current, set_xaxis, set_yaxis, setget, show_major_ticks, show_minor_ticks, shuffle_axis, unbind_axes
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.