|AHELP for CIAO 4.5 ChIPS v1||
Modifies the attributes of an existing plot.
- id - an optional ChipsId structure containing values to modify the currency state for the command or a string id to modify the specified plot.
- values - a list containing attribute value pairs or a ChipsPlot object.
The set_plot command sets the specified attributes to the provided values. The modified plot becomes current. Multiple plots may be modified with a single command by setting the currency to "all".
There are several attributes that control the characteristics of plots. The set_plot command may be used to modify the attribute values of an existing plot at any time during a ChIPS session. See "ahelp attributes" and "ahelp setget" for more general information.
If multiple attributes are being set simultaneously and one of them fails, the entire command will fail and the plot will not be modified.
Please see the section "Plot Preferences and Attributes" below the examples for a list of the plot attributes.
The plot title and axis labels are not controlled by an attribute of the set_plot command. They are specified with the set_plot_title, set_plot_xlabel, and set_plot_ylabel commands:
chips> set_plot_title("Figure 1") chips> set_plot_xlabel("TIME (s)") chips> set_plot_ylabel("COUNT\_RATE (count/s)")
The value is an alphanumeric string; Latex formatting is allowed. There are many attributes to customize the title via the set_plot command: position, depth, horizontal and vertical alignment, angle, color, size, font and fontstyle.
To customize the appearance of X and Y labels (color, font, size, and alignment), the set_axis command is used: "ahelp set_axis" .
Plot borders have three styles: open, box, and closed.
- open: a plot with no borders
- box: a plot with four simple lines as borders
- closed: a plot with four border lines and tick marks
The corners where two lines meet have four styles: miter, bevel, fill, and notch.
- miter: the end of the axes meet at an angle to form the corner. The slope where the two faces join depends upon the thickness of the two lines
- bevel: connect the outside corners of the two lines; miter the inside faces to the bevel
- fill: outside corner with one line drawn over the other
- notch: leave the corners open
The module of advanced ChIPS functions contains other commands for setting attribute values (refer to "ahelp chips" for information on loading the module):
set_plot_aspect_ratio set_plot_axisstyle set_plot_bottommargin set_plot_cornerstyle set_plot_leftmargin set_plot_rightmargin set_plot_title_angle set_plot_title_color set_plot_title_depth set_plot_title_font set_plot_title_fontstyle set_plot_title_halign set_plot_title_size set_plot_title_valign set_plot_title_xpos set_plot_title_ypos set_plot_topmargin
chips> set_plot(["style", "box"])
Using attribute/value pairs, set the plot style to box.
chips> plt = ChipsPlot() chips> plt.style = "box" chips> plt.corner.style = "bevel" chips> set_plot("plot1", plt)
Populate the "plt" structure with attribute values, then use it to set plot1 to have a box border style with beveled corners.
The attributes associated with plots are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_plot() command. To change the plot preference settings prepend "plot." to the attribute name.
|bottommargin||The distance, in Frame Normalized coordinates, between the bottom plot border and the bottom border of the frame containing the plot||Real values ranging from zero through one||0.15||Yes|
|corner.style||border corner style||miter|bevel|fill|notch; see "ahelp set_plot" for descriptions||miter||Yes|
|leftmargin||The distance, in Frame Normalized coordinates, between the left plot border and the left border of the frame containing the plot||Zero through one||0.15||Yes|
|rightmargin||The distance, in Frame Normalized coordinates, between the right plot border and the right border of the frame containing the plot||Real values ranging from zero through one||0.10||Yes|
|stem||stem used for plot id||An alpha-numeric character sequence that does not contain a space||plt||No|
|style||border style||open|box|closed; see "ahelp add_plot" for descriptions||closed||Yes|
|title.angle||Angle, in degrees, at which the plot title is drawn||-360.0 to 360.0||0.0||Yes|
|title.color||Color of the plot title text string||name or hex; see the Color section of "ahelp chipsopt"||default||Yes|
|title.depth||Integer value indicating the depth of the plot title||see the Depth section of "ahelp chipsopt"||default||Yes|
|title.font||Plot title font||helvetica|courier|times|greek; see the Font section of "ahelp chipsopt"||helvetica||Yes|
|title.fontstyle||Specific attributes of the text string independent of size or font||normal|bold|italic|bolditalic; see the Font Style section of "ahelp chipsopt"||normal||Yes|
|title.halign||Horizontal location of the string reference point of the plot title||auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt"||center||Yes|
|title.size||Font size of the plot title||1 to 100||16||Yes|
|title.valign||Vertical location of the string reference point of the plot title||auto|base|center|left|right|top; see the Text Alignment section of "ahelp chipsopt"||auto||Yes|
|title.xpos||X position, in Plot Normalized coordinates, of the reference point of the plot title||Real values ranging from zero through one||0.5||Yes|
|title.ypos||Y position, in Plot Normalized coordinates, of the reference point of the plot title||Real values.||1.05||Yes|
|topmargin||The distance, in Frame Normalized coordinates, between the upper plot border and the upper border of the frame containing the plot||Real values ranging from zero through one||0.10||Yes|
|aspect.ratio||The default aspect ratio of the plot, where "" means no aspect ratio is set.||See "ahelp aspectratio" for the meaning and syntax of this value.||Yes|
See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.
- add_plot, adjust_grid_gaps, adjust_grid_xrelsize, adjust_grid_xrelsizes, adjust_grid_yrelsize, adjust_grid_yrelsizes, clear_plot, current_plot, delete_plot, display_plot, get_plot, grid_objects, hide_plot, move_plot, reposition_plot, set_data_aspect_ratio, set_plot_aspect_ratio, split, strip_chart, swap_object_positions