Graph¶

class Graph(*args)¶

Class Graph containing drawable elements and a graphical context.

Available constructors:

Graph(title=’’)

Graph(title, xTitle, yTitle, showAxes, legendPosition=’’, legendFontSize=1.0, logScale=ot.GraphImplementation.NONE)

Parameters:

titlestr

Title of the graph.

xTitlestr

Legend of the X axe.

yTitlestr

Legend of the Y axe.

showAxesbool

True to draw the axes. False to hide them.

legendPositionstr

Indication of the legend’s position. If legendPosition is not specified, the Graph has no legend. The valid strings are given by the GetValidLegendPositions() method.

legendFontSizefloat

Font size of the legend.

logScaleint

logScale indicates whether the logarithmic scale is used either for one or both axes:

ot.GraphImplementation.NONE or 0: no log scale is used,
ot.GraphImplementation.LOGX or 1: log scale is used only for horizontal data,
ot.GraphImplementation.LOGY or 2: log scale is used only for vertical data,
ot.GraphImplementation.LOGXY or 3: log scale is used for both data.

Methods

`GetValidLegendPositions`()	Accessor to the list of valid legend positions.
`IsValidLegendPosition`(position)	Test if the proposed legend position is valid or not.
`add`(*args)	Add drawable instances to the collection of drawables contained in Graph.
`erase`(i)	Erase a drawable instance from the collection of drawables contained in Graph.
`getAutomaticBoundingBox`()	Accessor to the indication of automatic bounding box.
`getAxes`()	Accessor to the indication of axes' presence on the Graph.
`getBoundingBox`()	Accessor to the bounding box of the whole plot.
`getClassName`()	Accessor to the object's name.
`getColors`()	Accessor to the colors of the Drawables included in the Graph.
`getDrawable`(index)	Accessor to a Drawable included in the Graph.
`getDrawables`()	Accessor to the Drawables included in the Graph.
`getGrid`()	Accessor to the indication of grid's presence on the Graph.
`getGridColor`()	Accessor to the indication of grid's color on the Graph.
`getId`()	Accessor to the object's id.
`getImplementation`()	Accessor to the underlying implementation.
`getIntegerXTick`()	Accessor to the integer x-axis ticks flag.
`getIntegerYTick`()	Accessor to the integer y-axis ticks flag.
`getLegendCorner`()	Accessor to the legend's corner.
`getLegendFontSize`()	Accessor to the legends' font size of the Drawables inside the Graph.
`getLegendPosition`()	Accessor to the legend's position of the Drawables inside the Graph.
`getLegends`()	Accessor to the legends of the Drawables inside the Graph.
`getLogScale`()	Accessor to the indication of axes' scale of the Graph.
`getName`()	Accessor to the object's name.
`getTickLocation`()	Accessor to the ticks location flag.
`getTitle`()	Accessor to the title of the Graph.
`getXTitle`()	Accessor to the title of the X axe.
`getYTitle`()	Accessor to the title of the Y axe.
`setAutomaticBoundingBox`(automaticBoundingBox)	Accessor to the indication of automatic bounding box.
`setAxes`(showAxes)	Accessor to the indication of axes' presence on the Graph.
`setBoundingBox`(boundingBox)	Accessor to the bounding box of the whole plot.
`setColors`(colors)	Update the colors of the Drawables inside the Graph.
`setDefaultColors`()	Assign colors to a default palette to all the drawables of the Graph.
`setDrawable`(drawable, index)	Accessor to a Drawable included in the Graph.
`setDrawables`(drawableCollection)	Accessor to the Drawables included in the Graph.
`setGrid`(showGrid)	Hide or shows grid of the Graph.
`setGridColor`(color)	Accessor to the indication of grid's color on the Graph.
`setIntegerXTick`(integerXTick)	Accessor to the integer x-axis ticks flag.
`setIntegerYTick`(integerYTick)	Accessor to the integer y-axis ticks flag.
`setLegendCorner`(corner)	Accessor to the legend's corner.
`setLegendFontSize`(legendFontSize)	Accessor to the legend's font size of the Drawables inside the Graph.
`setLegendPosition`(position)	Accessor to the legend's position of the Drawables inside the Graph.
`setLegends`(legends)	Accessor to the legends of the Drawables inside the Graph.
`setLogScale`(logScale)	Accessor to the indication of axes' scale of the Graph.
`setName`(name)	Accessor to the object's name.
`setTickLocation`(tickLocation)	Accessor to the ticks location flag.
`setTitle`(title)	Accessor to the title of the Graph.
`setXMargin`(xMargin)	Accessor to the horizontal margin size.
`setXTitle`(title)	Accessor to the title of the X axe.
`setYMargin`(yMargin)	Accessor to the vertical margin size.
`setYTitle`(title)	Accessor to the title of the Y axe.

__init__(*args)¶

static GetValidLegendPositions()¶

Accessor to the list of valid legend positions.

Returns:

listPositionsDescription: All the valid legend positions.

Examples

>>> import openturns as ot
>>> print(ot.Graph.GetValidLegendPositions())
[,best,upper right,upper left,lower right,lower left,center right,...

static IsValidLegendPosition(position)¶

Test if the proposed legend position is valid or not.

Parameters:

positionstr: Proposed legend position of the Drawables inside the Graph.

Returns:

validitybool: True if the proposed legend position is valid, False if it is not.

See also

setLegendPosition, GetValidLegendPositions

getLegends()¶

Accessor to the legends of the Drawables inside the Graph.

Returns:

legendsDescription: Legends used for the drawables contained inside the Graph.

getLogScale()¶

Accessor to the indication of axes’ scale of the Graph.

Returns:

scaleint

Indicates the type of the axes’s scale:

0: no log scale is used,
1: log scale is used only for horizontal data,
2: log scale is used only for vertical data,
3: log scale is used for both data.

getName()¶

Accessor to the object’s name.

Returns:

namestr: The name of the object.

getTickLocation()¶

Accessor to the ticks location flag.

Returns:

locint: Indicates the ticks location.

getTitle()¶

Accessor to the title of the Graph.

Returns:

titlestr: Title of the Graph.

getXTitle()¶

Accessor to the title of the X axe.

Returns:

Xtitlestr: Title of the X axe.

getYTitle()¶

Accessor to the title of the Y axe.

Returns:

Ytitlestr: Title of the Y axe.

setAutomaticBoundingBox(automaticBoundingBox)¶

Accessor to the indication of automatic bounding box.

Parameters:

autoBoundingBoxbool: Indicates if the bounding box is automatically created or not. The bounding box of the drawable element is a rectangle determined by its range along X and its range along Y.

setAxes(showAxes)¶

Accessor to the indication of axes’ presence on the Graph.

Parameters:

axesbool: True to draw the axes, False to hide the axes.

setBoundingBox(boundingBox)¶

Accessor to the bounding box of the whole plot.

Parameters:

boundingBoxInterval of dimension 2: Bounding box of the drawable element, which is a rectangle determined by its range along X and its range along Y.

setColors(colors)¶

Update the colors of the Drawables inside the Graph.

Parameters:

listColorssequence of str

List of the colors used for each Drawable of the Graph. If the listColors’s size is lower than the number of Drawables, the first colors of listColors are re-used. If it is greated than the number of Drawables, the last colors of the list are ignored.

OpenTURNS

An Open source initiative for the Treatment of Uncertainties, Risks'N Statistics

Graph¶

Examples using the class¶