Concepts: ChipsId

The ChipsId structure is used to specify the currency state and coordinate system. It allows the user to set or modify the currency of ChIPS by specifying the ids of the windows, frames, plots, axes, curves, contours, histograms, labels, lines, points, and regions that the operation should affect. It also contains entries to specify coordinate systems and coordinate system ids. The ChipsId is optional and is generally the first parameter in the command.

A complete list of ChipsId members is available below. They are set as:

# Python
   id = ChipsId()
   id.window = "all"
   id.curve = "crv1"
   id.coord_sys = PLOT_NORM
      

% S-Lang
   id = ChipsId;
   id.window = "all";
   id.curve = "crv1";
   id.coord_sys = PLOT_NORM;
      

When a ChipsId object is passed to a command, only the information relevant to the command is utilized. For instance, the window and frame ids may be used when changing the color of a frame background, but the curve id setting is ignored. Blank entries in the ChipsId resolve to the default determined by currency rules.

• Retrieving Object Ids
• Specifying Coordinate Systems
• Members of the ChipsId Object
• Object Methods

Retrieving Object Ids

The ChipsId object also provides a means of retrieving the ids of objects created by add_<object> commands. If an add_curve call is made when no windows exist, a window, frame, plot, axes, and curve objects are all created. The appropriate entries in the input ChipsId object are populated with the object ids.

The id information may be accessed by printing the ChipsId or via the id accessor methods, e.g. id.get_window_id(). The ids are only set when a new instance of the object is added. If a curve is added to an existing plot, only the curve id will be updated in the ChipsId object.

Specifying Coordinate Systems

The coord_sys entry in the ChipsId is used to specify the coordinate system to use when adding objects. For instance, to add a label in plot normalized coordinates, set the coord_sys entry to PLOT_NORM and include the ChipsId object in the add_label call:

# Python
   id = ChipsId()
   id.coord_sys = PLOT_NORM
   add_label(id, .5, .5, "mid")
      

% S-Lang
   id = ChipsId;
   id.coord_sys = PLOT_NORM;
   add_label(id, .5, .5, "mid");
      

Members of the ChipsId Object

Object Methods