This is the interface defining how clients can communicate with an instance of XGobi.
attribute string fileName;
The current file loaded in XGobi. This might be generalized to the identify whether the data was loaded directly from a client's data in the form of a Matrix or Data frame. Methods to set and get this value are available. The latter loads a new file.
long addVariable(in Sequences::DoubleSequence values,
in string name);
Add a single variable to the current data being displayed by the server
long addVariables(in Omegahat::BaseMatrix data,
in Sequences::StringSequence names);
Add a collection of variables to the list of variables currently being displayed. The names are given in the second argument. This works much like the setData method, but augments the existing data if the variables have the same length. Otherwise, an exception is thrown. It should be specified here.
void connectObservations(in Omegahat::Matrix pairs);
Connect each pair of observations with a line segment that are identified row-wise in the specified matrix.
void disconnectAllObservations();
Clear all connections between observations.
void disconnectObservations(in Omegahat::Matrix pairs);
Remove the connection between the pairs of points identifed in the matrix.
Sequences::DoubleSequence getCoefficients();
This returns the coefficients as they are displayed in the variable dials in the variable panel of the XGobi display.
Sequences::StringSequence getColorNames();
Retrieve the list of available colors understood by the XGobi server. This allows the client to ensure that commands to set a color will be understood since the selection can be made from this list.
Omegahat::BaseMatrix getConnectedObservations();
Get current collection of connections.
Sequences::DoubleSequence getCurrentValues();
List of all values on the dial
double getCurrentVariableValue(in string name);
This is the value on the dial.
Omegahat::BaseMatrix getData();
A client can ask for the current data being used by the server. It is returned as a Matrix. The are no names with matrix. This is currently a separate call. (Synchronization issues are a problem.) We will add methods to return a Data Frame which will contain the names of the variables, etc.
Omegahat::BaseMatrix getRotation();
Get the rotation matrix for the current view. This can be used in the client to extract useful information either for plotting or for transforming variables locally according to this view, etc.
Sequences::StringSequence getRowColors();
Get the names of the colors currently being used to display each point. This is useful for being able to reproduce the plot in a client application.
Sequences::StringSequence getRowNames();
Get the names of the observations in the currently displayed data.
Sequences::LongSequence getSelectedIndices();
Retrieve a list of indeces identifying which observations are currently selected.
Sequences::StringSequence getSelectedVariables();
Retrieve the names of the currently selected variables.
Sequences::StringSequence getSymbolNames();
Return the name of the glyphs understood by the XGobi server.
Omegahat::DataVector getVariable(in string name);
This retrieves the data associated with a given variable.
Sequences::StringSequence getVariableNames();
Get the names of the variables currently being displayed.
string getView()
raises(InsufficientInformationException);
Retrieve the name of the current view type.
Sequences::StringSequence getViewTypes();
Obtain a list of the names of all the possible views understood by the XGobi server.
boolean isSelected(in string name);
Determine whether the specified variable is currently selected.
XGobi replicate(in boolean linked,
in string name);
clone the XGobi window, creating a new one. linked: true or false indicating whether the new instance of the server should be linked to the other. name: the name to use by which it is registered with the CORBA naming. Also, this can be used in the titlebar of the new window.
void setData(in Omegahat::BaseMatrix data,
in Sequences::StringSequence names);
Load data from a Matrix object. The variables are taken to be the columns of the matrix and their names are provided in the second argument.
boolean setObservationColor(in string color,
in long row);
Set the display color of an individual observation. The observation is identified by index.
boolean setObservationSymbol(in string symbolName,
in long row);
Set the display symbol or glyph of an individual observation.
boolean setObservationSymbolSize(in long size,
in long row);
Set the display symbol size of an individual observation.
void setRotation(in Omegahat::BaseMatrix rotation);
Specify the rotation to use in the current view. This allows the client to control the current view.
void setRowName(in long which,
in string name);
Set an individual observation name.
void setRowNames(in Sequences::StringSequence names);
Set the names of the observations in the currently displayed data.
boolean setSelected(in string name,
in boolean select);
This turns on or off the selection for the specified variable.
void setSelectedIndices(in Sequences::LongSequence rows);
Set the observations identified by index in the argument sequence to be selected.
void setVariableName(in long which,
in string name);
boolean setView(in string name);
Sethe view to the specfied type (e.g. xyplot, grand tour, etc.)
long setX(in string name,
in boolean append);
Specify the variable identified by the first argument to be considered as a predictor or X variable. The second argument indicate whether this should clear existing values first (false) or simply add this variable to the existing list of predictors.
long setY(in string name,
in boolean append);
Similar to setX(), this specifies the appropriate variable as a response.
Generated by the ORBacus IDL-to-HTML translator (non-commercial)