SALOME documentation central

VISU.XYPlot Interface Reference

Interface of the 2D plot view. More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.XYPlot:
Inheritance graph

Public Types

enum  CurveType { POINTS, MULTYLINE, SPLINE }
enum  ViewRepresentation { OBJECTBROWSER, VIEWER, PYTHON, MESSAGES }
 

ViewRepresentation enumeration

More...
enum  ViewPosition {
  TOP, CENTER, BOTTOM, RIGHT,
  LEFT
}

Public Member Functions

void SetSubTitle (in string theTitle)
string GetSubTitle ()
void SetCurveType (in CurveType theType)
CurveType GetCurveType ()
void SetMarkerSize (in long theSize)
long GetMarkerSize ()
void EnableXGrid (in boolean theMajor, in long theNumMajor, in boolean theMinor, in long theNumMinor)
void EnableYGrid (in boolean theMajor, in long theNumMajor, in boolean theMinor, in long theNumMinor)
void SetHorScaling (in Scaling theScaling)
Scaling GetHorScaling ()
void SetVerScaling (in Scaling theScaling)
Scaling GetVerScaling ()
void SetXTitle (in string theTitle)
string GetXTitle ()
void SetYTitle (in string theTitle)
string GetYTitle ()
void ShowLegend (in boolean theShowing)
void FitAll ()
void FitXRange (in double xMin, in double xMax)
void FitYRange (in double yMin, in double yMax)
void FitRange (in double xMin, in double xMax, in double yMin, in double yMax)
void GetFitRanges (out double xMin, out double xMax, out double yMin, out double yMax)
void ShowPart (in ViewRepresentation ViewRepr, in boolean state)
boolean IsPartShown (in ViewRepresentation ViewRepr)
void SplitRight ()
 Split workarea of this view.
void SplitLeft ()
 Split workarea of this view.
void SplitBottom ()
 Split workarea of this view.
void SplitTop ()
 Split workarea of this view.
void OnTop ()
void Attract (in View theView)
void AttractAll (in View theView)
void SetRelativePositionInSplitter (in double thePosition)
void SetRelativeSizeInSplitter (in double theSize)
void SetRelativePositionX (in double thePosition)
void SetRelativePositionY (in double thePosition)
void SetRelativeSizeX (in double theSize)
void SetRelativeSizeY (in double theSize)
void SetViewWidth (in long Width)
void SetViewHeight (in long Height)
long GetViewWidth ()
long GetViewHeight ()
void SetViewPositionHorizontal (in ViewPosition ViewPosHor)
void SetViewPositionVertical (in ViewPosition ViewPosVer)
void SetRelativePosition (in double x, in double y)
void SetRelativeSize (in double x, in double y)
void Minimize ()
void Restore ()
void Maximize ()
void SetTitle (in string theTitle)
string GetTitle ()
void SetBackground (in SALOMEDS::Color theColor)
SALOMEDS::Color GetBackground ()
void EraseAll ()
void DisplayAll ()
void Erase (in PrsObject thePrsObj)
void Display (in PrsObject thePrsObj)
void DisplayOnly (in PrsObject thePrsObj)
void Update ()
boolean SavePicture (in string theFileName)
IdType GetID ()
VISUType GetType ()

Detailed Description

This interface is used for creation of a view necessary for presentation of a XY plot generated on the basis of one or several curve lines.


Member Enumeration Documentation

This enumeration contains a set of elements determining the type of the curve lines, which will be displayed in your XY plot.

Enumerator:
POINTS 
MULTYLINE 
SPLINE 

displaying part ("ALL" isn't setable)

Enumerator:
OBJECTBROWSER 
VIEWER 
PYTHON 
MESSAGES 
enum VISU::View::ViewPosition [inherited]
Enumerator:
TOP 
CENTER 
BOTTOM 
RIGHT 
LEFT 

Member Function Documentation

void VISU.XYPlot.SetSubTitle ( in string  theTitle  ) 

Sets the title of the XY plot

Parameters:
theTitle The title of the XY plot
string VISU.XYPlot.GetSubTitle (  ) 

Gets the title of the XY plot

void VISU.XYPlot.SetCurveType ( in CurveType  theType  ) 

Sets the type of the curve lines.

Parameters:
theType The type of the curve lines taken from CurveType enumeration.
CurveType VISU.XYPlot.GetCurveType (  ) 

Gets the type of the curve lines.

void VISU.XYPlot.SetMarkerSize ( in long  theSize  ) 

Sets the size of the markers (data points) with help of which the curve is constructed on the graphics.

Parameters:
theSize Long value defining the size of the markers.
long VISU.XYPlot.GetMarkerSize (  ) 

Gets the size of the markers (data points) with help of which the curve is constructed on the graphics.

void VISU.XYPlot.EnableXGrid ( in boolean  theMajor,
in long  theNumMajor,
in boolean  theMinor,
in long  theNumMinor 
)

Enable/disables X-axis grid of the 2D plot.

void VISU.XYPlot.EnableYGrid ( in boolean  theMajor,
in long  theNumMajor,
in boolean  theMinor,
in long  theNumMinor 
)

Enable/disables Y-axis grid of the 2D plot.

void VISU.XYPlot.SetHorScaling ( in Scaling  theScaling  ) 

Sets horizontal scaling of the 2D plot.

Parameters:
theScaling Type of scaling taken from Scaling enumeration.
Scaling VISU.XYPlot.GetHorScaling (  ) 

Gets the type horizontal scaling of the 2D plot.

void VISU.XYPlot.SetVerScaling ( in Scaling  theScaling  ) 

Sets vertical scaling of the 2D plot.

Parameters:
theScaling Type of scaling taken from Scaling enumeration.
Scaling VISU.XYPlot.GetVerScaling (  ) 

Gets the type vertical scaling of the 2D plot.

void VISU.XYPlot.SetXTitle ( in string  theTitle  ) 

Sets the title of the X-axis of the plot.

Parameters:
theTitle String value defining the title of the X-axis of the plot.
string VISU.XYPlot.GetXTitle (  ) 

Gets the title of the X-axis of the plot.

void VISU.XYPlot.SetYTitle ( in string  theTitle  ) 

Sets the title of the Y-axis of the plot.

Parameters:
theTitle String value defining the title of the X-axis of the plot.
string VISU.XYPlot.GetYTitle (  ) 

Gets the title of the Y-axis of the plot.

void VISU.XYPlot.ShowLegend ( in boolean  theShowing  ) 

Shows/hides the legend (description) of the 2D plot.

void VISU.XYPlot.FitAll (  ) 

Shrinks and enlarges the 2D plot to fit the 2D viewer.

void VISU.XYPlot.FitXRange ( in double  xMin,
in double  xMax 
)

Set range of the 2D plot to X axis of the 2D viewer.

void VISU.XYPlot.FitYRange ( in double  yMin,
in double  yMax 
)

Set range of the 2D plot to Y axis of the 2D viewer.

void VISU.XYPlot.FitRange ( in double  xMin,
in double  xMax,
in double  yMin,
in double  yMax 
)

Set range of the 2D plot to XY axis of the 2D viewer.

void VISU.XYPlot.GetFitRanges ( out double  xMin,
out double  xMax,
out double  yMin,
out double  yMax 
)
void VISU.View.ShowPart ( in ViewRepresentation  ViewRepr,
in boolean  state 
) [inherited]
boolean VISU.View.IsPartShown ( in ViewRepresentation  ViewRepr  )  [inherited]
void VISU.View.SplitRight (  )  [inherited]

New methods for view parameters management.

Horizontally split workarea of this view. This view is moved in a new right area.

void VISU.View.SplitLeft (  )  [inherited]

Horizontally split workarea of this view. This view stays in an old left area, others are moved in a new right area.

void VISU.View.SplitBottom (  )  [inherited]

Vertically split workarea of this view. This view is moved in a new bottom area.

void VISU.View.SplitTop (  )  [inherited]

Vertically split workarea of this view. This view stays in an old top area, others are moved in a new bottom area.

void VISU.View.OnTop (  )  [inherited]

Put this view window on top of its work area.

void VISU.View.Attract ( in View  theView  )  [inherited]

Put theView in workarea of this view right after it. If theView was alone in its workarea, workarea of theView will be destroyed. If theView was in the same workarea with this view, simple reordering will take place.

Parameters:
theView A view window to be attracted to this one.
void VISU.View.AttractAll ( in View  theView  )  [inherited]

Put all the view windows from workarea of theView in workarea of this view right after it. Workarea of theView will be destroyed. If theView was in the same workarea with this view, simple reordering will take place.

Parameters:
theView A view window to be attracted to this one together with all its workarea.
void VISU.View.SetRelativePositionInSplitter ( in double  thePosition  )  [inherited]

Set position of this view window relatively its splitter.

Parameters:
thePosition Desired position of this view window relatively its splitter. Meaningfull values lays in range [0..1].

Direction of positioning is defined by the splitter orientation.

void VISU.View.SetRelativeSizeInSplitter ( in double  theSize  )  [inherited]

Set size of this view window relatively its splitter.

Parameters:
theSize Desired size of this view window relatively its splitter. Meaningfull values lays in range [0..1].

Direction of resizing is defined by the splitter orientation.

void VISU.View.SetRelativePositionX ( in double  thePosition  )  [inherited]

Set horizontal position of this view window relatively its workstack.

Parameters:
thePosition Desired horizontal position of this view window relatively its workstack. Meaningfull values lays in range [0..1].
void VISU.View.SetRelativePositionY ( in double  thePosition  )  [inherited]

Set vertical position of this view window relatively its workstack.

Parameters:
thePosition Desired vertical position of this view window relatively its workstack. Meaningfull values lays in range [0..1].
void VISU.View.SetRelativeSizeX ( in double  theSize  )  [inherited]

Set horizontal size of this view window relatively its workstack.

Parameters:
theSize Desired horizontal size of this view window relatively its workstack. Meaningfull values lays in range [0..1].
void VISU.View.SetRelativeSizeY ( in double  theSize  )  [inherited]

Set vertical size of this view window relatively its workstack.

Parameters:
theSize Desired vertical size of this view window relatively its workstack. Meaningfull values lays in range [0..1].
void VISU.View.SetViewWidth ( in long  Width  )  [inherited]

Old methods for view parameters management, they don't work now

void VISU.View.SetViewHeight ( in long  Height  )  [inherited]
long VISU.View.GetViewWidth (  )  [inherited]
long VISU.View.GetViewHeight (  )  [inherited]
void VISU.View.SetViewPositionHorizontal ( in ViewPosition  ViewPosHor  )  [inherited]
void VISU.View.SetViewPositionVertical ( in ViewPosition  ViewPosVer  )  [inherited]
void VISU.View.SetRelativePosition ( in double  x,
in double  y 
) [inherited]
void VISU.View.SetRelativeSize ( in double  x,
in double  y 
) [inherited]
void VISU.View.Minimize (  )  [inherited]
void VISU.View.Restore (  )  [inherited]
void VISU.View.Maximize (  )  [inherited]
void VISU.View.SetTitle ( in string  theTitle  )  [inherited]

Sets the title of the View frame.

Parameters:
theTitle String parameter defining the title of the View frame.
string VISU.View.GetTitle (  )  [inherited]

Gets the title of the View frame.

void VISU.View.SetBackground ( in SALOMEDS::Color  theColor  )  [inherited]

Sets background color of the View frame.

Parameters:
theColor Background color defined in SALOMEDS.Color enumeration.
SALOMEDS::Color VISU.View.GetBackground (  )  [inherited]

Gets background color of the View frame.

void VISU.View.EraseAll (  )  [inherited]

Removes all presentations (presentable objects) from the view.

void VISU.View.DisplayAll (  )  [inherited]

Displays all presentations (presentable objects) in the view.

void VISU.View.Erase ( in PrsObject  thePrsObj  )  [inherited]

Removes a definite presentation (presentable object) from the view.

Parameters:
thePrsObj The presentation (presentable object) which should be deleted.
void VISU.View.Display ( in PrsObject  thePrsObj  )  [inherited]

Displays a definite presentation (presentable object) in the view.

Parameters:
thePrsObj The presentation (presentable object) which should be displayed.
void VISU.View.DisplayOnly ( in PrsObject  thePrsObj  )  [inherited]

Allows to display only a definite presentation (presentable object) in the view. All other presentations are removed from the view.

Parameters:
thePrsObj The presentation (presentable object) which should be displayed.
void VISU.View.Update (  )  [inherited]

Updates the view.

boolean VISU.View.SavePicture ( in string  theFileName  )  [inherited]

Saves the view.

Parameters:
theFileName The name of the file where the view will be saved.
Returns:
True, if the view have been saved successfully.
IdType VISU.Base.GetID (  )  [inherited]

Returns ID of the object.

VISUType VISU.Base.GetType (  )  [inherited]

Returns the type of the presentable object

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator

Copyright © 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS