simple.layout Module¶
- paraview.simple.layout.AssignViewToLayout(view=None, layout=None, hint=0)[source]¶
Assigns the view provided to the layout provided. If no layout exists, then a new layout will be created.
It is an error to assign the same view to multiple layouts.
- Parameters
view (View proxy.) – The view to assign to the layout. Optional, defaults to the active view.
layout (Layout proxy.) – If layout is None, then either the active layout or an existing layout on the same server will be used.
- Returns
Returns True on success.
- Return type
bool
- paraview.simple.layout.CreateLayout(name=None)[source]¶
Create a new layout with no active view.
- Parameters
name – The name of the layout. Optional, defaults to an automatically created name.
- paraview.simple.layout.EqualizeViewsBoth(layout=None)[source]¶
Equalizes the vertical and horizontal view sizes in the provided layout.
- Parameters
layout (Layout proxy.) – Layout the layout contain the views to equalize. Optional, defaults to the active layout.
- paraview.simple.layout.EqualizeViewsHorizontally(layout=None)[source]¶
Equalizes horizontal view sizes in the provided layout.
- Parameters
layout (Layout proxy.) – Layout the layout contain the views to equalize. Optional, defaults to the active layout.
- paraview.simple.layout.EqualizeViewsVertically(layout=None)[source]¶
Equalizes vertical view sizes in the provided layout.
- Parameters
layout (Layout proxy.) – Layout the layout contain the views to equalize. Optional, defaults to the active layout.
- paraview.simple.layout.GetLayout(view=None)[source]¶
Return the layout containing the given view, if any.
- Parameters
view – A view in the layout to be removed. Optional, defaults to the active view.
- Returns
The layout containing the view
- Return type
paraview.servermanager.ViewLayout
- paraview.simple.layout.GetLayoutByName(name)[source]¶
Return the first layout with the given name, if any.
- Parameters
name (str) – Name of the layout
- Returns
The named layout if it exists
- Return type
Layout proxy or None
- paraview.simple.layout.GetLayouts()[source]¶
Returns all the layout proxies.
- Returns
A list of all the layouts.
- Return type
list of layout proxies
- paraview.simple.layout.GetViewsInLayout(layout=None)[source]¶
Returns a list of views in the given layout.
- Parameters
layout (Layout proxy.) – Layout whose views should be returned. Optional, defaults to the layout for the active view, if possible.
- Returns
List of views in the layout.
- Return type
list
- paraview.simple.layout.RemoveLayout(proxy=None)[source]¶
Remove the provided layout. If none is provided, remove the layout containing the active view. If it is the only layout it will create a new one with the same name as the removed one.
- Parameters
proxy (Layout proxy or None.) – The layout proxy to remove. Optional, defaults to the layout containing the active view.
- paraview.simple.layout.RenameLayout(newName, proxy=None)[source]¶
Renames the given layout. If the given proxy is not registered in the ‘layouts’ group this method will have no effect.
- Parameters
newName (str) – The new name of the layout proxy
layout – The layout proxy to rename. It must be a member of the ‘layouts’ groupd. Optional, defaults to renaming the active layout.